lyx_mirror/RELEASE-NOTES

This file lists interface changes that might affect users in 1.6.0, some 
known problems in LyX 1.6.0 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
-----------------

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_NEW_LINE,
  "new-line".

- 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 following new LyX functions have been introduced:

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

- LFUN_LINE_BREAK, "line-break".

- LFUN_COMPLETION_INLINE, "completion-inline".

- LFUN_COMPLETION_POPUP, "completion-popup".

- LFUN_COMPLETION_COMPLETE, "complete".

- 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_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding".

- 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"


The following new 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).


For the detailed description of LyX functions look into doxygen documentation.


Known issues in version 1.5.2
------------------------------------

- Cursor restoration problems with Multiple-View:
  When using multiple Windows to edit different parts of the
  same document, the cursor position is sometimes not correctly restored
  when you switch from one view to the other.

- RTL and keymaps:
  Currently there is a bug where you can't use two non-RTL language keymaps if
  the RTL preference is set (which is now the default). If you need to use two
  non-RTL keymaps, for now you should just turn off the RTL preference (Tools -> 
  Preferences... -> Language settings -> Language, uncheck "Right-to-left
  language support").
  We hope to offer more comprehensive support for multiple keymaps in the future,
  which will solve this bug, as well as allow more than just two keymaps. If you 
  have any input on this issue, please chime in on the developers mailing list,
  or add your comments to http://bugzilla.lyx.org/show_bug.cgi?id=4051.


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

Due to the change to Unicode, there are some general things you'll have to take care
about when upgrading from an older version to LyX 1.5.0 or newer. Please refer to the
file UPGRADING for details.


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