X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=lib%2FRELEASE-NOTES;h=440b93e71a484aae078bb12522128a8eb445c49d;hb=745b43784ce1b6981fd31f6c5f5fbd489eef51f4;hp=823d10e7d737bf94cec70ac7350b52dc6e79d2c0;hpb=44a004951f7ba7ffdde5a906a58edb9fca85b552;p=lyx.git diff --git a/lib/RELEASE-NOTES b/lib/RELEASE-NOTES index 823d10e7d7..440b93e71a 100644 --- a/lib/RELEASE-NOTES +++ b/lib/RELEASE-NOTES @@ -1,144 +1,243 @@ -!Important Changes in LyX 2.2.0 - -(: 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. :) +!Important Changes in LyX 2.3.0 !!Interface changes -* The --Separator-- layout has been removed in favor of an environment - separator inset. There is no provision for inserting this inset from - the GUI (though some menu entries use it) as it is automatically inserted - when needed. See Section 3.4.6 of the User Guide for details. +* LyX now has "inverted" branch insets, which output their contents just in + case a given branch is not "activated". This makes inclusion of alternate + material in different versions easier. + +* When inserting a command or symbol in mathed, it is now automatically + wrapped in a real inset (either \text or \ensuremath) assuring the correct + mode, instead of being wrapped only in the output. The wrapping inset can + be safely dissolved, as it will be automatically inserted at export time + if needed, as usual. + +* The new setting + "Document->Settings->Fonts->Output em- and en-dash as ligatures" forces + output of en- and em-dashes as -- and --- when exporting to LaTeX. + It is is "true" by default but "false" when opening documents edited + with LyX 2.2. + See chapter 3.9.1.1 "Dashes and line breaks" of the User Guide and + "Caveats when upgrading from earlier versions to 2.3.x" below. + +* The following UI translations were dropped, because the lack of translation + maintenance: Russian, Danish, Greek, Serbian, Galician, Catalan, Romanian, + Dutch. + +!!Documents compilation process and images conversion + +* It is now possible to enable the -shell-escape option only for specific + documents, rather than having to enable it globally in preferences. + This is achieved by checking "Allow running external programs" in + Document->Settings->Formats. LyX will now check whether -shell-escape + has been added to a LaTeX converter and invites the user to remove it + in favor of the new mechanism when that LaTeX converter is used. + +* The converters definition syntax (LYX_HOME/lyxrc*) now supports a + new option, 'needauth', to prevent completely automated execution of + the converter, unless LyX acquired explicit consent by the + user. This is a new security feature, useful for converters that are + capable of executing arbitrary code, such as R scripts (used with + sweave/knitr), embedded within LyX documents. The user needs to + explicitly grant per-document permission on the first need for using + the converter on each document, unless he/she checks the "Don't ask + again for this document" checkbox in the permission dialog. The new + behavior can be fine-tuned from two new options in the preferences + dialog (see their description below). These also allow for disabling + 'needauth' converters altogether, if desired (default behavior). + +* LyX now supports insertion and automated conversion of Gnuplot scripts, + recognized by their typical extension ".gp" or ".gnuplot". These can + directly be inserted in a LyX document using the "Insert->Graphics..." + dialog, then selecting the Gnuplot script. LyX automatically adds a + proper "set terminal ..." and "set output ..." line to convert the + file to the needed output format (e.g., .eps, .pdf), depending on + whether the document is being previewed on screen or compiled as PDF + or other formats. Terminal options cannot be fine-tuned at the moment, + but that's a capability that may come soon, also according to the + received feedback from users. + + +!!!The following pref variables were added in 2.3: + +* \default_platex_view_format + Determine the default output format for Japanese documents that use the + pLaTeX backend [default: "pdf3" == "PDF (dvipdfm)"] + +* \jbibtex_alternatives + Alternative bibliography converters for Japanese. + +* \pygmentize_command + holds the name of the driver command used by the Pygments python module. + +* \use_converter_needauth + when enabled, user is asked before calling any (possibly dangerous) + external converter with the 'needauth' option + +* \use_converter_needauth_forbidden + when enabled, use of external converters with the 'needauth' option is + forbidden + + +!!!The following pref variables were changed in 2.3: + +* \bibtex_command + New (default) value "auto". + +* \screen_zoom + This is now independent of the value set via buffer-zoom[-in|-out]. + + +!!!The following new LyX functions have been introduced in 2.3: + +* buffer-external-modification-clear + Clear the external modification flag on the current buffer -* The prefix for subsections in labels and references has been changed from - "sub:" to "subsec:" in order to avoid a clash with subfloats (conflicting - \subref command, see bug #7550). Files are automatically converted to the new - scheme. Please assure that you adapt external refstyle or prettyref definitions - and your own layout files. +* buffer-zoom + Zooms the screen fonts to a given value or resets to the default zoom + when no argument is given. -* Support for printing from within LyX (File> Print) has been removed. LyX's - printing support was very limited, and most users will want to print after - reviewing an output document (e.g., a PDF), anyway, which can be done from the - PDF viewer. - Users who would like to restore this functionality can create a - "printer" format from within LyX and then define, say, a - pdf->printer converter that does nothing but call lpd, or a2ps, or - whatever. The "printer" will then be available as an export option. +* branch-invert + Toggles inversion status of branch inset. +* devel-mode-toggle + Activate/deactivate the developer mode, which consists mainly in: + (1) more information shown in the status bar and (2) help file + opened in editable mode. This state used to be hardcoded at compile + time. -!!!The following pref variables were added in 2.2: +* font-crossout + Cross out characters. -* \save_origin - This variable was introduced to allow saving the document directory - path in the document. If allowed, LyX will be able to locate all - included files even when the document is manually moved/copied to - a different location. If a valid \origin tag is present and the - document was actually moved, the path of all included files is - updated relative to the new location and the new origin will be - recorded when saving again the document. +* icon-size [size in px] + Set the icon size in the toolbar -!!!The following pref variables were changed in 2.2: +* lyx-activate + Activates the LyX window. Useful in combination with reverse search. +* toolbar-movable + Toggles movability of a given toolbar. -!!!The following pref variables are obsoleted in 2.2: +!!!The following LyX functions have been changed in 2.3: -* \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. +* buffer-export + If no or "default" argument is given, the function now exports to the default + output format. -* \printer -* \print_adapt_output -* \print_command -* \print_evenpage_flag -* \print_oddpage_flag -* \print_pagerange_flag -* \print_copies_flag -* \print_collcopies_flag -* \print_reverse_flag -* \print_to_printer -* \print_to_file -* \print_file_extension: - These were used for print support, which has been removed. +* buffer-zoom-in, buffer-zoom-out + The Zoom value set by these is now relative to the default zoom value set in + preferences. +* inset-modify + This function now also applies to quote insets. It takes a three-character + string as an argument, referring (1.) to the style (e = ``english'', + s = ''swedish'', g = ,,german``, p = ,,polish'', f = <>, a = >>danish<<), + (2.) to the side (l = left, r = right) and (3.) to the quotation level + (s = single, d = double). So "eld" means "English left double quotation mark". + A dot in the string means: take the current value. So "inset-modify changetype e.." + will only change the style to English, while letting side and level as is, + "inset-modify changetype f.s" will change the style to French and the level to + single, leaving the side value. -!!!The following new LyX functions have been introduced in 2.2: + This function is most useful when combined with inset-forall. E.g., + "inset-forall Quotes inset-modify changetype f.." + => change all quote insets to French style, maintaining current side and level + "inset-forall Quotes inset-modify changetype ..s" + => change all quote insets to single quotes, keeping style and level + "inset-forall Quotes inset-modify changetype g.s" + => change all quote insets to German single quotes, keeping left/right setting -* buffer-view-cache - Opens the last previewed output of the buffer, if it exists. +* paragraph-goto + The function has now two further optional arguments that determine end positions. + If specified, a selection is performed. -* buffer-move-next - Moves the current tab one spot to the right. +* quote-insert + The function now has a second and third optional argument to specify + the side (left, right, auto) and quotation mark style (english, swedish, + german, polish, french, danish). -* buffer-move-previous - Moves the current tab one spot to the left. +* specialchar-insert + New option allowbreak that adds an invisible line break option, +* word-delete-forward, word-delete-backward, char-delete-forward, + char-delete-backward + The pre-2.3 behavior of these functions is equivalent to the 2.3 behavior with + the "force" option appended. The new default behavior (without "force") is + to select big insets on the first call and delete them only on the second. + This new behavior is consistent with how delete works in LyX's math editor. -!!!The following LyX functions have been changed in 2.2: -* word-upcase, word-lowcase and word-capitalize do not select the word - to operate on in the emacs way (that is, starting at cursor - position); this behaviour can be restored by using the argument - "partial". +!!!The following new folders have been added to the LyX directory -!!!The following LyX key bindings have been changed in 2.2: +* citeengines: Contains the *.citeengine files that determine the citation + formatting and features. -* 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. +* xtemplates: Contains the *.xtemplate files that define the external templates + (previously in the external_templates file). -* The shortcuts for "bookmark-save x" have been changed from C-M-S-x to S-Fx - ("x" stands for the number of the bookmark.) +!!!The following preferences files have been removed from the tarball in 2.3: -!!!The following LyX documents have been moved in 2.2: +* external_templates. This files has been split into multiple *.xtemplate + files that are now shipped as content of the xtemplates directory. +!!Changes with respect to external programs and libraries in 2.3: -!!!The following metadata files have been added to the tarball in 2.2: +* Inkscape SVG with separate LaTeX + PDF or PS output is supported via External + Material. +* Add some editor/viewer applications to (re)configure checks. +* The included Hunspell has been upgraded to version 1.6.2. -!!Changes with respect to external programs and libraries in 2.2: +* The included libiconv has been upgraded to version 1.15. -* LyX 2.2.0 and the following 2.2.x releases will continue to work well with - Qt 4.5 (and later Qt 4.x) but will also support Qt 5.6, which brings some - advantages most notably for users with HiDPI displays. Note that if you - compile LyX with a Qt 5 release before 5.6 you are likely to run into - several regressions with respect to Qt 4.x. See #9215 for a list of bugs - related to compiling LyX with different versions of Qt. -* LyX now gives an error if the underlying LaTeX command exited with error. +!!Known issues in version 2.3.0 -* With LuaTeX, LyX now uses polyglossia instead of babel if the language - package option "Automatic" is selected. In order to use babel, select - "Always babel" instead. +* See http://www.lyx.org/trac/wiki/BugTrackerHome. -!!Known issues in version 2.2.0 +!!Caveats when upgrading from earlier versions to 2.3.x -* 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 shebang conversion in *.py files will not - be enough. +* The external_templates file has been split into one file per template, + which are now located in lib/xtemplates/*.xtemplate. This makes it easier + to add new templates or modify existing ones. If you have modified + the external_templates file, you will have to move the modifications to + the respective *.xtemplate file manually. +* If you used literal em- and en-dashes in pre-2.2 documents, + you must manually unselect + "Document->Settings->Fonts->Output em- and en-dash as ligatures" + to ensure unchanged behaviour. -!!Caveats when upgrading from earlier versions to 2.2.x +* ZWSP characters (u200b) following literal em- and en-dashes are deleted by + lyx2lyx when converting to 2.3 format. If you used them as optional line + breaks after dashes, convert them to space insets before opening your + document with LyX 2.3 or the optional line breaks will be lost! -* 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. +* If using TeX fonts and en- and em-dashes are output as font ligatures, + when exporting documents containing en- and em-dashes to the format of + LyX 2.0 or earlier, the following line has to be manually added to the + unicodesymbols file of that LyX version:
+ 0x200b "\\hspace{0pt}" "" "" "" "" # ZERO WIDTH SPACE
+ This avoids "uncodable character" issues if the document is actually + loaded by that LyX version. LyX 2.1 and later versions already have the + necessary definition in their unicodesymbols file. -* Missing characters in the output are now reported as errors. This leads - to error reports for documents that compiled without error before. - However, the error was always present but went undetected! +* If trying to compile documents using R scripts and sweave/knitr, LyX + 2.3.x would not allow for re-running the R scripts, unless the user: + 1) explicitly disables the "Forbid use of needauth converters" + option in the LyX preferences; + 2) provides explicit consent to the use of the converter on the first + compilation of the R-enhanced document. -* Documents using Times fonts and containing Greek characters may now fail - to compile under pdflatex for users of MikTeX due to an automatically - half-installed "grtimes" package. A workaround in LyX was removed as it - stands in the way of alternative approaches (see bug #6469). +* LyX now gives a warning if a document mixes title and non-title layouts. + In some cases, this warning is harmless, but in other cases the document has + a serious problem even though the LaTeX command does not exit with error. For + example, create a document with a title layout, then a standard layout, and + then an author layout, and you will see in the PDF that the author is not + typeset as an author.