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_PREVIEW_INSERT ("preview-insert").
  88
  89 - LFUN_FORWARD_SEARCH ("forward-search").
  90
  91 - LFUN_INSET_COPY_AS ("inset-copy-as").
  92
  93
  94 The following LyX functions have been removed:
  95
  96 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
  97
  98 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
  99
 100 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
 101
 102 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
 103     notes-mutate <SOURCE> <TARGET>
 104   with the more general function inset-forall
 105     inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
 106
 107 - LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
 108     all-insets-toggle <ACTION> <TARGET>
 109     all-insets-toggle <ACTION>
 110   with the more generic function inset-forall
 111     inset-forall <TARGET> inset-toggle <ACTION>
 112     inset-forall * inset-toggle <ACTION>
 113   There is a difference in the <TARGET> parameter, which is would be
 114   like "note" in the first case and "Note" in the second.
 115
 116 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
 117
 118
 119 The following LyX functions have been changed:
 120
 121 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
 122   to show the settings dialog. This is no longer possible and one should use
 123   inset-settings for this purpose.
 124
 125 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
 126   arguments have been inverted in order to allow the replacement of the word
 127   at current cursor position, even if it is not selected.
 128
 129 - LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT
 130   ("argument-insert").
 131
 132
 133 New external programs and libaries:
 134 -----------------------------------
 135
 136 LyX 2.0 introduces support for some new external helper programs/libraries,
 137 while the support for some existing programs has been dropped. This
 138 particularly applies to spell checking and the thesaurus.
 139
 140 1.) SPELLCHECKING:
 141
 142 * Direct support for ispell and hspell has been dropped. However, ispell
 143   and hspell are still accessible via the enchant wrapper (see below).
 144
 145 * Support for the aspell command line program has been dropped. Note that
 146   the aspell library (aspell 0.60.x) is still supported.
 147
 148 * Next to aspell (library), LyX now also supports hunspell (the spell
 149   checker used by OpenOffice and Firefox) and enchant, a wrapper that
 150   provides automatic access to many spell checking libraries (ispell,
 151   aspell, hspell, hunspell, etc.).
 152
 153 LyX 2.0 is configured for any and multiple of these three possibilities,
 154 given that they are installed on the machine where LyX is configured on.
 155 The actual spell checker can be selected in Tools > Preferences.
 156 Packagers are advised to pre-select whatever is most common on their
 157 platform/distribution.
 158
 159 2.) THESAURUS:
 160
 161 * Support for the aiksaurus library has been dropped in favour of the
 162   MyThes thesaurus library (the thesaurus library used by OpenOffice).
 163
 164 * LyX ships the MyThes library itself, so contrary to LyX 1.6.x, no
 165   extra thesaurus library needs to be installed. However, LyX does not
 166   ship any thesaurus dictionary.
 167
 168 * The OpenOffice thesaurus dictionaries can be used, but the path to those
 169   dictionary needs to be set in Tools > Preferences. Please refer to the
 170   UserGuide, sec. 6.13, for further instructions.
 171
 172 Packagers are advised to preset the thesaurus for their distribution/
 173 platform. Packagers of installation bundles (on Windows and the Mac)
 174 are advised to provide automatic installation of thesaurus disctionaries
 175 in the installation process (analoguous to the spellchecker installation).
 176
 177
 178 Known issues in version 2.0.0
 179 -----------------------------
 180
 181
 182 Caveats when upgrading from earlier versions to 2.0.x
 183 -------------------------------------------------------
 184
 185
 186
 187
 188 Note: There may later be an updated list of known issues online at
 189         http://wiki.lyx.org/LyX/ReleaseNotes
 190
 191 TODO
 192 ----
 193 - Somebody should create a rc2rc script...
 194   http://www.lyx.org/trac/changeset/27531