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
  39 !!!The following pref variables were added in 2.3:
  40
  41 * \use_converter_needauth
  42   when enabled, user is asked before calling any external converter with the
  43   'needauth' option
  44
  45 * \use_converter_needauth_forbidden
  46   when enabled, use of external converters with the 'needauth' option is
  47   forbidden
  48
  49
  50 !!!The following pref variables were changed in 2.3:
  51
  52 * \document_path
  53   Default is changed to ".". The best guess for where the user wants to save
  54   or find files is the directory the user started LyX from. Before, the
  55   default was always the home directory. If desired, the old behavior can be
  56   restored by changing the default path in Preferences > "Working directory".
  57
  58
  59 !!!The following pref variables are obsoleted in 2.3:
  60
  61
  62 !!!The following new LyX functions have been introduced in 2.3:
  63
  64 * branch-invert
  65   Toggles inversion status of branch inset.
  66
  67 * lyx-activate
  68   Activates the LyX window. Useful in combination with reverse search.
  69
  70
  71 !!!The following LyX functions have been changed in 2.3:
  72
  73 * quote-insert
  74   The function now has a second and third optional argument to specify
  75   the side (left, right, auto) and quotation mark style (english, swedish,
  76   german, polish, french, danish).
  77
  78 * inset-modify
  79   This function now also applies to quote insets. It takes a three-character
  80   string as an argument, refering (1.) to the style (e = ``english'',
  81   s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
  82   (2.) to the side (l = left, r = right) and (3.) to the quotation level
  83   (s = single, d = double). So "eld" means "English left double quotation mark".
  84   A dot in the string means: take the current value. So "inset-modify changetype e.."
  85   will only change the style to English, while letting side and level as is,
  86   "inset-modify changetype f.s" will change the style to French and the level to
  87   single, leaving the side value.
  88
  89   This function is most useful when combined with inset-forall. E.g.,
  90   "inset-forall Quotes inset-modify changetype f.."
  91    => change all quote insets to French style, maintaining current side and level
  92   "inset-forall Quotes inset-modify changetype ..s"
  93    => change all quote insets to single quotes, keeping style and level
  94   "inset-forall Quotes inset-modify changetype g.s"
  95    => change all quote insets to German single quotes, keeping left/right setting
  96
  97 * word-delete-forward, word-delete-backward, char-delete-forward,
  98   char-delete-backward
  99   The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with
 100   the "force" option appended. The new default behavior (without "force") is
 101   to select big insets on the first call and delete them only on the second.
 102   This new behavior is consistent with how delete works in LyX's math editor.
 103
 104 !!!The following LyX documents have been moved in 2.3:
 105
 106
 107 !!!The following new folders have been added to the LyX directory
 108
 109 * citeengines: Contains the *.citeengine files that determine the citation
 110   formatting and features.
 111
 112 * xtemplates: Contains the *.xtemplate files that define the external templates
 113   (previously in the external_templates file).
 114
 115
 116 !!!The following preferences files have been removed from the tarball in 2.3:
 117
 118 * external_templates. This files has been split into multiple *.xtemplate
 119   files that are now shipped as content of the xtemplates directory.
 120
 121
 122 !!!The following metadata files have been added to the tarball in 2.3:
 123
 124
 125 !!Changes with respect to external programs and libraries in 2.3:
 126
 127 * Inkscape SVG with separate LaTeX + PDF output is experimentally supported.
 128
 129 * Add some editor/viewer applications to (re)configure checks.
 130
 131
 132 !!Known issues in version 2.3.0
 133
 134
 135 !!Caveats when upgrading from earlier versions to 2.3.x
 136
 137 * The external_templates file has been split into one file per template,
 138   which are now located in lib/xtemplates/*.xtemplate. This makes it easier
 139   to add new templates or modify existing ones. If you have modified
 140   the external_templates file, you will have to move the modifications to
 141   the respective *.xtemplate file manually.
 142
 143 * If using TeX fonts and en- and em-dashes are output as font ligatures,
 144   when exporting documents containing en- and em-dashes to the format of
 145   LyX 2.0 or earlier, the following line has to be manually added to the
 146   unicodesymbols file of that LyX version:<br>
 147   0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE<br>
 148   This avoids "uncodable character" issues if the document is actually
 149   loaded by that LyX version. LyX 2.1 and later versions already have the
 150   necessary definition in their unicodesymbols file.
 151
 152 * If trying to compile documents using R scripts and sweave/knitr, LyX
 153   2.3.x would not allow for re-running the R scripts, unless the user:
 154   1) explicitly disables the "Forbid use of needauth converters"
 155   option in the LyX preferences;
 156   2) provides explicit consent to the use of the converter on the first
 157   compilation of the R-enhanced document.