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 * \use_converter_needauth
  63   when enabled, user is asked before calling any (possibly dangerous)
  64   external converter with the 'needauth' option
  65
  66 * \use_converter_needauth_forbidden
  67   when enabled, use of external converters with the 'needauth' option is
  68   forbidden
  69
  70 * \pygmentize_command
  71   holds the name of the driver command used by the Pygments python module.
  72
  73
  74 !!!The following pref variables were changed in 2.3:
  75
  76
  77 !!!The following pref variables are obsoleted in 2.3:
  78
  79
  80 !!!The following new LyX functions have been introduced in 2.3:
  81
  82 * branch-invert
  83   Toggles inversion status of branch inset.
  84
  85 * lyx-activate
  86   Activates the LyX window. Useful in combination with reverse search.
  87
  88 * devel-mode-toggle
  89   Activate/deactivate the developer mode, which consists mainly in:
  90   (1) more information shown in the status bar and (2) help file
  91   opened in editable mode. This state used to be hardcoded at compile
  92   time.
  93
  94
  95 !!!The following LyX functions have been changed in 2.3:
  96
  97 * quote-insert
  98   The function now has a second and third optional argument to specify
  99   the side (left, right, auto) and quotation mark style (english, swedish,
 100   german, polish, french, danish).
 101
 102 * inset-modify
 103   This function now also applies to quote insets. It takes a three-character
 104   string as an argument, referring (1.) to the style (e = ``english'',
 105   s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
 106   (2.) to the side (l = left, r = right) and (3.) to the quotation level
 107   (s = single, d = double). So "eld" means "English left double quotation mark".
 108   A dot in the string means: take the current value. So "inset-modify changetype e.."
 109   will only change the style to English, while letting side and level as is,
 110   "inset-modify changetype f.s" will change the style to French and the level to
 111   single, leaving the side value.
 112
 113   This function is most useful when combined with inset-forall. E.g.,
 114   "inset-forall Quotes inset-modify changetype f.."
 115    => change all quote insets to French style, maintaining current side and level
 116   "inset-forall Quotes inset-modify changetype ..s"
 117    => change all quote insets to single quotes, keeping style and level
 118   "inset-forall Quotes inset-modify changetype g.s"
 119    => change all quote insets to German single quotes, keeping left/right setting
 120
 121 * word-delete-forward, word-delete-backward, char-delete-forward,
 122   char-delete-backward
 123   The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with
 124   the "force" option appended. The new default behavior (without "force") is
 125   to select big insets on the first call and delete them only on the second.
 126   This new behavior is consistent with how delete works in LyX's math editor.
 127
 128 !!!The following LyX documents have been moved in 2.3:
 129
 130
 131 !!!The following new folders have been added to the LyX directory
 132
 133 * citeengines: Contains the *.citeengine files that determine the citation
 134   formatting and features.
 135
 136 * xtemplates: Contains the *.xtemplate files that define the external templates
 137   (previously in the external_templates file).
 138
 139
 140 !!!The following preferences files have been removed from the tarball in 2.3:
 141
 142 * external_templates. This files has been split into multiple *.xtemplate
 143   files that are now shipped as content of the xtemplates directory.
 144
 145
 146 !!!The following metadata files have been added to the tarball in 2.3:
 147
 148
 149 !!Changes with respect to external programs and libraries in 2.3:
 150
 151 * Inkscape SVG with separate LaTeX + PDF output is experimentally supported.
 152
 153 * Add some editor/viewer applications to (re)configure checks.
 154
 155
 156 !!Known issues in version 2.3.0
 157
 158
 159 !!Caveats when upgrading from earlier versions to 2.3.x
 160
 161 * The external_templates file has been split into one file per template,
 162   which are now located in lib/xtemplates/*.xtemplate. This makes it easier
 163   to add new templates or modify existing ones. If you have modified
 164   the external_templates file, you will have to move the modifications to
 165   the respective *.xtemplate file manually.
 166
 167 * If using TeX fonts and en- and em-dashes are output as font ligatures,
 168   when exporting documents containing en- and em-dashes to the format of
 169   LyX 2.0 or earlier, the following line has to be manually added to the
 170   unicodesymbols file of that LyX version:<br>
 171   0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE<br>
 172   This avoids "uncodable character" issues if the document is actually
 173   loaded by that LyX version. LyX 2.1 and later versions already have the
 174   necessary definition in their unicodesymbols file.
 175
 176 * If trying to compile documents using R scripts and sweave/knitr, LyX
 177   2.3.x would not allow for re-running the R scripts, unless the user:
 178   1) explicitly disables the "Forbid use of needauth converters"
 179   option in the LyX preferences;
 180   2) provides explicit consent to the use of the converter on the first
 181   compilation of the R-enhanced document.
 182
 183 * LyX now gives a warning if a document mixes title and non-title layouts.
 184   In some cases, this warning is harmless, but in other cases the document has
 185   a serious problem even though the LaTeX command does not exit with error. For
 186   example, create a document with a title layout, then a standard layout, and
 187   then an author layout, and you will see in the PDF that the author is not
 188   typeset as an author.