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