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