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