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