-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.
+This file lists interface changes that might affect users in 2.2.0, some
+known problems in LyX 2.2.0 and some things you have to take into account
+when upgrading from earlier versions to a version of the 2.2.x series.
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 following pref variables were added in 2.2:
-- 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".
-- The function LFUN_WORDS_COUNT, "words-count", has been replaced by
- LFUN_STATISTICS, "statistics", which counts more than words.
+The following pref variables were changed in 2.2:
-- 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 following pref variables are obsoleted in 2.2:
-- The function LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, "toggle-cursor-follows-scrollbar"
- has been renamed to LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE,
- "cursor-follows-scrollbar-toggle".
+- \\rtl
+ This variable was introduced to guard against any bad consequence of
+ the then-new right-to-left languages support. It is no longer needed
+ because of improvements. Now right-to-left support is always enabled.
-- 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 in 2.2:
+- buffer-view-cache
+ Opens the last previewed output of the buffer, if it exists.
-The following new LyX functions have been introduced:
+- buffer-move-next
+ Moves the current tab one spot to the right.
-- LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).
+- buffer-move-previous
+ Moves the current tab one spot to the left.
-- LFUN_LINE_BREAK, "line-break".
-- LFUN_PAGEBREAK_INSERT, "pagebreak-insert".
+The following LyX functions have been changed in 2.2:
-- LFUN_COMPLETION_INLINE, "completion-inline".
-- LFUN_COMPLETION_POPUP, "completion-popup".
-- LFUN_COMPLETION_COMPLETE, "complete".
+The following LyX key bindings have been changed in 2.2:
-- LFUN_CLOSE_TAB_GROUP, "close-tab-group".
+- For bindings where Control + {PgDn, PgUp} switches to the
+ {next, previous} tab, Control + Shift + {PgDn, PgUp} moves the current
+ tab to the {next, previous} tab.
-- LFUN_SPLIT_VIEW, "split-view".
-- LFUN_UI_TOGGLE, "ui-toggle".
+The following LyX documents have been moved in 2.2:
-- LFUN_SCROLL, "scroll".
-- LFUN_MATH_MACRO, "math-macro".
-- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
+The following metadata files have been added to the tarball in 2.2:
-- 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".
+Changes with respect to external programs and libraries in 2.2:
+--------------------------------------------------------
-- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
+- LyX is not yet supposed to work with Qt5. It is advised to compile and
+ run LyX against Qt 4.8.x. On Windows, Qt 4.8.5 suffers from a bug that
+ breaks the use of shortcuts, so on Windows Qt 4.8.4 is advised.
-- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
+- LyX now gives an error if the underlying LaTeX command exited with error.
-- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
-- LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".
+Known issues in version 2.2.0
+-----------------------------
-- LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param".
+- LyX needs to be run under Python 2 and will not work properly on systems
+ where Python 3 is the default binary. See bug #7030 to know how to fix
+ this properly, since simple sheebang conversion in *.py files will not
+ be enough.
-- 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".
-
-
-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".
-
-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
+Caveats when upgrading from earlier versions to 2.2.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
-
+- BibTeX errors are now processed and cause LyX to show the errors dialog.
+ Before, these errors were ignored, which means that it may happen that
+ documents that compiled without error with a previous version now
+ compile with error. However, because now in 2.2.x users can click on
+ the "Show Output Anyway" button, the document can still be viewed.