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