lib/RELEASE-NOTES

   1 !Important Changes in LyX 2.3.0
   2
   3
   4 !!Interface changes
   5
   6 * LyX now has "inverted" branch insets, which output their contents just in
   7   case a given branch is not "activated". This makes inclusion of alternate
   8   material in different versions easier.
   9
  10 * When inserting a command or symbol in mathed, it is now automatically
  11   wrapped in a real inset (either \text or \ensuremath) assuring the correct
  12   mode, instead of being wrapped only in the output. The wrapping inset can
  13   be safely dissolved, as it will be automatically inserted at export time
  14   if needed, as usual.
  15
  16 * The new setting
  17   "Document->Settings->Fonts->Disallow line breaks after dashes"
  18   turns off the conversion of em- and en-dash characters to --- and --
  19   respectively for LaTeX export. It is is "false" by default.
  20   See chapter 3.9.1.1 "Dashes and Line Breaks" of the User Guide and
  21   "Caveats when upgrading from earlier versions to 2.3.x" below.
  22
  23 * The preference "Tools->Preferences->Look&Feel->Screen Fonts->Use
  24   pixmap cache to speed up font rendering" is not available anymore.
  25   It was of dubious value and led to rendering issues.
  26
  27 * The following UI translations were dropped, because of the lack of translation
  28   maintenance:  Catalan, Danish, Dutch, Galician, Romanian, Serbian.
  29
  30 !!Documents compilation process and images conversion
  31
  32 * It is now possible to enable the -shell-escape option only for specific
  33   documents, rather than having to enable it globally in preferences.
  34   This is achieved by checking "Allow running external programs" in
  35   Document->Settings->Formats. LyX will now check whether -shell-escape
  36   has been added to a LaTeX converter and invites the user to remove it
  37   in favor of the new mechanism when that LaTeX converter is used.
  38
  39 * The converters definition syntax (LYX_HOME/lyxrc*) now supports a
  40   new option, 'needauth', to prevent completely automated execution of
  41   the converter, unless LyX acquired explicit consent by the
  42   user. This is a new security feature, useful for converters that are
  43   capable of executing arbitrary code, such as R scripts (used with
  44   sweave/knitr), embedded within LyX documents. The user needs to
  45   explicitly grant per-document permission on the first need for using
  46   the converter on each document, unless he/she checks the "Don't ask
  47   again for this document" checkbox in the permission dialog. The new
  48   behavior can be fine-tuned from two new options in the preferences
  49   dialog (see their description below). These also allow for disabling
  50   'needauth' converters altogether, if desired (default behavior).
  51
  52 * LyX now supports insertion and automated conversion of Gnuplot scripts,
  53   recognized by their typical extension ".gp" or ".gnuplot". These can
  54   directly be inserted in a LyX document using the "Insert->Graphics..."
  55   dialog, then selecting the Gnuplot script. LyX automatically adds a
  56   proper "set terminal ..." and "set output ..." line to convert the
  57   file to the needed output format (e.g., .eps, .pdf), depending on
  58   whether the document is being previewed on screen or compiled as PDF
  59   or other formats. Terminal options cannot be fine-tuned at the moment,
  60   but that's a capability that may come soon, also according to the
  61   received feedback from users.
  62
  63
  64 !!!The following pref variables were added in 2.3:
  65
  66 * \default_platex_view_format
  67   Determine the default output format for Japanese documents that use the
  68   pLaTeX backend [default: "pdf3" == "PDF (dvipdfm)"]
  69
  70 * \jbibtex_alternatives
  71   Alternative bibliography converters for Japanese.
  72
  73 * \pygmentize_command
  74   holds the name of the driver command used by the Pygments python module.
  75
  76 * \use_converter_needauth
  77   when enabled, user is asked before calling any (possibly dangerous)
  78   external converter with the 'needauth' option
  79
  80 * \use_converter_needauth_forbidden
  81   when enabled, use of external converters with the 'needauth' option is
  82   forbidden
  83
  84
  85 !!!The following pref variables were changed in 2.3:
  86
  87 * \bibtex_command
  88   New (default) value "auto".
  89
  90 * \screen_zoom
  91   This is now independent of the value set via buffer-zoom[-in|-out].
  92
  93 * \use_pixmap_cache
  94   The value of this variable is now ignored.
  95
  96 !!!The following new LyX functions have been introduced in 2.3:
  97
  98 * buffer-external-modification-clear
  99   Clear the external modification flag on the current buffer
 100
 101 * buffer-zoom
 102   Zooms the screen fonts to a given value or resets to the default zoom
 103   when no argument is given.
 104
 105 * branch-invert
 106   Toggles inversion status of branch inset.
 107
 108 * devel-mode-toggle
 109   Activate/deactivate the developer mode, which consists mainly in:
 110   (1) more information shown in the status bar and (2) help file
 111   opened in editable mode. This state used to be hardcoded at compile
 112   time.
 113
 114 * buffer-anonymize (2.3.2)
 115   Replace all text n the document by streams of `a'. This is useful
 116   for sharing private documents in a bug report.
 117
 118 * font-crossout
 119   Cross out characters.
 120
 121 * icon-size [size in px]
 122   Set the icon size in the toolbar
 123
 124 * lyx-activate
 125   Activates the LyX window. Useful in combination with reverse search.
 126
 127 * toolbar-movable
 128   Toggles movability of a given toolbar.
 129
 130
 131 !!!The following LyX functions have been changed in 2.3:
 132
 133 * buffer-export
 134   If no or "default" argument is given, the function now exports to the default
 135   output format.
 136
 137 * buffer-zoom-in, buffer-zoom-out
 138   The Zoom value set by these is now relative to the default zoom value set in
 139   preferences.
 140
 141 * environment-split
 142   The new arguments "before" and "previous" can be used for finer control on
 143   where/how the new environment is created.
 144
 145 * inset-modify
 146   This function now also applies to quote insets. It takes a three-character
 147   string as an argument, referring (1.) to the style (e = ``english'',
 148   s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
 149   (2.) to the side (l = left, r = right) and (3.) to the quotation level
 150   (s = single, d = double). So "eld" means "English left double quotation mark".
 151   A dot in the string means: take the current value. So "inset-modify changetype e.."
 152   will only change the style to English, while letting side and level as is,
 153   "inset-modify changetype f.s" will change the style to French and the level to
 154   single, leaving the side value.
 155
 156   This function is most useful when combined with inset-forall. E.g.,
 157   "inset-forall Quotes inset-modify changetype f.."
 158    => change all quote insets to French style, maintaining current side and level
 159   "inset-forall Quotes inset-modify changetype ..s"
 160    => change all quote insets to single quotes, keeping style and level
 161   "inset-forall Quotes inset-modify changetype g.s"
 162    => change all quote insets to German single quotes, keeping left/right setting
 163
 164 * layout
 165   The new argument "ignorenests" can be used to ignore nesting advice contained
 166   in the layout tag "AutoNests".
 167
 168 * paragraph-break
 169   The new argument "ignoresep" can be used to break without accounting for
 170   separators.
 171
 172 * paragraph-goto
 173   The function has now two further optional arguments that determine end positions.
 174   If specified, a selection is performed.
 175
 176 * quote-insert
 177   The function now has a second and third optional argument to specify
 178   the side (left, right, auto) and quotation mark style (english, swedish,
 179   german, polish, french, danish).
 180
 181 * specialchar-insert
 182   New option allowbreak that adds an invisible line break option,
 183
 184 * word-delete-forward, word-delete-backward, char-delete-forward,
 185   char-delete-backward
 186   The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with
 187   the "force" option appended. The new default behavior (without "force") is
 188   to select big insets on the first call and delete them only on the second.
 189   This new behavior is consistent with how delete works in LyX's math editor.
 190
 191
 192 !!!The following new folders have been added to the LyX directory
 193
 194 * citeengines: Contains the *.citeengine files that determine the citation
 195   formatting and features.
 196
 197 * xtemplates: Contains the *.xtemplate files that define the external templates
 198   (previously in the external_templates file).
 199
 200
 201 !!!The following preferences files have been removed from the tarball in 2.3:
 202
 203 * external_templates. This files has been split into multiple *.xtemplate
 204   files that are now shipped as content of the xtemplates directory.
 205
 206
 207 !!Changes with respect to external programs and libraries in 2.3:
 208
 209 * LyX now supports only macOS 10.9 and higher (due to using Qt 5.9).
 210
 211 * Inkscape SVG with separate LaTeX + PDF or PS output is supported via External
 212   Material.
 213
 214 * Add some editor/viewer applications to (re)configure checks.
 215
 216 * The included Hunspell has been upgraded to version 1.6.2.
 217
 218 * The included libiconv has been upgraded to version 1.15.
 219
 220 * LyX now includes a Qt-based fallback-converter for Mac to compensate missing
 221   ImageMagick convert utility.
 222
 223
 224 !!Known issues in version 2.3.0
 225
 226 * See http://www.lyx.org/trac/wiki/BugTrackerHome .
 227
 228
 229 !!Caveats when upgrading from earlier versions to 2.3.x
 230
 231 * The external_templates file has been split into one file per template,
 232   which are now located in lib/xtemplates/*.xtemplate. This makes it easier
 233   to add new templates or modify existing ones. If you have modified
 234   the external_templates file, you will have to move the modifications to
 235   the respective *.xtemplate file manually.
 236
 237 * By default, LyX 2.3 outputs en- and em-dashes as -- and --- respectively,
 238   so that a line break can occur in the output immediately after the dash.
 239   Sometimes, this results in undesired line breaks or overfull lines due to
 240   suppression of hyphenation in the word preceding the dash.
 241   Select "Document->Settings->Fonts->Disallow line breaks after dashes"
 242   to keep the LyX 2.2 behaviour.
 243   See chapter 3.9.1.1, "Dashes and Line Breaks", of the User Guide
 244   for details.
 245
 246 * If trying to compile documents using R scripts and sweave/knitr, LyX
 247   2.3.x would not allow for re-running the R scripts, unless the user:
 248   1) explicitly disables the "Forbid use of needauth converters"
 249   option in the LyX preferences;
 250   2) provides explicit consent to the use of the converter on the first
 251   compilation of the R-enhanced document.
 252
 253 * LyX now gives a warning if a document mixes title and non-title layouts.
 254   In some cases, this warning is harmless, but in other cases the document has
 255   a serious problem even though the LaTeX command does not exit with error. For
 256   example, create a document with a title layout, then a standard layout, and
 257   then an author layout, and you will see in the PDF that the author is not
 258   typeset as an author.
 259
 260
 261 !! If upgrading from a LyX version before 2.2.0
 262
 263 * Please additionally see the release notes from the versions in-between:
 264   https://wiki.lyx.org/LyX/ReleaseNotes