1 !Important Changes in LyX 2.3.0
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.
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
17 "Document->Settings->Fonts->Output em- and en-dash as ligatures" forces
18 output of en- and em-dashes as -- and --- when exporting to LaTeX.
19 It is is "true" by default but "false" when opening documents edited
21 See chapter 3.9.1.1 "Dashes and line breaks" of the User Guide and
22 "Caveats when upgrading from earlier versions to 2.3.x" below.
24 * The following UI translations were dropped, because the lack of translation
25 maintenance: Russian, Danish, Greek, Serbian, Galician, Catalan, Romanian,
28 !!Documents compilation process and images conversion
30 * It is now possible to enable the -shell-escape option only for specific
31 documents, rather than having to enable it globally in preferences.
32 This is achieved by checking "Allow running external programs" in
33 Document->Settings->Formats. LyX will now check whether -shell-escape
34 has been added to a LaTeX converter and invites the user to remove it
35 in favor of the new mechanism when that LaTeX converter is used.
37 * The converters definition syntax (LYX_HOME/lyxrc*) now supports a
38 new option, 'needauth', to prevent completely automated execution of
39 the converter, unless LyX acquired explicit consent by the
40 user. This is a new security feature, useful for converters that are
41 capable of executing arbitrary code, such as R scripts (used with
42 sweave/knitr), embedded within LyX documents. The user needs to
43 explicitly grant per-document permission on the first need for using
44 the converter on each document, unless he/she checks the "Don't ask
45 again for this document" checkbox in the permission dialog. The new
46 behavior can be fine-tuned from two new options in the preferences
47 dialog (see their description below). These also allow for disabling
48 'needauth' converters altogether, if desired (default behavior).
50 * LyX now supports insertion and automated conversion of Gnuplot scripts,
51 recognized by their typical extension ".gp" or ".gnuplot". These can
52 directly be inserted in a LyX document using the "Insert->Graphics..."
53 dialog, then selecting the Gnuplot script. LyX automatically adds a
54 proper "set terminal ..." and "set output ..." line to convert the
55 file to the needed output format (e.g., .eps, .pdf), depending on
56 whether the document is being previewed on screen or compiled as PDF
57 or other formats. Terminal options cannot be fine-tuned at the moment,
58 but that's a capability that may come soon, also according to the
59 received feedback from users.
62 !!!The following pref variables were added in 2.3:
64 * \default_platex_view_format
65 Determine the default output format for Japanese documents that use the
66 pLaTeX backend [default: "pdf3" == "PDF (dvipdfm)"]
68 * \jbibtex_alternatives
69 Alternative bibliography converters for Japanese.
72 holds the name of the driver command used by the Pygments python module.
74 * \use_converter_needauth
75 when enabled, user is asked before calling any (possibly dangerous)
76 external converter with the 'needauth' option
78 * \use_converter_needauth_forbidden
79 when enabled, use of external converters with the 'needauth' option is
83 !!!The following pref variables were changed in 2.3:
86 New (default) value "auto".
89 This is now independent of the value set via buffer-zoom[-in|-out].
92 !!!The following new LyX functions have been introduced in 2.3:
94 * buffer-external-modification-clear
95 Clear the external modification flag on the current buffer
98 Zooms the screen fonts to a given value or resets to the default zoom
99 when no argument is given.
102 Toggles inversion status of branch inset.
105 Activate/deactivate the developer mode, which consists mainly in:
106 (1) more information shown in the status bar and (2) help file
107 opened in editable mode. This state used to be hardcoded at compile
111 Cross out characters.
113 * icon-size [size in px]
114 Set the icon size in the toolbar
117 Activates the LyX window. Useful in combination with reverse search.
120 Toggles movability of a given toolbar.
123 !!!The following LyX functions have been changed in 2.3:
126 If no or "default" argument is given, the function now exports to the default
129 * buffer-zoom-in, buffer-zoom-out
130 The Zoom value set by these is now relative to the default zoom value set in
134 This function now also applies to quote insets. It takes a three-character
135 string as an argument, referring (1.) to the style (e = ``english'',
136 s = ''swedish'', g = ,,german``, p = ,,polish'', f = <<french>>, a = >>danish<<),
137 (2.) to the side (l = left, r = right) and (3.) to the quotation level
138 (s = single, d = double). So "eld" means "English left double quotation mark".
139 A dot in the string means: take the current value. So "inset-modify changetype e.."
140 will only change the style to English, while letting side and level as is,
141 "inset-modify changetype f.s" will change the style to French and the level to
142 single, leaving the side value.
144 This function is most useful when combined with inset-forall. E.g.,
145 "inset-forall Quotes inset-modify changetype f.."
146 => change all quote insets to French style, maintaining current side and level
147 "inset-forall Quotes inset-modify changetype ..s"
148 => change all quote insets to single quotes, keeping style and level
149 "inset-forall Quotes inset-modify changetype g.s"
150 => change all quote insets to German single quotes, keeping left/right setting
153 The function has now two further optional arguments that determine end positions.
154 If specified, a selection is performed.
157 The function now has a second and third optional argument to specify
158 the side (left, right, auto) and quotation mark style (english, swedish,
159 german, polish, french, danish).
162 New option allowbreak that adds an invisible line break option,
164 * word-delete-forward, word-delete-backward, char-delete-forward,
166 The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with
167 the "force" option appended. The new default behavior (without "force") is
168 to select big insets on the first call and delete them only on the second.
169 This new behavior is consistent with how delete works in LyX's math editor.
172 !!!The following new folders have been added to the LyX directory
174 * citeengines: Contains the *.citeengine files that determine the citation
175 formatting and features.
177 * xtemplates: Contains the *.xtemplate files that define the external templates
178 (previously in the external_templates file).
181 !!!The following preferences files have been removed from the tarball in 2.3:
183 * external_templates. This files has been split into multiple *.xtemplate
184 files that are now shipped as content of the xtemplates directory.
187 !!Changes with respect to external programs and libraries in 2.3:
189 * Inkscape SVG with separate LaTeX + PDF or PS output is supported via External
192 * Add some editor/viewer applications to (re)configure checks.
194 * The included Hunspell has been upgraded to version 1.6.2.
196 * The included libiconv has been upgraded to version 1.15.
198 * LyX now includes a Qt-based fallback-converter for Mac to compensate missing
199 ImageMagick convert utility.
202 !!Known issues in version 2.3.0
204 * See http://www.lyx.org/trac/wiki/BugTrackerHome.
207 !!Caveats when upgrading from earlier versions to 2.3.x
209 * The external_templates file has been split into one file per template,
210 which are now located in lib/xtemplates/*.xtemplate. This makes it easier
211 to add new templates or modify existing ones. If you have modified
212 the external_templates file, you will have to move the modifications to
213 the respective *.xtemplate file manually.
215 * By default, LyX 2.3 forces output of all en and em dashes as -- and ---
216 when exporting to LaTeX. This can lead to incorrect line breaks, wrong
217 characters in typewriter fonts, and problems with some LaTeX packages.
218 Unselect "Document->Settings->Fonts->Output em- and en-dash as ligatures"
219 to keep the LyX 2.2 behaviour and avoid these problems. See chapter 3.9.1.1
220 "Dashes and line breaks" of the User Guide for details.
222 * ZWSP characters (u200b) following literal em- and en-dashes are deleted by
223 lyx2lyx when converting to 2.3 format. If you used them as optional line
224 breaks after dashes, convert them to space insets before opening your
225 document with LyX 2.3 or the optional line breaks will be lost!
227 * If using TeX fonts and en- and em-dashes are output as font ligatures,
228 when exporting documents containing en- and em-dashes to the format of
229 LyX 2.0 or earlier, the following line has to be manually added to the
230 unicodesymbols file of that LyX version:<br>
231 0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE<br>
232 This avoids "uncodable character" issues if the document is actually
233 loaded by that LyX version. LyX 2.1 and later versions already have the
234 necessary definition in their unicodesymbols file.
236 * If trying to compile documents using R scripts and sweave/knitr, LyX
237 2.3.x would not allow for re-running the R scripts, unless the user:
238 1) explicitly disables the "Forbid use of needauth converters"
239 option in the LyX preferences;
240 2) provides explicit consent to the use of the converter on the first
241 compilation of the R-enhanced document.
243 * LyX now gives a warning if a document mixes title and non-title layouts.
244 In some cases, this warning is harmless, but in other cases the document has
245 a serious problem even though the LaTeX command does not exit with error. For
246 example, create a document with a title layout, then a standard layout, and
247 then an author layout, and you will see in the PDF that the author is not
248 typeset as an author.
251 !! If upgrading from a LyX version before 2.2.0
253 * Please additionally see the release notes from the versions in-between:
254 https://wiki.lyx.org/LyX/ReleaseNotes