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