-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_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"
+The following pref variables were changed in 2.2:
- * 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 following pref variables are obsoleted in 2.2:
-- The function LFUN_MATH_NUMBER, "math-number", has been renamed to
- LFUN_MATH_NUMBER_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_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 new LyX functions have been introduced 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".
+- buffer-view-cache
+ Opens the last previewed output of the buffer, if it exists.
-- The function LFUN_FONT_CODE, "font-code", has been renamed to
- LFUN_FONT_TYPEWRITER, "font-typewriter".
+- buffer-move-next
+ Moves the current tab one spot to the right.
-- The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, "url-insert" was
- superseded by LFUN_HYPERLINK_INSERT, "href-insert".
+- buffer-move-previous
+ Moves the current tab one spot to the left.
-The following new LyX functions have been introduced:
+The following LyX functions have been changed in 2.2:
-- LFUN_SPECIALCHAR_INSERT, "specialchar-insert" (see above).
-- LFUN_COMPLETION_INLINE, "completion-inline".
-- LFUN_COMPLETION_POPUP, "completion-popup".
+The following LyX key bindings have been changed in 2.2:
-- LFUN_COMPLETION_COMPLETE, "complete".
+- 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_CLOSE_TAB_GROUP, "close-tab-group".
-- LFUN_SPLIT_VIEW, "split-view".
+The following LyX documents have been moved in 2.2:
-- LFUN_UI_TOGGLE, "ui-toggle".
-- LFUN_SCROLL, "scroll".
-- LFUN_MATH_MACRO, "math-macro".
+The following metadata files have been added to the tarball in 2.2:
-- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
-- LFUN_MATH_MACRO_FOLD, "math-macro-fold".
-- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".
+Changes with respect to external programs and libraries in 2.2:
+--------------------------------------------------------
-- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-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_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
+- LyX now gives an error if the underlying LaTeX command exited with error.
-- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
-- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
+Known issues in version 2.2.0
+-----------------------------
-- LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".
+- 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_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).
-
-- LFUN_SERVER_GET_FONT.
-
-For the detailed description of LyX functions look into doxygen documentation.
-
-
-Known issues in version 1.6.0
-------------------------------------
-
-- ...
-
-
-Caveats when upgrading from earlier versions to 1.6.x
+Caveats when upgrading from earlier versions to 2.2.x
-------------------------------------------------------
-The support for Japanese has been improved in LyX 1.6.x. Due to encoding
-reasons, Japanese documents that were edited with LyX 1.6.x cannot correctly
-be converted to the format of LyX 1.5.x and thus not edited with LyX 1.5.x.
-To be able to use LyX 1.6 with Japanese, the latest version of the LaTeX
-distribution "platex" must be installed.
-platex provides a Japanese variant of BibTeX named "jbibtex". When LyX is
-configured, this variant is used. In case you have problems with BibTeX-files
-that include Japanese or you need to use another BibTeX program, set it in LyX
-preferences under Output->LaTeX->BibTeX command.
-
-
-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.