-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.1.0, some
+known problems in LyX 2.1.0 and some things you have to take into account
+when upgrading from earlier versions to a version of the 2.1.x series.
Interface changes
-----------------
-Some of the LyX functions have changed names:
+- There have been changes to some often used menu items.
-- A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the
- different LFUNs for single special characters:
+ The following menu items moved from View to Document:
+ * View (Default format)
+ * View (Other formats)
+ * Update (Default format)
+ * Update (Other formats)
- * 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 menu item moved from Document to View:
+ * Outline -> Outline Pane
-- 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.
+- Whenever the user closes a (tabbed) view on a document, either by
+ clicking on the tab close button, or by using the File->Close menu,
+ LyX now closes exclusively that specific view. If there are other
+ views showing the same document, they are not closed. When the user
+ closes the last view, LyX can be configured for either closing the
+ document, or keeping it in memory as a hidden document (that can be
+ shown again through the View->Hidden-> submenu).
-- The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to
- LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions:
+ A new configurable preference option has been added, allowing for
+ either (close_buffer_with_last_view).
- * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by
- "newpage-insert pagebreak"
+- There have been some changes to the LyX command line. The following
+ new options have been added:
- * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by
- "newpage-insert clearpage"
+ --export-to <format> <dest> (-E <format> <dest>)
- * LFUN_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced
- by "newpage-insert cleardoublepage"
+ Allows one to perform a batch export of the LyX file that is
+ opened to the specified destination file <dest> and format
+ <format>. For example, to create a PDF of a LyX document,
+ you can run:
+ lyx --export-to pdf /path/to/dest.pdf /path/to/source.lyx
+ See the manual page for details.
-- The function LFUN_WORDS_COUNT, "words-count", has been replaced by
- LFUN_STATISTICS, "statistics", which counts more than words.
+ This functionality is also available via a new menu voice
+ Export->Export As..., that pops up a dialog allowing one to
+ choose the export format, as well as the destination pathname.
+ Also, it is available via the mini-buffer (or the -x switch)
+ through a proper new LFUN (see below).
-- The function LFUN_MATH_NUMBER, "math-number", has been renamed to
- LFUN_MATH_NUMBER_TOGGLE.
+- The Advanced Find and Replace feature now supports cancel of a
+ long search operation by hitting the ESC key.
-- The function LFUN_MATH_NONUMBER, "math-nonumber", has been renamed to
- LFUN_MATH_NUMBER_LINE_TOGGLE.
+- The format pdf aka "PDF (ps2pdf)" was split in two formats: pdf aka
+ "PDF (ps2pdf)" and pdf6 aka "PDF (graphics)". pdf6 is used for PDF
+ files included as graphics. Custom external templates and converters
+ might need to be adjusted. The format split was needed since otherwise
+ an odt->pdf converter which is intended for included graphics only
+ did interfere with document export via ps2pdf.
-- 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 support for ArmTeX (a special typesetting engine for Armenian)
+ was removed. Writing text in Armenian is now possible in a native
+ way using XeTeX.
-- 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 following pref variables were added in 2.1:
-- The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, "url-insert" was
- superseded by LFUN_HYPERLINK_INSERT, "href-insert".
+- \\close_buffer_with_last_view [yes|no|ask]
+ When the user closes the last view on a document, close the
+ document as well ("yes"), or hide the document ("no"), or ask
+ the user ("ask").
+- \\completion_minlength
+ Defines the minimal length of a word to be added to the list of
+ words for text completion.
-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".
+- \\default_length_unit
+ Defines the default length unit: 2 for centimers, 6 for inches.
-- LFUN_COMPLETION_COMPLETE, "complete".
+- \\default_otf_view_format
+ Defines the default output format for documents with non-tex
+ fonts (OpenType fonts).
-- LFUN_CLOSE_TAB_GROUP, "close-tab-group".
+- \\fullscreen_statusbar
+ Controls whether the statusbar is shown in fullscreen mode.
-- LFUN_SPLIT_VIEW, "split-view".
+- \\texinputs_prefix
+ Defines the prefix for the TEXINPUTS environment variable. A
+ single '.' in the paths will get replaced with the current
+ document dir and also non-absolute paths will be prefixed with
+ that dir.
-- LFUN_UI_TOGGLE, "ui-toggle".
+ The default semantics of TEXINPUTS apply, such that, for example,
+ if a path is terminated with a double slash, all subdirectories
+ will also be searched by both the TeX engine and ancillary programs
+ such as dvi previewers or dvips.
-- LFUN_SCROLL, "scroll".
+ (see also commit 1717ef20)
-- LFUN_MATH_MACRO, "math-macro".
+- \\use_qimage
+ See Caveats section below.
-- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
+- \\use_system_theme_icons
+ If set to true, LyX tries to use the theme icons as defined by
+ the OS.
-- LFUN_MATH_MACRO_FOLD, "math-macro-fold".
-- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".
+The following pref variables were changed in 2.1:
-- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param".
+- \\mac_like_word_movement -> \\mac_like_cursor_movement
+ When this option is set, the cursor is now moved to the end of
+ the current paragraph on paragraph-down. The pref variable was
+ renamed to better reflect this new behaviour.
-- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
-- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
+The following pref variables are obsoleted in 2.1:
-- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
+- \\default_language and \\default_papersize
+ To set the default language and paper size for new documents, use
+ the "Save As Document Defaults" button in Document > Settings.
-- 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".
+The following new LyX functions have been introduced:
-- LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param".
+- ipa-insert
+ Inserts an IPA (International Phonetic Alphabet) inset.
-- LFUN_WORD_LEFT, "word-left".
+- ipamacro-insert <char>
+ Inserts special IPA macros into the document. <char> can be
+ one of 'tone-falling', 'tone-rising', 'tone-high-rising',
+ 'tone-low-rising', 'tone-high-rising-falling', 'deco bottomtiebar',
+ 'deco toptiebar'.
-- LFUN_WORD_LEFT_SELECT, "word-left-select".
+- spelling-continuously
+ Toggles continuous spell-checking.
-- LFUN_WORD_RIGHT, "word-right".
+- vc-rename
+- vc-copy
+ Renames or copies a file under version control.
-- LFUN_WORD_RIGHT_SELECT, "word-right-select".
+- buffer-forall <command>
+ Applies <command> to all non-hidden buffers.
-- LFUN_CHAR_LEFT, "char-left".
+- environment-split
+ Splits the current environment with a Separator.
-- LFUN_CHAR_LEFT_SELECT, "char-left-select".
+- branch-master-activate <branch>
+- branch-master-deactivate <branch>
+ Activates or deactivates a branch in a master document from within
+ a child (as opposed to the existing branch-[de]activate, which
+ toggle the branch in the document itself).
-- LFUN_CHAR_RIGHT, "char-right".
+- buffer-export-as <format> <filename>
+ Equivalent to the new -export-to command-line switch (see above).
-- LFUN_CHAR_RIGHT_SELECT, "char-right-select".
+- clipboard-paste-simple
+ Paste the clipboard contents as simple unformatted text.
+ This is also available through a new menu voice within the
+ [Edit]->[Paste Special...] sub-menu.
-- LFUN_FINISHED_FORWARD, "".
+- view-close
+ Close the current document view only, if there are no more views
+ on the document, either close or hide it (see the new preference
+ option \\close_buffer_with_last_view)
-- LFUN_FINISHED_BACKWARD, "".
-- LFUN_BUFFER_TOGGLE_EMBEDDING, "buffer-toggle-embedding".
+The following LyX functions have been changed:
-- LFUN_INFO_INSERT, "info-insert".
+- close-tab-group was renamed to tab-group-close.
-- LFUN_LAYOUT_RELOAD, "layout-reload".
+- split-view was renamed to view-split.
-- LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear".
+- break-paragraph was renamed to paragraph-break.
-- LFUN_LAYOUT_MODULE_ADD, "layout-module-add".
+- copy-label-as-reference was renamed to label-copy-as-reference.
-- LFUN_NEXT_INSET_MODIFY, "next-inset-modify"
-- LFUN_INSET_EDIT, "inset-edit"
+The following LyX key bindings have been changed:
+- The binding "C-w" was moved from "buffer-close" to "view-close"
+ (only in cua.bind).
-The following new LyX functions have been removed:
+- sciword.bind was changed significantly (see #8364). The most important
+ change is that "math-delim" commands now work under Windows.
-- LFUN_FILE_NEW.
+The following LyX documents have been moved:
-- LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.
+- 'AEA', 'JASA', 'springer', 'ACM-siggraph', and 'thesis' have been moved
+ from templates to examples (see #8643).
-- LFUN_FONT_CODE.
-- LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted
- via "space-insert hfill".
+The following metadata files have been added to the tarball:
-- LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
+- Linux desktop file specification and scalable icon has been
+ included in the tarball.
-- LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
+- AppData file (appdata.xml). It will not be installed by default and
+ distribution maintainers need to handle this file themselves.
-- LFUN_SERVER_GET_FONT.
-- LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT.
+Changes with respect to external programs and libraries:
+--------------------------------------------------------
-- LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT.
+- LyX now links against libmagic (http://www.darwinsys.com/file/) if it is
+ available at compile time. This improves the file format detection of
+ included graphics and other files. The old builtin format detection code
+ is used if libmagic is not available.
-For the detailed description of LyX functions look into doxygen documentation.
+- LyX no longer uses gettext for handling the translation files. This
+ especially is an advantage on Windows, where translating strings is faster.
-Known issues in version 1.6.0
-------------------------------------
+Known issues in version 2.1.0
+-----------------------------
-- ...
+- 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.
-Caveats when upgrading from earlier versions to 1.6.x
+Caveats when upgrading from earlier versions to 2.1.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
+- In order to improve reported scrolling slowness, we changed the way
+ screen painting is done. This, however, can slow down the performance
+ on remote X connections and we provide the \\use_qimage preference
+ variable, which brings back the old way of painting (when set to false).