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").
61 - LFUN_REGEXP_MODE ("regexp-mode").
62 - LFUN_PHANTOM_INSERT ("phantom-insert").
63 - LFUN_INSET_BEGIN ("inset-begin").
64 - LFUN_INSET_END (""inset-end"").
65 - LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
66 - LFUN_INSET_END_SELECT ("inset-end-select").
67 - LFUN_CHANGE_PREVIOUS ("change-previous").
68 - LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
69 - LFUN_SECTION_SELECT ("section-select").
70 - LFUN_FONT_UNDERLINE ("font-underline").
71 - LFUN_FONT_STRIKEOUT ("font-strikeout").
72 - LFUN_FONT_UULINE ("font-underunderline").
73 - LFUN_FONT_UWAVE ("font-underwave").
74 - LFUN_BRANCHES_RENAME ("branches-rename").
75 - LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
76 - LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
77 - LFUN_INSET_FORALL ("inset-forall").
78 - LFUN_DEBUG_LEVEL_SET ("debug-level-set").
79 - LFUN_INSET_SELECT_ALL ("inset-select-all").
80 - LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
81 - LFUN_VC_COMPARE ("vc-compare").
82 - LFUN_SPELLING_ADD ("spelling-add").
83 - LFUN_SPELLING_IGNORE ("spelling-ignore").
84 - LFUN_SPELLING_REMOVE ("spelling-remove").
85 - LFUN_PREVIEW_INSERT ("preview-insert").
86 - LFUN_FORWARD_SEARCH ("forward-search").
87 - LFUN_INSET_COPY_AS ("inset-copy-as").
88 - LFUN_BUFFER_TOGGLE_OUTPUT_SYNC ("buffer-toggle-output-sync").
91 The following LyX functions have been removed:
93 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
94 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
95 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
97 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
98 notes-mutate <SOURCE> <TARGET>
99 with the more general function inset-forall
100 inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
102 - LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
103 all-insets-toggle <ACTION> <TARGET>
104 all-insets-toggle <ACTION>
105 with the more generic function inset-forall
106 inset-forall <TARGET> inset-toggle <ACTION>
107 inset-forall * inset-toggle <ACTION>
108 There is a difference in the <TARGET> parameter, which is would be
109 like "note" in the first case and "Note" in the second.
111 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
112 I.e., "tabular-feature FEATURE <ARGS>" becomes:
113 inset-modify tabular FEATURE <ARGS>
115 - LFUN_LINE_INSERT ("line-insert"): use "inset-insert line" instead. For
116 something close to the previous default, use:
117 inset-insert line rule height 0.25ex width 100col% \\end_inset
118 This is necessary because the line inset now takes various arguments.
120 - LFUN_TOC_INSERT ("toc-insert"): use "inset-insert toc" instead.
123 The following LyX functions have been changed:
125 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
126 to show the settings dialog. This is no longer possible and one should use
127 inset-settings for this purpose.
129 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
130 arguments have been inverted in order to allow the replacement of the word
131 at current cursor position, even if it is not selected.
133 - LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT
137 The following LyX key bindings have been changed:
139 - LFUN_MATH_MACRO_FOLD ("math-macro-fold")
140 The binding to "C-minus" has changed to "C-S-underscore".
142 - LFUN_MATH_MACRO_UNFOLD ("math-macro-unfold")
143 The binding to "C-plus" has changed to "C-S-asterisk".
145 - On Mac OSX the modifier keys <Control> and <Option> are now treated separately.
146 The distributed key binding for Mac OSX no longer uses the <Option> key for
147 shortcuts with letters or numbers.
149 The custom key bindings for <Option>/<Control> are mapped to the <Control>
152 New external programs and libraries:
153 ------------------------------------
155 LyX 2.0 introduces support for some new external helper programs/libraries,
156 while the support for some existing programs has been dropped. This
157 particularly applies to spell checking and the thesaurus.
161 * Direct support for ispell and hspell has been dropped. However, ispell
162 and hspell are still accessible via the enchant wrapper (see below).
164 * Support for the aspell command line program has been dropped. Note that
165 the aspell library (aspell 0.60.x) is still supported.
167 * As well as the aspell library, LyX now also supports hunspell (the spell
168 checker used by OpenOffice and Firefox) and enchant, a wrapper that
169 provides automatic access to many spell checking libraries (ispell,
170 aspell, hspell, hunspell, etc.).
172 * On Mac OSX, Apple's Spell Server is preconfigured as the "native" spell
175 LyX 2.0 is configured for any and all of these three possibilities,
176 given that the various libraries are installed on the machine where LyX is
177 configured. The actual spell checker can be selected in Tools > Preferences.
178 Packagers are advised to pre-select whatever is most common on their
179 platform/distribution.
183 * Support for the aiksaurus library has been dropped in favour of the
184 MyThes thesaurus library (the thesaurus library used by OpenOffice).
186 * LyX ships the MyThes library itself, so unlike in LyX 1.6.x, no extra
187 thesaurus library needs to be installed. However, LyX does not ship any
188 thesaurus dictionaries, and those do have to be installed separately.
190 * The OpenOffice thesaurus dictionaries can be used, but the path to those
191 dictionaries needs to be set in Tools > Preferences. Please refer to the
192 UserGuide, sec. 6.13, for further instructions.
194 Packagers are advised to preset the thesaurus for their distribution/
195 platform. Packagers of installation bundles (on Windows and the Mac)
196 are advised to provide automatic installation of thesaurus dictionaries
197 in the installation process (analoguous to the spellchecker installation).
201 There is now direct support for Lilypond-book. Note that LyX requires at
202 least version 2.14 for proper work.
206 Make sure that dv2dt (often part of LaTeX distributions) is installed
207 on your system. Instant preview wil be disabled if dv2dt is not found.
211 For proper LuaTeX support you need to have at least TeXLive 2010.
214 Known issues in version 2.0.0
215 -----------------------------
217 - LyX needs to be run under Python 2 and will not work properly on systems
218 where Python 3 is the default binary. See bug #7030 to know how to fix
219 this properly, since simple sheebang conversion in *.py files will not
222 Caveats when upgrading from earlier versions to 2.0.x
223 -------------------------------------------------------
225 - The syntax of the languages file has been changed. If you use a modified
226 languages file, you will need to adapt it to the new syntax, as LyX 2.0
227 is not able to read old languages file anymore.
228 Please refer to the beginning of the languages file for an explanation
231 - There has been a large change in how Flex insets are named. Previously,
232 they tended to have names like "CharStyle:Noun". Now, they just have
233 names like "Flex:Noun" (where "Flex" is a namespace that is optional).
234 When LyX 2.0 reads older files, it silently converts the old-style names
235 to new-style names; this direction works perfectly. It will also silently
236 revert new-style names to old-style names, when exporting to 1.6.x format,
237 but only for the pre-defined LyX insets. This means that user-defined flex
238 insets will not be properly reverted.
239 To solve this problem, you can modify the file $LYXDIR/lyx2lyx/lyx_2_0.py.
240 In that file, you will find the following:
242 "Alert" : "CharStyle:Alert",
243 "Code" : "CharStyle:Code",
244 "Concepts" : "CharStyle:Concepts",
245 "E-Mail" : "CharStyle:E-Mail",
246 "Emph" : "CharStyle:Emph",
247 "Expression" : "CharStyle:Expression",
248 "Initial" : "CharStyle:Initial",
249 "Institute" : "CharStyle:Institute",
250 "Meaning" : "CharStyle:Meaning",
251 "Noun" : "CharStyle:Noun",
252 "Strong" : "CharStyle:Strong",
253 "Structure" : "CharStyle:Structure",
254 "ArticleMode" : "Custom:ArticleMode",
255 "Endnote" : "Custom:Endnote",
256 "Glosse" : "Custom:Glosse",
257 "PresentationMode" : "Custom:PresentationMode",
258 "Tri-Glosse" : "Custom:Tri-Glosse"
260 This is a map form new-style names (minux "Flex") to old-style names (and
261 there is a similar for DocBook elements). To get a user-defined CharStyle
262 to revert properly, it simply needs to be added to this list.
265 Note: There may later be an updated list of known issues online at
266 http://wiki.lyx.org/LyX/ReleaseNotes
268 - UI layout named "classic.ui" and some localized keyboard bindings (sv,pt,fi)
269 were long time unmaintained and we do not ship it anymore.