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 Bash completion script was added to the tarball.
22 The following pref variables were changed in 2.0:
24 - \language_package was renamed to \language_custom_package
26 - \language_use_babel (bool) has been replaced by
27 \language_package_selection, which can be
28 0 (automatic selection)
30 2 custom (use the custom package defined by
31 \language_custom_package)
32 3 none (equivalent to former \language_use_babel false)
34 The following pref variables are obsoleted in 2.0:
36 - \plaintext_roff_command (was not used anymore)
38 - \personal_dictionary, \spell_command, \use_input_encoding,
39 \use_personal_dictionary and \use_spell_lib (ispell support has been
42 - \spellchecker_use_alt_lang and \use_escape_chars (actually not used
43 by the UI, and it is as simple to check whether the relevant
46 - \custom_export_command and \custom_export_format
49 The following new LyX functions have been introduced:
51 - LFUN_WORD_FINDAD ("word-findadv").
53 - LFUN_REGEXP_MODE ("regexp-mode").
55 - LFUN_PHANTOM_INSERT ("phantom-insert").
57 - LFUN_INSET_BEGIN ("inset-begin").
59 - LFUN_INSET_END (""inset-end"").
61 - LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
63 - LFUN_INSET_END_SELECT ("inset-end-select").
65 - LFUN_CHANGE_PREVIOUS ("change-previous").
67 - LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
69 - LFUN_SECTION_SELECT ("section-select").
71 - LFUN_FONT_UNDERLINE ("font-underline").
73 - LFUN_FONT_STRIKEOUT ("font-strikeout").
75 - LFUN_FONT_UULINE ("font-underunderline").
77 - LFUN_FONT_UWAVE ("font-underwave").
79 - LFUN_BRANCHES_RENAME ("branches-rename").
81 - LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
83 - LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
85 - LFUN_INSET_FORALL ("inset-forall").
87 - LFUN_DEBUG_LEVEL_SET ("debug-level-set").
89 - LFUN_INSET_SELECT_ALL ("inset-select-all").
91 - LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
93 - LFUN_VC_COMPARE ("vc-compare").
95 - LFUN_SPELLING_ADD ("spelling-add").
97 - LFUN_SPELLING_IGNORE ("spelling-ignore").
99 - LFUN_SPELLING_REMOVE ("spelling-remove").
101 - LFUN_PREVIEW_INSERT ("preview-insert").
103 - LFUN_FORWARD_SEARCH ("forward-search").
105 - LFUN_INSET_COPY_AS ("inset-copy-as").
107 - LFUN_BUFFER_TOGGLE_OUTPUT_SYNC ("buffer-toggle-output-sync").
110 The following LyX functions have been removed:
112 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
114 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
116 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
118 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
119 notes-mutate <SOURCE> <TARGET>
120 with the more general function inset-forall
121 inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
123 - LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
124 all-insets-toggle <ACTION> <TARGET>
125 all-insets-toggle <ACTION>
126 with the more generic function inset-forall
127 inset-forall <TARGET> inset-toggle <ACTION>
128 inset-forall * inset-toggle <ACTION>
129 There is a difference in the <TARGET> parameter, which is would be
130 like "note" in the first case and "Note" in the second.
132 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
133 I.e., "tabular-feature FEATURE <ARGS>" becomes:
134 inset-modify tabular FEATURE <ARGS>
136 - LFUN_LINE_INSERT ("line-insert"): use "inset-insert line" instead. For
137 something close to the previous default, use:
138 inset-insert line rule height 0.25ex width 100col% \\end_inset
139 This is necessary because the line inset now takes various arguments.
141 - LFUN_TOC_INSERT ("toc-insert"): use "inset-insert toc" instead.
144 The following LyX functions have been changed:
146 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
147 to show the settings dialog. This is no longer possible and one should use
148 inset-settings for this purpose.
150 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
151 arguments have been inverted in order to allow the replacement of the word
152 at current cursor position, even if it is not selected.
154 - LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT
158 The following LyX key bindings have been changed:
160 - LFUN_MATH_MACRO_FOLD ("math-macro-fold")
161 The binding to "C-minus" has changed to "C-S-underscore".
163 - LFUN_MATH_MACRO_UNFOLD ("math-macro-unfold")
164 The binding to "C-plus" has changed to "C-S-asterisk".
167 New external programs and libaries:
168 -----------------------------------
170 LyX 2.0 introduces support for some new external helper programs/libraries,
171 while the support for some existing programs has been dropped. This
172 particularly applies to spell checking and the thesaurus.
176 * Direct support for ispell and hspell has been dropped. However, ispell
177 and hspell are still accessible via the enchant wrapper (see below).
179 * Support for the aspell command line program has been dropped. Note that
180 the aspell library (aspell 0.60.x) is still supported.
182 * As well as the aspell library, LyX now also supports hunspell (the spell
183 checker used by OpenOffice and Firefox) and enchant, a wrapper that
184 provides automatic access to many spell checking libraries (ispell,
185 aspell, hspell, hunspell, etc.).
187 * On Mac OSX, Apple's Spell Server is preconfigured as the "native" spell
190 LyX 2.0 is configured for any and all of these three possibilities,
191 given that the various libraries are installed on the machine where LyX is
192 configured. The actual spell checker can be selected in Tools > Preferences.
193 Packagers are advised to pre-select whatever is most common on their
194 platform/distribution.
198 * Support for the aiksaurus library has been dropped in favour of the
199 MyThes thesaurus library (the thesaurus library used by OpenOffice).
201 * LyX ships the MyThes library itself, so unlike in LyX 1.6.x, no extra
202 thesaurus library needs to be installed. However, LyX does not ship any
203 thesaurus dictionaries, and those do have to be installed separately.
205 * The OpenOffice thesaurus dictionaries can be used, but the path to those
206 dictionaries needs to be set in Tools > Preferences. Please refer to the
207 UserGuide, sec. 6.13, for further instructions.
209 Packagers are advised to preset the thesaurus for their distribution/
210 platform. Packagers of installation bundles (on Windows and the Mac)
211 are advised to provide automatic installation of thesaurus dictionaries
212 in the installation process (analoguous to the spellchecker installation).
216 There is now direct support for Lilypond-book. Note that LyX requires at
217 least version 2.14 for proper work.
220 Known issues in version 2.0.0
221 -----------------------------
223 - LyX needs to be run under Python 2 and will not work properly on systems
224 where Python 3 is the default binary. See bug #7030 to know how to fix
225 this properly, since simple sheebang conversion in *.py files will not
228 Caveats when upgrading from earlier versions to 2.0.x
229 -------------------------------------------------------
231 - The syntax of the languages file has been changed. If you use a modified
232 languages file, you will need to adapt it to the new syntax, as LyX 2.0
233 is not able to read old languages file anymore.
234 Please refer to the beginning of the languages file for an explanation
237 - There has been a large change in how Flex insets are named. Previously,
238 they tended to have names like "CharStyle:Noun". Now, they just have
239 names like "Flex:Noun" (where "Flex" is a namespace that is optional).
240 When LyX 2.0 reads older files, it silently converts the old-style names
241 to new-style names; this direction works perfectly. It will also silently
242 revert new-style names to old-style names, when exporting to 1.6.x format,
243 but only for the pre-defined LyX insets. This means that user-defined flex
244 insets will not be properly reverted.
245 To solve this problem, you can modify the file $LYXDIR/lyx2lyx/lyx_2_0.py.
246 In that file, you will find the following:
248 "Alert" : "CharStyle:Alert",
249 "Code" : "CharStyle:Code",
250 "Concepts" : "CharStyle:Concepts",
251 "E-Mail" : "CharStyle:E-Mail",
252 "Emph" : "CharStyle:Emph",
253 "Expression" : "CharStyle:Expression",
254 "Initial" : "CharStyle:Initial",
255 "Institute" : "CharStyle:Institute",
256 "Meaning" : "CharStyle:Meaning",
257 "Noun" : "CharStyle:Noun",
258 "Strong" : "CharStyle:Strong",
259 "Structure" : "CharStyle:Structure",
260 "ArticleMode" : "Custom:ArticleMode",
261 "Endnote" : "Custom:Endnote",
262 "Glosse" : "Custom:Glosse",
263 "PresentationMode" : "Custom:PresentationMode",
264 "Tri-Glosse" : "Custom:Tri-Glosse"
266 This is a map form new-style names (minux "Flex") to old-style names (and
267 there is a similar for DocBook elements). To get a user-defined CharStyle
268 to revert properly, it simply needs to be added to this list.
271 Note: There may later be an updated list of known issues online at
272 http://wiki.lyx.org/LyX/ReleaseNotes
276 - Somebody should create a rc2rc script...
277 http://www.lyx.org/trac/changeset/27531