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 - The functions LFUN_FLOAT_LIST has been renamed to LFUN_FLOAT_LIST_INSERT.
  67
  68 The following new LyX functions have been introduced:
  69
  70 - LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).
  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_INFO_INSERT, "info-insert".
 131
 132 - LFUN_LAYOUT_RELOAD, "layout-reload".
 133
 134 - LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear".
 135
 136 - LFUN_LAYOUT_MODULE_ADD, "layout-module-add".
 137
 138 - LFUN_NEXT_INSET_MODIFY, "next-inset-modify"
 139
 140 - LFUN_INSET_EDIT, "inset-edit"
 141
 142 - LFUN_SET_GRAPHICS_GROUP, "set-graphics-group"
 143
 144 - LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify"
 145
 146 - LFUN_BRANCH_ACTIVATE, "branch-activate"
 147
 148 - LFUN_BRANCH_DEACTIVATE, "branch-deactivate"
 149   These can be used in export mode to turn branches on and off.
 150   Thus, something like:
 151     lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
 152   could be used to export a pdf with the answers branch included, without
 153   one's having to open LyX and activate the branch manually.
 154
 155 The following new LyX functions have been removed:
 156
 157 - LFUN_FILE_NEW.
 158
 159 - LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.
 160
 161 - LFUN_FONT_CODE.
 162
 163 - LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted
 164   via "space-insert hfill".
 165
 166 - LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 167
 168 - LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 169
 170 - LFUN_SERVER_GET_FONT.
 171
 172 - LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT.
 173
 174 - LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT.
 175
 176 - LFUN_ACCENT_SPECIAL_CARON.
 177
 178 - LFUN_INSET_REFRESH.
 179
 180 For the detailed description of LyX functions look into doxygen documentation.
 181
 182
 183 Known issues in version 1.6.0
 184 ------------------------------------
 185
 186 - ...
 187
 188
 189 Caveats when upgrading from earlier versions to 1.6.x
 190 -------------------------------------------------------
 191
 192 The support for Japanese has been improved in LyX 1.6.x. Due to encoding
 193 reasons, Japanese documents that were edited with LyX 1.6.x cannot correctly
 194 be converted to the format of LyX 1.5.x and thus not edited with LyX 1.5.x.
 195 To be able to use LyX 1.6 with Japanese, the latest version of the LaTeX
 196 distribution "platex" must be installed.
 197 platex provides a Japanese variant of BibTeX named "jbibtex". When LyX is
 198 configured, this variant is used. In case you have problems with BibTeX-files
 199 that include Japanese or you need to use another BibTeX program, set it in LyX
 200 preferences under Output->LaTeX->BibTeX command.
 201
 202
 203 Note: There may later be an updated list of known issues online at
 204         http://wiki.lyx.org/LyX/ReleaseNotes
 205