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