RELEASE-NOTES

   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.
   6
   7
   8 Interface changes
   9 -----------------
  10
  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
  18 be more eventually.
  19
  20 Bash completion script was added to the tarball.
  21
  22 The following variables are obsoleted in 2.0
  23
  24 - \plaintext_roff_command (was not used anymore)
  25
  26 - \personal_dictionary, \spell_command, \use_input_encoding,
  27   \use_personal_dictionary and \use_spell_lib (ispell support has been
  28   removed)
  29
  30 - \spellchecker_use_alt_lang and \use_escape_chars (actually not used
  31   by the UI, and it is as simple to check whether the relevant
  32   variable is empty)
  33
  34 - \custom_export_command and \custom_export_format
  35
  36
  37 The following new LyX functions have been introduced:
  38
  39 - LFUN_WORD_FINDAD ("word-findadv").
  40
  41 - LFUN_REGEXP_MODE ("regexp-mode").
  42
  43 - LFUN_PHANTOM_INSERT ("phantom-insert").
  44
  45 - LFUN_INSET_BEGIN ("inset-begin").
  46
  47 - LFUN_INSET_END (""inset-end"").
  48
  49 - LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
  50
  51 - LFUN_INSET_END_SELECT ("inset-end-select").
  52
  53 - LFUN_CHANGE_PREVIOUS ("change-previous").
  54
  55 - LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
  56
  57 - LFUN_SECTION_SELECT ("section-select").
  58
  59 - LFUN_FONT_UNDERLINE ("font-underline").
  60
  61 - LFUN_FONT_STRIKEOUT ("font-strikeout").
  62
  63 - LFUN_FONT_UULINE ("font-underunderline").
  64
  65 - LFUN_FONT_UWAVE ("font-underwave").
  66
  67 - LFUN_BRANCHES_RENAME ("branches-rename").
  68
  69 - LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
  70
  71 - LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
  72
  73 - LFUN_INSET_FORALL ("inset-forall").
  74
  75 - LFUN_DEBUG_LEVEL_SET ("debug-level-set").
  76
  77 - LFUN_INSET_SELECT_ALL ("inset-select-all").
  78
  79 - LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
  80
  81 - LFUN_VC_COMPARE ("vc-compare").
  82
  83 - LFUN_SPELLING_ADD ("spelling-add").
  84
  85 - LFUN_SPELLING_IGNORE ("spelling-ignore").
  86
  87 - LFUN_SPELLING_REMOVE ("spelling-remove").
  88
  89 - LFUN_PREVIEW_INSERT ("preview-insert").
  90
  91 - LFUN_FORWARD_SEARCH ("forward-search").
  92
  93 - LFUN_INSET_COPY_AS ("inset-copy-as").
  94
  95 - LFUN_BUFFER_TOGGLE_OUTPUT_SYNC ("buffer-toggle-output-sync").
  96
  97
  98 The following LyX functions have been removed:
  99
 100 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
 101
 102 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
 103
 104 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
 105
 106 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
 107     notes-mutate <SOURCE> <TARGET>
 108   with the more general function inset-forall
 109     inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
 110
 111 - LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
 112     all-insets-toggle <ACTION> <TARGET>
 113     all-insets-toggle <ACTION>
 114   with the more generic function inset-forall
 115     inset-forall <TARGET> inset-toggle <ACTION>
 116     inset-forall * inset-toggle <ACTION>
 117   There is a difference in the <TARGET> parameter, which is would be
 118   like "note" in the first case and "Note" in the second.
 119
 120 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
 121   I.e., "tabular-feature FEATURE <ARGS>" becomes:
 122     inset-modify tabular FEATURE <ARGS>
 123
 124 - LFUN_LINE_INSERT ("line-insert"): use "inset-insert line" instead. For
 125   something close to the previous default, use:
 126     inset-insert line rule height 0.25ex width 100col% \\end_inset
 127   This is necessary because the line inset now takes various arguments.
 128
 129 - LFUN_TOC_INSERT ("toc-insert"): use "inset-insert toc" instead.
 130
 131
 132 The following LyX functions have been changed:
 133
 134 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
 135   to show the settings dialog. This is no longer possible and one should use
 136   inset-settings for this purpose.
 137
 138 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
 139   arguments have been inverted in order to allow the replacement of the word
 140   at current cursor position, even if it is not selected.
 141
 142 - LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT
 143   ("argument-insert").
 144
 145
 146 The following LyX key bindings have been changed:
 147
 148 - LFUN_MATH_MACRO_FOLD ("math-macro-fold")
 149   The binding to "C-minus" has changed to "C-S-underscore".
 150
 151 - LFUN_MATH_MACRO_UNFOLD ("math-macro-unfold")
 152   The binding to "C-plus" has changed to "C-S-asterisk".
 153
 154
 155 New external programs and libaries:
 156 -----------------------------------
 157
 158 LyX 2.0 introduces support for some new external helper programs/libraries,
 159 while the support for some existing programs has been dropped. This
 160 particularly applies to spell checking and the thesaurus.
 161
 162 1.) SPELLCHECKING:
 163
 164 * Direct support for ispell and hspell has been dropped. However, ispell
 165   and hspell are still accessible via the enchant wrapper (see below).
 166
 167 * Support for the aspell command line program has been dropped. Note that
 168   the aspell library (aspell 0.60.x) is still supported.
 169
 170 * As well as the aspell library, LyX now also supports hunspell (the spell
 171   checker used by OpenOffice and Firefox) and enchant, a wrapper that
 172   provides automatic access to many spell checking libraries (ispell,
 173   aspell, hspell, hunspell, etc.).
 174
 175 * On Mac OSX, Apple's Spell Server is preconfigured as the "native" spell
 176   checker.
 177
 178 LyX 2.0 is configured for any and all of these three possibilities,
 179 given that the various libraries are installed on the machine where LyX is
 180 configured. The actual spell checker can be selected in Tools > Preferences.
 181 Packagers are advised to pre-select whatever is most common on their
 182 platform/distribution.
 183
 184 2.) THESAURUS:
 185
 186 * Support for the aiksaurus library has been dropped in favour of the
 187   MyThes thesaurus library (the thesaurus library used by OpenOffice).
 188
 189 * LyX ships the MyThes library itself, so unlike in LyX 1.6.x, no extra
 190   thesaurus library needs to be installed. However, LyX does not ship any
 191   thesaurus dictionaries, and those do have to be installed separately.
 192
 193 * The OpenOffice thesaurus dictionaries can be used, but the path to those
 194   dictionaries needs to be set in Tools > Preferences. Please refer to the
 195   UserGuide, sec. 6.13, for further instructions.
 196
 197 Packagers are advised to preset the thesaurus for their distribution/
 198 platform. Packagers of installation bundles (on Windows and the Mac)
 199 are advised to provide automatic installation of thesaurus dictionaries
 200 in the installation process (analoguous to the spellchecker installation).
 201
 202 3.) LILYPOND:
 203
 204 There is now direct support for Lilypond-book. Note that LyX requires at
 205 least version 2.14 for proper work.
 206
 207
 208 Known issues in version 2.0.0
 209 -----------------------------
 210
 211
 212 Caveats when upgrading from earlier versions to 2.0.x
 213 -------------------------------------------------------
 214
 215
 216
 217
 218 Note: There may later be an updated list of known issues online at
 219         http://wiki.lyx.org/LyX/ReleaseNotes
 220
 221 TODO
 222 ----
 223 - Somebody should create a rc2rc script...
 224   http://www.lyx.org/trac/changeset/27531