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 !!!The following pref variables were added in 2.3:
  24
  25
  26 !!!The following pref variables were changed in 2.3:
  27
  28 * \document_path
  29   Default is changed to ".". The best guess for where the user wants to save
  30   or find files is the directory the user started LyX from. Before, the
  31   default was always the home directory. If desired, the old behavior can be
  32   restored by changing the default path in Preferences > "Working directory".
  33
  34
  35 !!!The following pref variables are obsoleted in 2.3:
  36
  37
  38 !!!The following new LyX functions have been introduced in 2.3:
  39
  40 * branch-invert
  41   Toggles inversion status of branch inset.
  42
  43 * lyx-activate
  44   Activates the LyX window. Useful in combination with reverse search.
  45
  46
  47 !!!The following LyX functions have been changed in 2.3:
  48
  49 * quote-insert
  50   The function now has a second and third optional argument to specify
  51   the side (left, right, auto) and quotation mark style (english, swedish,
  52   german, polish, french, danish).
  53
  54 * inset-modify
  55   This function now also applies to quote insets. It takes a three-character
  56   string as an argument, refering (1.) to the style (e = ``english'',
  57   s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
  58   (2.) to the side (l = left, r = right) and (3.) to the quotation level
  59   (s = single, d = double). So "eld" means "English left double quotation mark".
  60   A dot in the string means: take the current value. So "inset-modify changetype e.."
  61   will only change the style to English, while letting side and level as is,
  62   "inset-modify changetype f.s" will change the style to French and the level to
  63   single, leaving the side value.
  64
  65   This function is most useful when combined with inset-forall. E.g.,
  66   "inset-forall Quotes inset-modify changetype f.."
  67    => change all quote insets to French style, maintaining current side and level
  68   "inset-forall Quotes inset-modify changetype ..s"
  69    => change all quote insets to single quotes, keeping style and level
  70   "inset-forall Quotes inset-modify changetype g.s"
  71    => change all quote insets to German single quotes, keeping left/right setting
  72
  73
  74 !!!The following LyX documents have been moved in 2.3:
  75
  76
  77 !!!The following new folders have been added to the LyX directory
  78
  79 * citeengines: Contains the *.citeengine files that determine the citation
  80   formatting and features.
  81
  82 * xtemplates: Contains the *.xtemplate files that define the external templates
  83   (previously in the external_templates file).
  84
  85
  86 !!!The following preferences files have been removed from the tarball in 2.3:
  87
  88 * external_templates. This files has been split into multiple *.xtemplate
  89   files that are now shipped as content of the xtemplates directory.
  90
  91
  92 !!!The following metadata files have been added to the tarball in 2.3:
  93
  94
  95 !!Changes with respect to external programs and libraries in 2.3:
  96
  97 * Inkscape SVG with separate LaTeX + PDF output is experimentally supported.
  98
  99 * Add some editor/viewer applications to (re)configure checks.
 100
 101
 102 !!Known issues in version 2.3.0
 103
 104
 105 !!Caveats when upgrading from earlier versions to 2.3.x
 106
 107 * The external_templates file has been split into one file per template,
 108   which are now located in lib/xtemplates/*.xtemplate. This makes it easier
 109   to add new templates or modify existing ones. If you have modified
 110   the external_templates file, you will have to move the modifications to
 111   the respective *.xtemplate file manually.
 112
 113 * If using TeX fonts and en- and em-dashes are output as font ligatures,
 114   when exporting documents containing en- and em-dashes to the format of
 115   LyX 2.0 or earlier, the following line has to be manually added to the
 116   unicodesymbols file of that LyX version:<br>
 117   0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE<br>
 118   This avoids "uncodable character" issues if the document is actually
 119   loaded by that LyX version. LyX 2.1 and later versions already have the
 120   necessary definition in their unicodesymbols file.