RELEASE-NOTES

   1 This file lists interface changes that might affect users in 1.6.0, some
   2 known problems in LyX 1.6.0 and some things you have to take into account
   3 when upgrading from earlier versions to a version of the 1.6.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 Some of the LyX functions have changed names:
  12
  13 - A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the
  14   different LFUNs for single special characters:
  15
  16   * LFUN_HYPHENATION_POINT_INSERT: removed. "hyphenation-point-insert"
  17     has been replaced by "specialchar-insert hyphenation-point"
  18   * LFUN_LIGATURE_BREAK_INSERT: removed. "ligature-break-insert"
  19     has been replaced by "specialchar-insert ligature-break"
  20   * LFUN_DOTS_INSERT: removed. "dots-insert"
  21     has been replaced by "specialchar-insert dots"
  22   * LFUN_END_OF_SENTENCE_PERIOD_INSERT: removed. "end-of-sentence-period-insert"
  23     has been replaced by "specialchar-insert end-of-sentence"
  24   * LFUN_MENU_SEPARATOR_INSERT: removed. "menu-separator-insert"
  25     has been replaced by "specialchar-insert menu-separator"
  26
  27 - The function LFUN_BREAK_LINE, "break-line" has been renamed to LFUN_NEWLINE_INSERT,
  28   "newline-insert", and it now allows two options: "newline-insert newline" inserts
  29   a \newline, "newline-insert linebreak" inserts a \linebreak.
  30
  31 - The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to
  32   LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions:
  33
  34   * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by
  35     "newpage-insert pagebreak"
  36
  37   * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by
  38     "newpage-insert clearpage"
  39
  40   * LFUN_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced
  41     by "newpage-insert cleardoublepage"
  42
  43 - The function LFUN_WORDS_COUNT, "words-count", has been replaced by
  44   LFUN_STATISTICS, "statistics", which counts more than words.
  45
  46 - The function LFUN_MATH_NUMBER, "math-number", has been renamed to
  47   LFUN_MATH_NUMBER_TOGGLE.
  48
  49 - The function LFUN_MATH_NONUMBER, "math-nonumber", has been renamed to
  50   LFUN_MATH_NUMBER_LINE_TOGGLE.
  51
  52 - The function LFUN_CHARSTYLE_INSERT, "charstyle-insert", has been renamed to
  53   LFUN_FLEX_INSERT, "flex-insert". It now handles beside charstyles, also
  54   custom insets and XML short element insets.
  55
  56 - The function LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar"
  57   has been renamed to LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE,
  58   "cursor-follows-scrollbar-toggle".
  59
  60 - The function LFUN_FONT_CODE, "font-code", has been renamed to
  61   LFUN_FONT_TYPEWRITER, "font-typewriter".
  62
  63 - The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, "url-insert" was
  64   superseded by LFUN_HYPERLINK_INSERT, "href-insert".
  65
  66
  67 The following new LyX functions have been introduced:
  68
  69 - LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).
  70
  71 - LFUN_COMPLETION_INLINE, "completion-inline".
  72
  73 - LFUN_COMPLETION_POPUP, "completion-popup".
  74
  75 - LFUN_COMPLETION_COMPLETE, "complete".
  76
  77 - LFUN_CLOSE_TAB_GROUP, "close-tab-group".
  78
  79 - LFUN_SPLIT_VIEW, "split-view".
  80
  81 - LFUN_UI_TOGGLE, "ui-toggle".
  82
  83 - LFUN_SCROLL, "scroll".
  84
  85 - LFUN_MATH_MACRO, "math-macro".
  86
  87 - LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
  88
  89 - LFUN_MATH_MACRO_FOLD, "math-macro-fold".
  90
  91 - LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".
  92
  93 - LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param".
  94
  95 - LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
  96
  97 - LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
  98
  99 - LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
 100
 101 - LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".
 102
 103 - LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param".
 104
 105 - LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param".
 106
 107 - LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param".
 108
 109 - LFUN_WORD_LEFT, "word-left".
 110
 111 - LFUN_WORD_LEFT_SELECT, "word-left-select".
 112
 113 - LFUN_WORD_RIGHT, "word-right".
 114
 115 - LFUN_WORD_RIGHT_SELECT, "word-right-select".
 116
 117 - LFUN_CHAR_LEFT, "char-left".
 118
 119 - LFUN_CHAR_LEFT_SELECT, "char-left-select".
 120
 121 - LFUN_CHAR_RIGHT, "char-right".
 122
 123 - LFUN_CHAR_RIGHT_SELECT, "char-right-select".
 124
 125 - LFUN_FINISHED_FORWARD, "".
 126
 127 - LFUN_FINISHED_BACKWARD, "".
 128
 129 - LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding".
 130
 131 - LFUN_INFO_INSERT, "info-insert".
 132
 133 - LFUN_LAYOUT_RELOAD, "layout-reload".
 134
 135 - LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear".
 136
 137 - LFUN_LAYOUT_MODULE_ADD, "layout-module-add".
 138
 139 - LFUN_NEXT_INSET_MODIFY, "next-inset-modify"
 140
 141
 142 The following new LyX functions have been removed:
 143
 144 - LFUN_FILE_NEW.
 145
 146 - LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.
 147
 148 - LFUN_FONT_CODE.
 149
 150 - LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted
 151   via "space-insert hfill".
 152
 153 - LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 154
 155 - LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 156
 157
 158 For the detailed description of LyX functions look into doxygen documentation.
 159
 160
 161 Known issues in version 1.5.2
 162 ------------------------------------
 163
 164 - Cursor restoration problems with Multiple-View:
 165   When using multiple Windows to edit different parts of the
 166   same document, the cursor position is sometimes not correctly restored
 167   when you switch from one view to the other.
 168
 169 - RTL and keymaps:
 170   Currently there is a bug where you can't use two non-RTL language keymaps if
 171   the RTL preference is set (which is now the default). If you need to use two
 172   non-RTL keymaps, for now you should just turn off the RTL preference (Tools ->
 173   Preferences... -> Language settings -> Language, uncheck "Right-to-left
 174   language support").
 175   We hope to offer more comprehensive support for multiple keymaps in the future,
 176   which will solve this bug, as well as allow more than just two keymaps. If you
 177   have any input on this issue, please chime in on the developers mailing list,
 178   or add your comments to http://bugzilla.lyx.org/show_bug.cgi?id=4051.
 179
 180
 181 Caveats when upgrading from earlier versions to 1.5.x
 182 -------------------------------------------------------
 183
 184 Due to the change to Unicode, there are some general things you'll have to take care
 185 about when upgrading from an older version to LyX 1.5.0 or newer. Please refer to the
 186 file UPGRADING for details.
 187
 188
 189 Note: There may later be an updated list of known issues online at
 190         http://wiki.lyx.org/LyX/ReleaseNotes
 191