1 This file lists interface changes that might affect users in 2.0.0, some
2 known problems in LyX 2.0.0 and some things you have to take into account
3 when upgrading from earlier versions to a version of the 2.0.x series.
4 Note that fixes are available for some of these, but they have not yet
5 been applied because of incomplete testing.
11 There have been some changes to the LyX command line. There is a new option
12 "--batch" that causes LyX to run the given commands without opening a GUI
13 window. Thus, something like:
14 lyx -batch -x "buffer-print printer default dvips" myfile.lyx
15 will cause LyX to print myfile.lyx to the default printer, using dvips and
16 the default print settings (which, of course, have to have been configured
17 already). At present, not many commands can be used this way, but there will
20 A bash completion script was added to the tarball.
22 We have introduced a new flag to decide whether or not a given "document"
23 format shall be listed in the File > Export menu. This was necessary since
24 this menu got too large. If the flag "menu=export" is not explicitly set,
25 the formats are not included in the menu. This means that you might need
26 to click "Show in export menu" in Preferences > File Formats for your
27 customized file formats if you want them to appear in the menu.
28 Note, though, that you still can export to any possible format via
29 File > Export > More Formats and Options ...
31 The following pref variables were changed in 2.0:
33 - \language_package was renamed to \language_custom_package
35 - \language_use_babel (bool) has been replaced by
36 \language_package_selection, which can be
37 0 (automatic selection)
39 2 custom (use the custom package defined by
40 \language_custom_package)
41 3 none (equivalent to former \language_use_babel false)
43 The following pref variables are obsoleted in 2.0:
45 - \plaintext_roff_command (was not used anymore)
47 - \personal_dictionary, \spell_command, \use_input_encoding,
48 \use_personal_dictionary and \use_spell_lib (ispell support has been
51 - \spellchecker_use_alt_lang and \use_escape_chars (actually not used
52 by the UI, and it is as simple to check whether the relevant
55 - \custom_export_command and \custom_export_format
58 The following new LyX functions have been introduced:
60 - LFUN_WORD_FINDAD ("word-findadv").
62 - LFUN_REGEXP_MODE ("regexp-mode").
64 - LFUN_PHANTOM_INSERT ("phantom-insert").
66 - LFUN_INSET_BEGIN ("inset-begin").
68 - LFUN_INSET_END (""inset-end"").
70 - LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
72 - LFUN_INSET_END_SELECT ("inset-end-select").
74 - LFUN_CHANGE_PREVIOUS ("change-previous").
76 - LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
78 - LFUN_SECTION_SELECT ("section-select").
80 - LFUN_FONT_UNDERLINE ("font-underline").
82 - LFUN_FONT_STRIKEOUT ("font-strikeout").
84 - LFUN_FONT_UULINE ("font-underunderline").
86 - LFUN_FONT_UWAVE ("font-underwave").
88 - LFUN_BRANCHES_RENAME ("branches-rename").
90 - LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
92 - LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
94 - LFUN_INSET_FORALL ("inset-forall").
96 - LFUN_DEBUG_LEVEL_SET ("debug-level-set").
98 - LFUN_INSET_SELECT_ALL ("inset-select-all").
100 - LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
102 - LFUN_VC_COMPARE ("vc-compare").
104 - LFUN_SPELLING_ADD ("spelling-add").
106 - LFUN_SPELLING_IGNORE ("spelling-ignore").
108 - LFUN_SPELLING_REMOVE ("spelling-remove").
110 - LFUN_PREVIEW_INSERT ("preview-insert").
112 - LFUN_FORWARD_SEARCH ("forward-search").
114 - LFUN_INSET_COPY_AS ("inset-copy-as").
116 - LFUN_BUFFER_TOGGLE_OUTPUT_SYNC ("buffer-toggle-output-sync").
119 The following LyX functions have been removed:
121 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
123 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
125 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
127 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
128 notes-mutate <SOURCE> <TARGET>
129 with the more general function inset-forall
130 inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
132 - LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
133 all-insets-toggle <ACTION> <TARGET>
134 all-insets-toggle <ACTION>
135 with the more generic function inset-forall
136 inset-forall <TARGET> inset-toggle <ACTION>
137 inset-forall * inset-toggle <ACTION>
138 There is a difference in the <TARGET> parameter, which is would be
139 like "note" in the first case and "Note" in the second.
141 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
142 I.e., "tabular-feature FEATURE <ARGS>" becomes:
143 inset-modify tabular FEATURE <ARGS>
145 - LFUN_LINE_INSERT ("line-insert"): use "inset-insert line" instead. For
146 something close to the previous default, use:
147 inset-insert line rule height 0.25ex width 100col% \\end_inset
148 This is necessary because the line inset now takes various arguments.
150 - LFUN_TOC_INSERT ("toc-insert"): use "inset-insert toc" instead.
153 The following LyX functions have been changed:
155 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
156 to show the settings dialog. This is no longer possible and one should use
157 inset-settings for this purpose.
159 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
160 arguments have been inverted in order to allow the replacement of the word
161 at current cursor position, even if it is not selected.
163 - LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT
167 The following LyX key bindings have been changed:
169 - LFUN_MATH_MACRO_FOLD ("math-macro-fold")
170 The binding to "C-minus" has changed to "C-S-underscore".
172 - LFUN_MATH_MACRO_UNFOLD ("math-macro-unfold")
173 The binding to "C-plus" has changed to "C-S-asterisk".
176 New external programs and libraries:
177 ------------------------------------
179 LyX 2.0 introduces support for some new external helper programs/libraries,
180 while the support for some existing programs has been dropped. This
181 particularly applies to spell checking and the thesaurus.
185 * Direct support for ispell and hspell has been dropped. However, ispell
186 and hspell are still accessible via the enchant wrapper (see below).
188 * Support for the aspell command line program has been dropped. Note that
189 the aspell library (aspell 0.60.x) is still supported.
191 * As well as the aspell library, LyX now also supports hunspell (the spell
192 checker used by OpenOffice and Firefox) and enchant, a wrapper that
193 provides automatic access to many spell checking libraries (ispell,
194 aspell, hspell, hunspell, etc.).
196 * On Mac OSX, Apple's Spell Server is preconfigured as the "native" spell
199 LyX 2.0 is configured for any and all of these three possibilities,
200 given that the various libraries are installed on the machine where LyX is
201 configured. The actual spell checker can be selected in Tools > Preferences.
202 Packagers are advised to pre-select whatever is most common on their
203 platform/distribution.
207 * Support for the aiksaurus library has been dropped in favour of the
208 MyThes thesaurus library (the thesaurus library used by OpenOffice).
210 * LyX ships the MyThes library itself, so unlike in LyX 1.6.x, no extra
211 thesaurus library needs to be installed. However, LyX does not ship any
212 thesaurus dictionaries, and those do have to be installed separately.
214 * The OpenOffice thesaurus dictionaries can be used, but the path to those
215 dictionaries needs to be set in Tools > Preferences. Please refer to the
216 UserGuide, sec. 6.13, for further instructions.
218 Packagers are advised to preset the thesaurus for their distribution/
219 platform. Packagers of installation bundles (on Windows and the Mac)
220 are advised to provide automatic installation of thesaurus dictionaries
221 in the installation process (analoguous to the spellchecker installation).
225 There is now direct support for Lilypond-book. Note that LyX requires at
226 least version 2.14 for proper work.
230 Make sure that dv2dt (often part of LaTeX distributions) is installed
231 on your system. Instant preview wil be disabled if dv2dt is not found.
234 Known issues in version 2.0.0
235 -----------------------------
237 - LyX needs to be run under Python 2 and will not work properly on systems
238 where Python 3 is the default binary. See bug #7030 to know how to fix
239 this properly, since simple sheebang conversion in *.py files will not
242 Caveats when upgrading from earlier versions to 2.0.x
243 -------------------------------------------------------
245 - The syntax of the languages file has been changed. If you use a modified
246 languages file, you will need to adapt it to the new syntax, as LyX 2.0
247 is not able to read old languages file anymore.
248 Please refer to the beginning of the languages file for an explanation
251 - There has been a large change in how Flex insets are named. Previously,
252 they tended to have names like "CharStyle:Noun". Now, they just have
253 names like "Flex:Noun" (where "Flex" is a namespace that is optional).
254 When LyX 2.0 reads older files, it silently converts the old-style names
255 to new-style names; this direction works perfectly. It will also silently
256 revert new-style names to old-style names, when exporting to 1.6.x format,
257 but only for the pre-defined LyX insets. This means that user-defined flex
258 insets will not be properly reverted.
259 To solve this problem, you can modify the file $LYXDIR/lyx2lyx/lyx_2_0.py.
260 In that file, you will find the following:
262 "Alert" : "CharStyle:Alert",
263 "Code" : "CharStyle:Code",
264 "Concepts" : "CharStyle:Concepts",
265 "E-Mail" : "CharStyle:E-Mail",
266 "Emph" : "CharStyle:Emph",
267 "Expression" : "CharStyle:Expression",
268 "Initial" : "CharStyle:Initial",
269 "Institute" : "CharStyle:Institute",
270 "Meaning" : "CharStyle:Meaning",
271 "Noun" : "CharStyle:Noun",
272 "Strong" : "CharStyle:Strong",
273 "Structure" : "CharStyle:Structure",
274 "ArticleMode" : "Custom:ArticleMode",
275 "Endnote" : "Custom:Endnote",
276 "Glosse" : "Custom:Glosse",
277 "PresentationMode" : "Custom:PresentationMode",
278 "Tri-Glosse" : "Custom:Tri-Glosse"
280 This is a map form new-style names (minux "Flex") to old-style names (and
281 there is a similar for DocBook elements). To get a user-defined CharStyle
282 to revert properly, it simply needs to be added to this list.
285 Note: There may later be an updated list of known issues online at
286 http://wiki.lyx.org/LyX/ReleaseNotes