lib/RELEASE-NOTES

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