lyx_mirror/RELEASE-NOTES

This file lists interface changes that might affect users of 1.6.x, some 
known problems in LyX 1.6.1 and some things you have to take into account
when upgrading from earlier versions to a version of the 1.6.x series.
Note that fixes are available for some of these, but they have not yet
been applied because of incomplete testing.


Interface changes as of LyX 1.6.0
---------------------------------

The external template format recognize now a new tag: 'Preview'. This
tag is used to define how an external material should be previewed in
LyX. For more detail, see the 'external_templates' file in the resource
directory of LyX.

LyX 1.6.0 introduces support for the pLaTeX distribution which provides
extended language and script support for Japanese. The language
"Japanese" now uses this new method. Japanese support via the CJK
package is still available, but has been renamed to "Japanese (CJK)".
Old documents continue to use the CJK method.  Also cf. the "known
issues" section for some remaining problems.

Some of the LyX functions have changed names:

- A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the
  different LFUNs for single special characters:

  * LFUN_HYPHENATION_POINT_INSERT: removed. "hyphenation-point-insert" 
    has been replaced by "specialchar-insert hyphenation-point"
  * LFUN_LIGATURE_BREAK_INSERT: removed. "ligature-break-insert" 
    has been replaced by "specialchar-insert ligature-break"
  * LFUN_DOTS_INSERT: removed. "dots-insert" 
    has been replaced by "specialchar-insert dots"
  * LFUN_END_OF_SENTENCE_PERIOD_INSERT: removed.
    "end-of-sentence-period-insert" has been replaced by
    "specialchar-insert end-of-sentence"
  * LFUN_MENU_SEPARATOR_INSERT: removed. "menu-separator-insert" 
    has been replaced by "specialchar-insert menu-separator"

- The function LFUN_BREAK_LINE, "break-line" has been renamed to
  LFUN_NEWLINE_INSERT, "newline-insert", and it now allows two options:
  "newline-insert newline" inserts a \newline, "newline-insert linebreak"
  inserts a \linebreak.

- The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to
  LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions:

  * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by
    "newpage-insert pagebreak"

  * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by
    "newpage-insert clearpage"

  * LFUN_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced
    by "newpage-insert cleardoublepage"

- The function LFUN_WORDS_COUNT, "words-count", has been replaced by
  LFUN_STATISTICS, "statistics", which counts more than words.

- The function LFUN_MATH_NUMBER, "math-number", has been renamed to
  LFUN_MATH_NUMBER_TOGGLE.

- The function LFUN_MATH_NONUMBER, "math-nonumber", has been renamed to
  LFUN_MATH_NUMBER_LINE_TOGGLE.

- The function LFUN_CHARSTYLE_INSERT, "charstyle-insert", has been renamed to
  LFUN_FLEX_INSERT, "flex-insert". It now handles beside charstyles, also
  custom insets and XML short element insets.

- The function LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR,
  "toggle-cursor-follows-scrollbar"
  has been renamed to LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE,
  "cursor-follows-scrollbar-toggle".

- The function LFUN_FONT_CODE, "font-code", has been renamed to
  LFUN_FONT_TYPEWRITER, "font-typewriter".

- The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT,
  "url-insert" was superseded by LFUN_HYPERLINK_INSERT, "href-insert".

- The function LFUN_FLOAT_LIST has been renamed to LFUN_FLOAT_LIST_INSERT.

- The functions delete-back/forward has been renamed to
  char-delete-back/forward.

- The functions LFUN_FONT_FREE_APPLY/UPDATE has been renamed to
  LFUN_TEXTSTYLE_APPLY/UPDATE.

- The functions LFUN_SERVER_GET_NAME has been renamed to
  LFUN_SERVER_GET_FILENAME.


The following new LyX functions have been introduced:

- LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).

- LFUN_COMPLETION_INLINE, "completion-inline".

- LFUN_COMPLETION_POPUP, "completion-popup".

- LFUN_COMPLETION_COMPLETE, "complete".

- LFUN_COMPLETION_CANCEL, "completion-cancel"

- LFUN_COMPLETION_ACCEPT, "completion-accept"

- LFUN_CLOSE_TAB_GROUP, "close-tab-group".

- LFUN_SPLIT_VIEW, "split-view".

- LFUN_UI_TOGGLE, "ui-toggle".

- LFUN_SCROLL, "scroll".

- LFUN_MATH_MACRO, "math-macro".

- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".

- LFUN_MATH_MACRO_FOLD, "math-macro-fold".

- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".

- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param".

- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".

- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".

- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".

- LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".

- LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param".

- LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param".

- LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param".

- LFUN_WORD_LEFT, "word-left".

- LFUN_WORD_LEFT_SELECT, "word-left-select".

- LFUN_WORD_RIGHT, "word-right".

- LFUN_WORD_RIGHT_SELECT, "word-right-select".

- LFUN_CHAR_LEFT, "char-left".

- LFUN_CHAR_LEFT_SELECT, "char-left-select".

- LFUN_CHAR_RIGHT, "char-right".

- LFUN_CHAR_RIGHT_SELECT, "char-right-select".

- LFUN_FINISHED_FORWARD, "".

- LFUN_FINISHED_BACKWARD, "".

- LFUN_INFO_INSERT, "info-insert".

- LFUN_LAYOUT_RELOAD, "layout-reload".

- LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear".

- LFUN_LAYOUT_MODULE_ADD, "layout-module-add".

- LFUN_NEXT_INSET_MODIFY, "next-inset-modify"

- LFUN_INSET_EDIT, "inset-edit"

- LFUN_SET_GRAPHICS_GROUP, "set-graphics-group"

- LFUN_BRANCH_ACTIVATE, "branch-activate"

- LFUN_BRANCH_DEACTIVATE, "branch-deactivate" 
  These can be used in export mode to turn branches on and off. 
  Thus, something like:
    lyx -e pdf2 -x "branch-activate answers" finalexam.lyx
  could be used to export a pdf with the answers branch included, without 
  one's having to open LyX and activate the branch manually.

- LFUN_NOTES_MUTATE, "notes-mutate"

- LFUN_FONT_BOLDSYMBOL, "font-boldsymbol"
  This is the same as LFUN_FONT_BOLD except that in math mode \boldsymbol
  is used instead of \mathbf.

- LFUN_COMMAND_ALTERNATIVES, "command-alternatives"
  This works similarly to command-sequence, except that instead of running
  each of the commands, it only runs the first one that is enabled. This can
  be used to bind multiple functions to a single key, and then which one is
  used will depend upon the context.


The following LyX functions have been removed:

- LFUN_FILE_NEW.

- LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.

- LFUN_FONT_CODE.

- LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted
  via "space-insert hfill".

- LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).

- LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).

- LFUN_SERVER_GET_FONT.

- LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT.

- LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT.

- LFUN_ACCENT_SPECIAL_CARON.

- LFUN_INSET_REFRESH.

- LFUN_BREAK_PARAGRAPH_SKIP, LFUN_DELETE_BACKWARD_SKIP, LFUN_DELETE_FORWARD_SKIP.

- LFUN_ERROR_NEXT.

- LFUN_MATH_IMPORT_SELECTION. Use LFUN_MATH_MODE instead.

- LFUN_BIBITEM_INSERT.

For the detailed description of LyX functions look under the Help menu.


Known issues in version 1.6.x
------------------------------------

- New pLaTeX support for Japanese:
  * Documents using this method can be backported to 1.5 in principal, but
    the backported documents are not guaranteed to work, since 1.5 falls
    back to the CJK package; expect the output to differ.


Caveats when upgrading from earlier versions to 1.6.x
-------------------------------------------------------

- Since several lyx functions have been renamed (see above), old
  configuration files (*.ui, *.bind) may no longer work. If some
  functions (such as Shift-right for selecting text) fail to work
  after the upgrade from previous versions, make sure you do not
  have any old configuration files in your LyX user directory, or
  adapt these files to the new functions. If anything else fails,
  try if deleting your LyX user directory helps.


Note: There may later be an updated list of known issues online at
	http://wiki.lyx.org/LyX/ReleaseNotes