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 The external template format recognize now a new tag: 'Preview'. This tag is
  12 used to define how an external material should be previewed in LyX. For more detail,
  13 see the 'external_templates' file in the resource directory of LyX.
  14
  15 Some of the LyX functions have changed names:
  16
  17 - A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the
  18   different LFUNs for single special characters:
  19
  20   * LFUN_HYPHENATION_POINT_INSERT: removed. "hyphenation-point-insert"
  21     has been replaced by "specialchar-insert hyphenation-point"
  22   * LFUN_LIGATURE_BREAK_INSERT: removed. "ligature-break-insert"
  23     has been replaced by "specialchar-insert ligature-break"
  24   * LFUN_DOTS_INSERT: removed. "dots-insert"
  25     has been replaced by "specialchar-insert dots"
  26   * LFUN_END_OF_SENTENCE_PERIOD_INSERT: removed. "end-of-sentence-period-insert"
  27     has been replaced by "specialchar-insert end-of-sentence"
  28   * LFUN_MENU_SEPARATOR_INSERT: removed. "menu-separator-insert"
  29     has been replaced by "specialchar-insert menu-separator"
  30
  31 - The function LFUN_BREAK_LINE, "break-line" has been renamed to LFUN_NEWLINE_INSERT,
  32   "newline-insert", and it now allows two options: "newline-insert newline" inserts
  33   a \newline, "newline-insert linebreak" inserts a \linebreak.
  34
  35 - The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to
  36   LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions:
  37
  38   * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by
  39     "newpage-insert pagebreak"
  40
  41   * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by
  42     "newpage-insert clearpage"
  43
  44   * LFUN_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced
  45     by "newpage-insert cleardoublepage"
  46
  47 - The function LFUN_WORDS_COUNT, "words-count", has been replaced by
  48   LFUN_STATISTICS, "statistics", which counts more than words.
  49
  50 - The function LFUN_MATH_NUMBER, "math-number", has been renamed to
  51   LFUN_MATH_NUMBER_TOGGLE.
  52
  53 - The function LFUN_MATH_NONUMBER, "math-nonumber", has been renamed to
  54   LFUN_MATH_NUMBER_LINE_TOGGLE.
  55
  56 - The function LFUN_CHARSTYLE_INSERT, "charstyle-insert", has been renamed to
  57   LFUN_FLEX_INSERT, "flex-insert". It now handles beside charstyles, also
  58   custom insets and XML short element insets.
  59
  60 - The function LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar"
  61   has been renamed to LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE,
  62   "cursor-follows-scrollbar-toggle".
  63
  64 - The function LFUN_FONT_CODE, "font-code", has been renamed to
  65   LFUN_FONT_TYPEWRITER, "font-typewriter".
  66
  67 - The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, "url-insert" was
  68   superseded by LFUN_HYPERLINK_INSERT, "href-insert".
  69
  70 - The function LFUN_FLOAT_LIST has been renamed to LFUN_FLOAT_LIST_INSERT.
  71
  72 - The functions delete-back/forward has been renamed to char-delete-back/forward.
  73
  74 - The functions LFUN_FONT_FREE_APPLY/UPDATE has been renamed to
  75   LFUN_TEXTSTYLE_APPLY/UPDATE.
  76
  77 - The functions LFUN_SERVER_GET_NAME has been renamed to
  78   LFUN_SERVER_GET_FILENAME.
  79
  80
  81 The following new LyX functions have been introduced:
  82
  83 - LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).
  84
  85 - LFUN_COMPLETION_INLINE, "completion-inline".
  86
  87 - LFUN_COMPLETION_POPUP, "completion-popup".
  88
  89 - LFUN_COMPLETION_COMPLETE, "complete".
  90
  91 - LFUN_CLOSE_TAB_GROUP, "close-tab-group".
  92
  93 - LFUN_SPLIT_VIEW, "split-view".
  94
  95 - LFUN_UI_TOGGLE, "ui-toggle".
  96
  97 - LFUN_SCROLL, "scroll".
  98
  99 - LFUN_MATH_MACRO, "math-macro".
 100
 101 - LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
 102
 103 - LFUN_MATH_MACRO_FOLD, "math-macro-fold".
 104
 105 - LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".
 106
 107 - LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param".
 108
 109 - LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
 110
 111 - LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
 112
 113 - LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
 114
 115 - LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".
 116
 117 - LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param".
 118
 119 - LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param".
 120
 121 - LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param".
 122
 123 - LFUN_WORD_LEFT, "word-left".
 124
 125 - LFUN_WORD_LEFT_SELECT, "word-left-select".
 126
 127 - LFUN_WORD_RIGHT, "word-right".
 128
 129 - LFUN_WORD_RIGHT_SELECT, "word-right-select".
 130
 131 - LFUN_CHAR_LEFT, "char-left".
 132
 133 - LFUN_CHAR_LEFT_SELECT, "char-left-select".
 134
 135 - LFUN_CHAR_RIGHT, "char-right".
 136
 137 - LFUN_CHAR_RIGHT_SELECT, "char-right-select".
 138
 139 - LFUN_FINISHED_FORWARD, "".
 140
 141 - LFUN_FINISHED_BACKWARD, "".
 142
 143 - LFUN_INFO_INSERT, "info-insert".
 144
 145 - LFUN_LAYOUT_RELOAD, "layout-reload".
 146
 147 - LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear".
 148
 149 - LFUN_LAYOUT_MODULE_ADD, "layout-module-add".
 150
 151 - LFUN_NEXT_INSET_MODIFY, "next-inset-modify"
 152
 153 - LFUN_INSET_EDIT, "inset-edit"
 154
 155 - LFUN_SET_GRAPHICS_GROUP, "set-graphics-group"
 156
 157 - LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify"
 158
 159 - LFUN_BRANCH_ACTIVATE, "branch-activate"
 160
 161 - LFUN_BRANCH_DEACTIVATE, "branch-deactivate"
 162   These can be used in export mode to turn branches on and off.
 163   Thus, something like:
 164     lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
 165   could be used to export a pdf with the answers branch included, without
 166   one's having to open LyX and activate the branch manually.
 167
 168 - LFUN_NOTES_MUTATE, "notes-mutate"
 169
 170 The following new LyX functions have been removed:
 171
 172 - LFUN_FILE_NEW.
 173
 174 - LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.
 175
 176 - LFUN_FONT_CODE.
 177
 178 - LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted
 179   via "space-insert hfill".
 180
 181 - LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 182
 183 - LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
 184
 185 - LFUN_SERVER_GET_FONT.
 186
 187 - LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT.
 188
 189 - LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT.
 190
 191 - LFUN_ACCENT_SPECIAL_CARON.
 192
 193 - LFUN_INSET_REFRESH.
 194
 195 - LFUN_BREAK_PARAGRAPH_SKIP, LFUN_DELETE_BACKWARD_SKIP, LFUN_DELETE_FORWARD_SKIP.
 196
 197 - LFUN_ERROR_NEXT.
 198
 199 - LFUN_MATH_IMPORT_SELECTION. Use LFUN_MATH_MODE instead.
 200
 201
 202 For the detailed description of LyX functions look into doxygen documentation.
 203
 204
 205 Known issues in version 1.6.0
 206 ------------------------------------
 207
 208 - ...
 209
 210
 211 Caveats when upgrading from earlier versions to 1.6.x
 212 -------------------------------------------------------
 213
 214 The support for Japanese has been improved in LyX 1.6.x. Due to encoding
 215 reasons, Japanese documents that were edited with LyX 1.6.x cannot correctly
 216 be converted to the format of LyX 1.5.x and thus not edited with LyX 1.5.x.
 217 To be able to use LyX 1.6 with Japanese, the latest version of the LaTeX
 218 distribution "platex" must be installed.
 219 platex provides a Japanese variant of BibTeX named "jbibtex". When LyX is
 220 configured, this variant is used. In case you have problems with BibTeX-files
 221 that include Japanese or you need to use another BibTeX program, set it in LyX
 222 preferences under Output->LaTeX->BibTeX command.
 223
 224
 225 Note: There may later be an updated list of known issues online at
 226         http://wiki.lyx.org/LyX/ReleaseNotes
 227