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 The following variables are obsoleted in 2.0
  21
  22 - \plaintext_roff_command (was not used anymore)
  23
  24 - \personal_dictionary, \spell_command, \use_input_encoding,
  25   \use_personal_dictionary and \use_spell_lib (ispell support has been
  26   removed)
  27
  28 - \spellchecker_use_alt_lang and \use_escape_chars (actually not used
  29   by the UI, and it is as simple to check whether the relevant
  30   variable is empty)
  31
  32 - \custom_export_command and \custom_export_format
  33
  34
  35 The following new LyX functions have been introduced:
  36
  37 - LFUN_WORD_FINDAD ("word-findadv").
  38
  39 - LFUN_REGEXP_MODE ("regexp-mode").
  40
  41 - LFUN_PHANTOM_INSERT ("phantom-insert").
  42
  43 - LFUN_INSET_BEGIN ("inset-begin").
  44
  45 - LFUN_INSET_END (""inset-end"").
  46
  47 - LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
  48
  49 - LFUN_INSET_END_SELECT ("inset-end-select").
  50
  51 - LFUN_CHANGE_PREVIOUS ("change-previous").
  52
  53 - LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
  54
  55 - LFUN_SECTION_SELECT ("section-select").
  56
  57 - LFUN_FONT_UNDERLINE ("font-underline").
  58
  59 - LFUN_FONT_STRIKEOUT ("font-strikeout").
  60
  61 - LFUN_FONT_UULINE ("font-underunderline").
  62
  63 - LFUN_FONT_UWAVE ("font-underwave").
  64
  65 - LFUN_BRANCHES_RENAME ("branches-rename").
  66
  67 - LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
  68
  69 - LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
  70
  71 - LFUN_INSET_FORALL ("inset-forall").
  72
  73 - LFUN_DEBUG_LEVEL_SET ("debug-level-set").
  74
  75 - LFUN_INSET_SELECT_ALL ("inset-select-all").
  76
  77 - LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
  78
  79 - LFUN_VC_COMPARE ("vc-compare").
  80
  81 - LFUN_SPELLING_ADD ("spelling-add").
  82
  83 - LFUN_SPELLING_IGNORE ("spelling-ignore").
  84
  85
  86 The following LyX functions have been removed:
  87
  88 - LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
  89
  90 - LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
  91
  92 - LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
  93
  94 - LFUN_NOTES_MUTATE ("notes-mutate"): replace
  95     notes-mutate <SOURCE> <TARGET>
  96   with the more general function inset-forall
  97     inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
  98
  99 - LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
 100
 101
 102 The following LyX functions have been changed:
 103
 104 - LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
 105   to show the settings dialog. This is no longer possible and one should use
 106   inset-settings for this purpose.
 107
 108 - LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
 109   arguments have been inverted in order to allow the replacement of the word
 110   at current cursor position, even if it is not selected.
 111
 112
 113 New external programs and libaries:
 114 -----------------------------------
 115
 116 LyX 2.0 introduces support for some new external helper programs/libraries,
 117 while the support for some existing programs has been dropped. This
 118 particularly applies to spell checking and the thesaurus.
 119
 120 1.) SPELLCHECKING:
 121
 122 * Direct support for ispell and hspell has been dropped. However, ispell
 123   and hspell are still accessible via the enchant wrapper (see below).
 124
 125 * Support for the aspell command line program has been dropped. Note that
 126   the aspell library (aspell 0.60.x) is still supported.
 127
 128 * Next to aspell (library), LyX now also supports hunspell (the spell
 129   checker used by OpenOffice and Firefox) and enchant, a wrapper that
 130   provides automatic access to many spell checking libraries (ispell,
 131   aspell, hspell, hunspell, etc.).
 132
 133 LyX 2.0 is configured for any and multiple of these three possibilities,
 134 given that they are installed on the machine where LyX is configured on.
 135 The actual spell checker can be selected in Tools > Preferences.
 136 Packagers are advised to pre-select whatever is most common on their
 137 platform/distribution.
 138
 139 2.) THESAURUS:
 140
 141 * Support for the aiksaurus library has been dropped in favour of the
 142   MyThes thesaurus library (the thesaurus library used by OpenOffice).
 143
 144 * LyX ships the MyThes library itself, so contrary to LyX 1.6.x, no
 145   extra thesaurus library needs to be installed. However, LyX does not
 146   ship any thesaurus dictionary.
 147
 148 * The OpenOffice thesaurus dictionaries can be used, but the path to those
 149   dictionary needs to be set in Tools > Preferences. Please refer to the
 150   UserGuide, sec. 6.13, for further instructions.
 151
 152 Packagers are advised to preset the thesaurus for their distribution/
 153 platform. Packagers of installation bundles (on Windows and the Mac)
 154 are advised to provide automatic installation of thesaurus disctionaries
 155 in the installation process (analoguous to the spellchecker installation).
 156
 157
 158 Known issues in version 2.0.0
 159 -----------------------------
 160
 161
 162 Caveats when upgrading from earlier versions to 2.0.x
 163 -------------------------------------------------------
 164
 165
 166
 167
 168 Note: There may later be an updated list of known issues online at
 169         http://wiki.lyx.org/LyX/ReleaseNotes
 170
 171 TODO
 172 ----
 173 - Somebody should create a rc2rc script...
 174   http://www.lyx.org/trac/changeset/27531
 175
 176 - some summary about 3rd party programs additions/removals should be
 177   written for packagers (eg aiksauraus, libtool).
 178