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 * The converters definition syntax (LYX_HOME/lyxrc*) now supports a
  29   new option, 'needauth', to prevent completely automated execution of
  30   the converter, unless LyX acquired explicit consent by the
  31   user. This is a new security feature, useful for converters that are
  32   capable of executing arbitrary code, such as R scripts (used with
  33   sweave/knitr), embedded within LyX documents. The user needs to
  34   explicitly grant per-document permission on the first need for using
  35   the converter on each document, unless he/she checks the "Don't ask
  36   again for this document" checkbox in the permission dialog. The new
  37   behavior can be fine-tuned from two new options in the preferences
  38   dialog (see their description below). These also allow for disabling
  39   'needauth' converters altogether, if desired (default behavior).
  40
  41 * LyX now supports insertion and automated conversion of Gnuplot scripts,
  42   recognized by their typical extension ".gp" or ".gnuplot". These can
  43   directly be inserted in a LyX document using the "Insert->Graphics..."
  44   dialog, then selecting the Gnuplot script. LyX automatically adds a
  45   proper "set terminal ..." and "set output ..." line to convert the
  46   file to the needed output format (e.g., .eps, .pdf), depending on
  47   whether the document is being previewed on screen or compiled as PDF
  48   or other formats. Terminal options cannot be fine-tuned at the moment,
  49   but that's a capability that may come soon, also according to the
  50   received feedback from users.
  51
  52
  53 !!!The following pref variables were added in 2.3:
  54
  55 * \use_converter_needauth
  56   when enabled, user is asked before calling any (possibly dangerous)
  57   external converter with the 'needauth' option
  58
  59 * \use_converter_needauth_forbidden
  60   when enabled, use of external converters with the 'needauth' option is
  61   forbidden
  62
  63 * \pygmentize_command
  64   holds the name of the driver command used by the Pygments python module.
  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
  71 !!!The following pref variables were changed in 2.3:
  72
  73
  74 !!!The following pref variables are obsoleted in 2.3:
  75
  76
  77 !!!The following new LyX functions have been introduced in 2.3:
  78
  79 * buffer-zoom
  80   Zooms the screen fonts to a given value or resets to the default zoom
  81   when no argument is given.
  82
  83 * branch-invert
  84   Toggles inversion status of branch inset.
  85
  86 * lyx-activate
  87   Activates the LyX window. Useful in combination with reverse search.
  88
  89 * devel-mode-toggle
  90   Activate/deactivate the developer mode, which consists mainly in:
  91   (1) more information shown in the status bar and (2) help file
  92   opened in editable mode. This state used to be hardcoded at compile
  93   time.
  94
  95
  96 !!!The following LyX functions have been changed in 2.3:
  97
  98 * quote-insert
  99   The function now has a second and third optional argument to specify
 100   the side (left, right, auto) and quotation mark style (english, swedish,
 101   german, polish, french, danish).
 102
 103 * inset-modify
 104   This function now also applies to quote insets. It takes a three-character
 105   string as an argument, referring (1.) to the style (e = ``english'',
 106   s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
 107   (2.) to the side (l = left, r = right) and (3.) to the quotation level
 108   (s = single, d = double). So "eld" means "English left double quotation mark".
 109   A dot in the string means: take the current value. So "inset-modify changetype e.."
 110   will only change the style to English, while letting side and level as is,
 111   "inset-modify changetype f.s" will change the style to French and the level to
 112   single, leaving the side value.
 113
 114   This function is most useful when combined with inset-forall. E.g.,
 115   "inset-forall Quotes inset-modify changetype f.."
 116    => change all quote insets to French style, maintaining current side and level
 117   "inset-forall Quotes inset-modify changetype ..s"
 118    => change all quote insets to single quotes, keeping style and level
 119   "inset-forall Quotes inset-modify changetype g.s"
 120    => change all quote insets to German single quotes, keeping left/right setting
 121
 122 * word-delete-forward, word-delete-backward, char-delete-forward,
 123   char-delete-backward
 124   The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with
 125   the "force" option appended. The new default behavior (without "force") is
 126   to select big insets on the first call and delete them only on the second.
 127   This new behavior is consistent with how delete works in LyX's math editor.
 128
 129 !!!The following LyX documents have been moved in 2.3:
 130
 131
 132 !!!The following new folders have been added to the LyX directory
 133
 134 * citeengines: Contains the *.citeengine files that determine the citation
 135   formatting and features.
 136
 137 * xtemplates: Contains the *.xtemplate files that define the external templates
 138   (previously in the external_templates file).
 139
 140
 141 !!!The following preferences files have been removed from the tarball in 2.3:
 142
 143 * external_templates. This files has been split into multiple *.xtemplate
 144   files that are now shipped as content of the xtemplates directory.
 145
 146
 147 !!!The following metadata files have been added to the tarball in 2.3:
 148
 149
 150 !!Changes with respect to external programs and libraries in 2.3:
 151
 152 * Inkscape SVG with separate LaTeX + PDF output is experimentally supported.
 153
 154 * Add some editor/viewer applications to (re)configure checks.
 155
 156
 157 !!Known issues in version 2.3.0
 158
 159
 160 !!Caveats when upgrading from earlier versions to 2.3.x
 161
 162 * The external_templates file has been split into one file per template,
 163   which are now located in lib/xtemplates/*.xtemplate. This makes it easier
 164   to add new templates or modify existing ones. If you have modified
 165   the external_templates file, you will have to move the modifications to
 166   the respective *.xtemplate file manually.
 167
 168 * If using TeX fonts and en- and em-dashes are output as font ligatures,
 169   when exporting documents containing en- and em-dashes to the format of
 170   LyX 2.0 or earlier, the following line has to be manually added to the
 171   unicodesymbols file of that LyX version:<br>
 172   0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE<br>
 173   This avoids "uncodable character" issues if the document is actually
 174   loaded by that LyX version. LyX 2.1 and later versions already have the
 175   necessary definition in their unicodesymbols file.
 176
 177 * If trying to compile documents using R scripts and sweave/knitr, LyX
 178   2.3.x would not allow for re-running the R scripts, unless the user:
 179   1) explicitly disables the "Forbid use of needauth converters"
 180   option in the LyX preferences;
 181   2) provides explicit consent to the use of the converter on the first
 182   compilation of the R-enhanced document.
 183
 184 * LyX now gives a warning if a document mixes title and non-title layouts.
 185   In some cases, this warning is harmless, but in other cases the document has
 186   a serious problem even though the LaTeX command does not exit with error. For
 187   example, create a document with a title layout, then a standard layout, and
 188   then an author layout, and you will see in the PDF that the author is not
 189   typeset as an author.