X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=RELEASE-NOTES;h=f680014257abe69eeea76304eda51afef3d41296;hb=6fdb32958c6f0e7397455734c207790468c2da6c;hp=a06afb54c1a4cb969751f87c373ecb6f86071fb7;hpb=0489d3c496c0a7d5de3d490e1da7541cd5a9d9c8;p=lyx.git diff --git a/RELEASE-NOTES b/RELEASE-NOTES index a06afb54c1..f680014257 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -1,237 +1,218 @@ -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. -A bash completion script was added to the tarball. + The following menu items moved from View to Document: + * View (Default format) + * View (Other formats) + * Update (Default format) + * Update (Other formats) -We have introduced a new flag to decide whether or not a given "document" -format shall be listed in the File > Export menu. This was necessary since -this menu got too large. If the flag "menu=export" is not explicitly set, -the formats are not included in the menu. This means that you might need -to click "Show in export menu" in Preferences > File Formats for your -customized file formats if you want them to appear in the menu. -Note, though, that you still can export to any possible format via -File > Export > More Formats and Options ... + The following menu item moved from Document to View: + * Outline -> Outline Pane -The following pref variables were changed in 2.0: +- 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). -- \language_package was renamed to \language_custom_package + A new configurable preference option has been added, allowing for + either (close_buffer_with_last_view). -- \language_use_babel (bool) has been replaced by - \language_package_selection, which can be - 0 (automatic selection) - 1 (always use babel) - 2 custom (use the custom package defined by - \language_custom_package) - 3 none (equivalent to former \language_use_babel false) +- There have been some changes to the LyX command line. The following + new options have been added: -The following pref variables are obsoleted in 2.0: + --export-to (-E ) -- \plaintext_roff_command (was not used anymore) + Allows one to perform a batch export of the LyX file that is + opened to the specified destination file and 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. -- \personal_dictionary, \spell_command, \use_input_encoding, - \use_personal_dictionary and \use_spell_lib (ispell support has been - removed) + 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). -- \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) +- The Advanced Find and Replace feature now supports cancel of a + long search operation by hitting the ESC key. -- \custom_export_command and \custom_export_format +- 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 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 following new LyX functions have been introduced: - -- LFUN_WORD_FINDAD ("word-findadv"). - -- LFUN_REGEXP_MODE ("regexp-mode"). - -- LFUN_PHANTOM_INSERT ("phantom-insert"). - -- LFUN_INSET_BEGIN ("inset-begin"). - -- LFUN_INSET_END (""inset-end""). - -- LFUN_INSET_BEGIN_SELECT ("inset-begin-select"). - -- LFUN_INSET_END_SELECT ("inset-end-select"). - -- LFUN_CHANGE_PREVIOUS ("change-previous"). -- LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference"). +The following pref variables were added in 2.1: -- LFUN_SECTION_SELECT ("section-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_FONT_UNDERLINE ("font-underline"). +- \\completion_minlength + Defines the minimal length of a word to be added to the list of + words for text completion. -- LFUN_FONT_STRIKEOUT ("font-strikeout"). +- \\default_length_unit + Defines the default length unit: 2 for centimers, 6 for inches. -- LFUN_FONT_UULINE ("font-underunderline"). +- \\default_otf_view_format + Defines the default output format for documents with non-tex + fonts (OpenType fonts). -- LFUN_FONT_UWAVE ("font-underwave"). +- \\fullscreen_statusbar + Controls whether the statusbar is shown in fullscreen mode. -- LFUN_BRANCHES_RENAME ("branches-rename"). +- \\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_BRANCH_ADD_INSERT ("branch-add-insert"). + 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_BUFFER_CLOSE_ALL ("buffer-close-all"). + (see also commit 1717ef20) -- LFUN_INSET_FORALL ("inset-forall"). +- \\use_qimage + See Caveats section below. -- LFUN_DEBUG_LEVEL_SET ("debug-level-set"). +- \\use_system_theme_icons + If set to true, LyX tries to use the theme icons as defined by + the OS. -- LFUN_INSET_SELECT_ALL ("inset-select-all"). -- LFUN_MATH_AMS_MATRIX ("math-ams-matrix"). +The following pref variables were changed in 2.1: -- LFUN_VC_COMPARE ("vc-compare"). +- \\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_SPELLING_ADD ("spelling-add"). -- LFUN_SPELLING_IGNORE ("spelling-ignore"). +The following pref variables are obsoleted in 2.1: -- LFUN_SPELLING_REMOVE ("spelling-remove"). +- \\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_PREVIEW_INSERT ("preview-insert"). -- LFUN_FORWARD_SEARCH ("forward-search"). - -- LFUN_INSET_COPY_AS ("inset-copy-as"). - -- LFUN_BUFFER_TOGGLE_OUTPUT_SYNC ("buffer-toggle-output-sync"). +The following new LyX functions have been introduced: +- ipa-insert + Inserts an IPA (International Phonetic Alphabet) inset. -The following LyX functions have been removed: +- ipamacro-insert + Inserts special IPA macros into the document. can be + one of 'tone-falling', 'tone-rising', 'tone-high-rising', + 'tone-low-rising', 'tone-high-rising-falling', 'deco bottomtiebar', + 'deco toptiebar'. -- LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead. +- spelling-continuously + Toggles continuous spell-checking. -- LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead. +- vc-rename +- vc-copy + Renames or copies a file under version control. -- LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead. +- buffer-forall + Applies to all non-hidden buffers. -- LFUN_NOTES_MUTATE ("notes-mutate"): replace - notes-mutate - with the more general function inset-forall - inset-forall Note: inset-modify note Note +- environment-split + Splits the current environment with a Separator. -- LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace - all-insets-toggle - all-insets-toggle - with the more generic function inset-forall - inset-forall inset-toggle - inset-forall * inset-toggle - There is a difference in the parameter, which is would be - like "note" in the first case and "Note" in the second. +- branch-master-activate +- branch-master-deactivate + 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_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead. - I.e., "tabular-feature FEATURE " becomes: - inset-modify tabular FEATURE +- buffer-export-as + Equivalent to the new -export-to command-line switch (see above). -- LFUN_LINE_INSERT ("line-insert"): use "inset-insert line" instead. For - something close to the previous default, use: - inset-insert line rule height 0.25ex width 100col% \\end_inset - This is necessary because the line inset now takes various arguments. +- 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_TOC_INSERT ("toc-insert"): use "inset-insert toc" instead. +- 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. +- close-tab-group was renamed to tab-group-close. -- LFUN_OPTIONAL_INSERT ("optional-insert") has been renamed LFUN_ARGUMENT_INSERT - ("argument-insert"). +- split-view was renamed to view-split. +- break-paragraph was renamed to paragraph-break. -The following LyX key bindings have been changed: - -- LFUN_MATH_MACRO_FOLD ("math-macro-fold") - The binding to "C-minus" has changed to "C-S-underscore". +- copy-label-as-reference was renamed to label-copy-as-reference. -- LFUN_MATH_MACRO_UNFOLD ("math-macro-unfold") - The binding to "C-plus" has changed to "C-S-asterisk". +The following LyX key bindings have been changed: -New external programs and libraries: ------------------------------------- - -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: +- The binding "C-w" was moved from "buffer-close" to "view-close" + (only in cua.bind). -* Direct support for ispell and hspell has been dropped. However, ispell - and hspell are still accessible via the enchant wrapper (see below). +- sciword.bind was changed significantly (see #8364). The most important + change is that "math-delim" commands now work under Windows. -* Support for the aspell command line program has been dropped. Note that - the aspell library (aspell 0.60.x) is still supported. - -* As well as the 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.). +The following LyX documents have been moved: -* On Mac OSX, Apple's Spell Server is preconfigured as the "native" spell - checker. +- All thesis template files and the svmult and svmono template files have been + moved to the examples folder. -LyX 2.0 is configured for any and all of these three possibilities, -given that the various libraries are installed on the machine where LyX is -configured. 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: +The following metadata files have been added to the tarball: -* 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 unlike in LyX 1.6.x, no extra - thesaurus library needs to be installed. However, LyX does not ship any - thesaurus dictionaries, and those do have to be installed separately. +- Linux desktop file specification and scalable icon has been + included in the tarball. -* The OpenOffice thesaurus dictionaries can be used, but the path to those - dictionaries needs to be set in Tools > Preferences. Please refer to the - UserGuide, sec. 6.13, for further instructions. +- AppData file (appdata.xml). It will not be installed by default and + distribution maintainers need to handle this file themselves. -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 dictionaries -in the installation process (analoguous to the spellchecker installation). -3.) LILYPOND: +Changes with respect to external programs and libraries: +-------------------------------------------------------- -There is now direct support for Lilypond-book. Note that LyX requires at -least version 2.14 for proper work. +- 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. -4.) INSTANT PREVIEW: +- LyX no longer uses gettext for handling the translation files. This + especially is an advantage on Windows, where translating strings is faster. -Make sure that dv2dt (often part of LaTeX distributions) is installed -on your system. Instant preview wil be disabled if dv2dt is not found. +- 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.0.0 +Known issues in version 2.1.0 ----------------------------- - LyX needs to be run under Python 2 and will not work properly on systems @@ -239,49 +220,12 @@ Known issues in version 2.0.0 this properly, since simple sheebang conversion in *.py files will not be enough. -Caveats when upgrading from earlier versions to 2.0.x + +Caveats when upgrading from earlier versions to 2.1.x ------------------------------------------------------- -- The syntax of the languages file has been changed. If you use a modified - languages file, you will need to adapt it to the new syntax, as LyX 2.0 - is not able to read old languages file anymore. - Please refer to the beginning of the languages file for an explanation - of the new syntax. - -- There has been a large change in how Flex insets are named. Previously, - they tended to have names like "CharStyle:Noun". Now, they just have - names like "Flex:Noun" (where "Flex" is a namespace that is optional). - When LyX 2.0 reads older files, it silently converts the old-style names - to new-style names; this direction works perfectly. It will also silently - revert new-style names to old-style names, when exporting to 1.6.x format, - but only for the pre-defined LyX insets. This means that user-defined flex - insets will not be properly reverted. - To solve this problem, you can modify the file $LYXDIR/lyx2lyx/lyx_2_0.py. - In that file, you will find the following: - flex_insets = { - "Alert" : "CharStyle:Alert", - "Code" : "CharStyle:Code", - "Concepts" : "CharStyle:Concepts", - "E-Mail" : "CharStyle:E-Mail", - "Emph" : "CharStyle:Emph", - "Expression" : "CharStyle:Expression", - "Initial" : "CharStyle:Initial", - "Institute" : "CharStyle:Institute", - "Meaning" : "CharStyle:Meaning", - "Noun" : "CharStyle:Noun", - "Strong" : "CharStyle:Strong", - "Structure" : "CharStyle:Structure", - "ArticleMode" : "Custom:ArticleMode", - "Endnote" : "Custom:Endnote", - "Glosse" : "Custom:Glosse", - "PresentationMode" : "Custom:PresentationMode", - "Tri-Glosse" : "Custom:Tri-Glosse" - } - This is a map form new-style names (minux "Flex") to old-style names (and - there is a similar for DocBook elements). To get a user-defined CharStyle - to revert properly, it simply needs to be added to this list. - - -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).