-This file lists interface changes that might affect users in 2.0.0, some
-known problems in LyX 2.0.0 and some things you have to take into account
-when upgrading from earlier versions to a version of the 2.0.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
-----------------
-There have been some changes to the LyX command line. There is a new option
-"--batch" that causes LyX to run the given commands without opening a GUI
-window. Thus, something like:
- lyx --batch -x "buffer-print printer default dvips" myfile.lyx
-will cause LyX to print myfile.lyx to the default printer, using dvips and
-the default print settings (which, of course, have to have been configured
-already). At present, not many commands can be used this way, but there will
-be more eventually.
+- There have been changes to some often used menu items.
-The following variables are obsoleted in 2.0
+ The following menu items moved from View to Document:
+ * View (Default format)
+ * View (Other formats)
+ * Update (Default format)
+ * Update (Other formats)
-- \plaintext_roff_command (was not used anymore)
+ The following menu item moved from Document to View:
+ * Outline -> Outline Pane
-- \personal_dictionary, \spell_command, \use_input_encoding,
- \use_personal_dictionary and \use_spell_lib (ispell support has been
- removed)
+- 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).
-- \spellchecker_use_alt_lang and \use_escape_chars (actually not used
- by the UI, and it is as simple to check whether the relevant
- variable is empty)
+ A new configurable preference option has been added, allowing for
+ either (close_buffer_with_last_view).
-- \custom_export_command and \custom_export_format
+- There have been some changes to the LyX command line. The following
+ new options have been added:
+ --export-to <format> <dest> (-E <format> <dest>)
-The following new LyX functions have been introduced:
+ 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.
+
+ 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).
-- LFUN_WORD_FINDAD ("word-findadv").
+- The Advanced Find and Replace feature now supports cancel of a
+ long search operation by hitting the ESC key.
-- LFUN_REGEXP_MODE ("regexp-mode").
+- 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.
-- LFUN_PHANTOM_INSERT ("phantom-insert").
+- 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.
-- LFUN_INSET_BEGIN ("inset-begin").
-- LFUN_INSET_END (""inset-end"").
+The following pref variables were added in 2.1:
-- LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
+- \\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").
-- LFUN_INSET_END_SELECT ("inset-end-select").
+- \\completion_minlength
+ Defines the minimal length of a word to be added to the list of
+ words for text completion.
-- LFUN_CHANGE_PREVIOUS ("change-previous").
+- \\default_length_unit
+ Defines the default length unit: 2 for centimers, 6 for inches.
-- LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
+- \\default_otf_view_format
+ Defines the default output format for documents with non-tex
+ fonts (OpenType fonts).
-- LFUN_SECTION_SELECT ("section-select").
+- \\fullscreen_statusbar
+ Controls whether the statusbar is shown in fullscreen mode.
-- LFUN_FONT_UNDERLINE ("font-underline").
+- \\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_FONT_STRIKEOUT ("font-strikeout").
+ 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_FONT_UULINE ("font-underunderline").
+ (see also commit 1717ef20)
-- LFUN_FONT_UWAVE ("font-underwave").
+- \\use_qimage
+ See Caveats section below.
-- LFUN_BRANCHES_RENAME ("branches-rename").
+- \\use_system_theme_icons
+ If set to true, LyX tries to use the theme icons as defined by
+ the OS.
-- LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
-- LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
+The following pref variables were changed in 2.1:
-- LFUN_INSET_FORALL ("inset-forall").
+- \\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_DEBUG_LEVEL_SET ("debug-level-set").
-- LFUN_INSET_SELECT_ALL ("inset-select-all").
+The following pref variables are obsoleted in 2.1:
-- LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
+- \\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_VC_COMPARE ("vc-compare").
-- LFUN_SPELLING_ADD ("spelling-add").
+The following new LyX functions have been introduced:
+
+- ipa-insert
+ Inserts an IPA (International Phonetic Alphabet) inset.
-- LFUN_SPELLING_IGNORE ("spelling-ignore").
+- 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'.
+- spelling-continuously
+ Toggles continuous spell-checking.
-The following LyX functions have been removed:
+- vc-rename
+- vc-copy
+ Renames or copies a file under version control.
-- LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
+- buffer-forall <command>
+ Applies <command> to all non-hidden buffers.
-- LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
+- environment-split
+ Splits the current environment with a Separator.
-- LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
+- 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_NOTES_MUTATE ("notes-mutate"): replace
- notes-mutate <SOURCE> <TARGET>
- with the more general function inset-forall
- inset-forall Note:<SOURCE> inset-modify note Note <TARGET>
+- buffer-export-as <format> <filename>
+ Equivalent to the new -export-to command-line switch (see above).
-- LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
+- 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.
+
+- 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)
The following LyX functions have been changed:
-- LFUN_INSET_TOGGLE ("inset-toggle"): For some insets, this function was used
- to show the settings dialog. This is no longer possible and one should use
- inset-settings for this purpose.
-
-- LFUN_WORD_REPLACE ("word-replace"): The replacement and searched strings
- arguments have been inverted in order to allow the replacement of the word
- at current cursor position, even if it is not selected.
-
-
-New external programs and libaries:
------------------------------------
-
-LyX 2.0 introduces support for some new external helper programs/libraries,
-while the support for some existing programs has been dropped. This
-particularly applies to spell checking and the thesaurus.
-
-1.) SPELLCHECKING:
-
-* Direct support for ispell and hspell has been dropped. However, ispell
- and hspell are still accessible via the enchant wrapper (see below).
-
-* Support for the aspell command line program has been dropped. Note that
- the aspell library (aspell 0.60.x) is still supported.
-
-* Next to aspell (library), LyX now also supports hunspell (the spell
- checker used by OpenOffice and Firefox) and enchant, a wrapper that
- provides automatic access to many spell checking libraries (ispell,
- aspell, hspell, hunspell, etc.).
-
-LyX 2.0 is configured for any and multiple of these three possibilities,
-given that they are installed on the machine where LyX is configured on.
-The actual spell checker can be selected in Tools > Preferences.
-Packagers are advised to pre-select whatever is most common on their
-platform/distribution.
-
-2.) THESAURUS:
-
-* Support for the aiksaurus library has been dropped in favour of the
- MyThes thesaurus library (the thesaurus library used by OpenOffice).
-
-* LyX ships the MyThes library itself, so contrary to LyX 1.6.x, no
- extra thesaurus library needs to be installed. However, LyX does not
- ship any thesaurus dictionary.
-
-* The OpenOffice thesaurus dictionaries can be used, but the path to those
- dictionary needs to be set in Tools > Preferences. Please refer to the
- UserGuide, sec. 6.13, for further instructions.
-
-Packagers are advised to preset the thesaurus for their distribution/
-platform. Packagers of installation bundles (on Windows and the Mac)
-are advised to provide automatic installation of thesaurus disctionaries
-in the installation process (analoguous to the spellchecker installation).
-
-
-Known issues in version 2.0.0
------------------------------
+- close-tab-group was renamed to tab-group-close.
+- split-view was renamed to view-split.
-Caveats when upgrading from earlier versions to 2.0.x
--------------------------------------------------------
+- break-paragraph was renamed to paragraph-break.
+
+- copy-label-as-reference was renamed to label-copy-as-reference.
+
+
+The following LyX key bindings have been changed:
+
+- The binding "C-w" was moved from "buffer-close" to "view-close"
+ (only in cua.bind).
+
+- sciword.bind was changed significantly (see #8364). The most important
+ change is that "math-delim" commands now work under Windows.
+
+The following LyX documents have been moved:
+- All thesis template files and the svmult and svmono template files have been
+ moved to the examples folder.
+The following metadata files have been added to the tarball:
-Note: There may later be an updated list of known issues online at
- http://wiki.lyx.org/LyX/ReleaseNotes
+- Linux desktop file specification and scalable icon has been
+ included in the tarball.
+
+- AppData file (appdata.xml). It will not be installed by default and
+ distribution maintainers need to handle this file themselves.
+
+
+Changes with respect to external programs and libraries:
+--------------------------------------------------------
+
+- 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.
+
+- LyX no longer uses gettext for handling the translation files. This
+ especially is an advantage on Windows, where translating strings is faster.
+
+- 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.
+
+
+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 2.1.x
+-------------------------------------------------------
-TODO
-----
-- Somebody should create a rc2rc script...
- http://www.lyx.org/trac/changeset/27531
-
-- some summary about 3rd party programs additions/removals should be
- written for packagers (eg aiksauraus, libtool).
+- 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).
projects / lyx.git / blobdiff