X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=RELEASE-NOTES;h=1f645d0c56d2000f38bcc98ab5c855a252b4b47e;hb=c9a49d2145c60c71768d7df1a615f7e4e043e703;hp=87bdabbd86f71d1333a36bdda61d4a3665b09a94;hpb=7b1bf2333704ebdc3ac51fbee49017aff1accc01;p=lyx.git diff --git a/RELEASE-NOTES b/RELEASE-NOTES index 87bdabbd86..1f645d0c56 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -1,252 +1,227 @@ -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 ----------------- -The external template format recognize now a new tag: 'Preview'. This -tag is used to define how an external material should be previewed in -LyX. For more detail, see the 'external_templates' file in the resource -directory of LyX. +- There have been changes to some often used menu items. -LyX 1.6.0 introduces support for the pLaTeX distribution which provides -extended language and script support for Japanese. The language -"Japanese" now uses this new method. Japanese support via the CJK -package is still available, but has been renamed to "Japanese (CJK)". -Old documents continue to use the CJK method. Also cf. the "known -issues" section for some remaining problems. + The following menu items moved from View to Document: + * View (Default format) + * View (Other formats) + * Update (Default format) + * Update (Other formats) -Some of the LyX functions have changed names: + The following menu item moved from Document to View: + * Outline -> Outline Pane -- A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the - different LFUNs for single special characters: +- 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). - * 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" + A new configurable preference option has been added, allowing for + either (close_buffer_with_last_view). -- 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. +- There have been some changes to the LyX command line. The following + new options have been added: -- The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to - LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions: + --export-to (-E ) - * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by - "newpage-insert pagebreak" + 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. - * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by - "newpage-insert clearpage" + 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_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced - by "newpage-insert cleardoublepage" +- The Advanced Find and Replace feature now supports cancel of a + long search operation by hitting the ESC key. -- The function LFUN_WORDS_COUNT, "words-count", has been replaced by - LFUN_STATISTICS, "statistics", which counts more than words. +- 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_MATH_NUMBER, "math-number", has been renamed to - LFUN_MATH_NUMBER_TOGGLE. +- 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_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 pref variables were added in 2.1: -- The function LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR, - "toggle-cursor-follows-scrollbar" - has been renamed to LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE, - "cursor-follows-scrollbar-toggle". +- \\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"). -- The function LFUN_FONT_CODE, "font-code", has been renamed to - LFUN_FONT_TYPEWRITER, "font-typewriter". +- \\completion_minlength + Defines the minimal length of a word to be added to the list of + words for text completion. -- The functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, - "url-insert" was superseded by LFUN_HYPERLINK_INSERT, "href-insert". +- \\default_length_unit + Defines the default length unit: 2 for centimers, 6 for inches. -- The function LFUN_FLOAT_LIST has been renamed to LFUN_FLOAT_LIST_INSERT. +- \\default_otf_view_format + Defines the default output format for documents with non-tex + fonts (OpenType fonts). -- The functions delete-back/forward has been renamed to - char-delete-back/forward. +- \\fullscreen_statusbar + Controls whether the statusbar is shown in fullscreen mode. -- The functions LFUN_FONT_FREE_APPLY/UPDATE has been renamed to - LFUN_TEXTSTYLE_APPLY/UPDATE. +- \\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. -- The functions LFUN_SERVER_GET_NAME has been renamed to - LFUN_SERVER_GET_FILENAME. + 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. + (see also commit 1717ef20) -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". - -- LFUN_COMPLETION_COMPLETE, "complete". - -- LFUN_COMPLETION_CANCEL, "completion-cancel" - -- LFUN_COMPLETION_ACCEPT, "completion-accept" - -- LFUN_CLOSE_TAB_GROUP, "close-tab-group". - -- LFUN_SPLIT_VIEW, "split-view". - -- LFUN_UI_TOGGLE, "ui-toggle". - -- LFUN_SCROLL, "scroll". - -- LFUN_MATH_MACRO, "math-macro". - -- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold". - -- LFUN_MATH_MACRO_FOLD, "math-macro-fold". +- \\use_qimage + See Caveats section below. -- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param". +- \\use_system_theme_icons + If set to true, LyX tries to use the theme icons as defined by + the OS. -- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param". -- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param". +The following pref variables were changed in 2.1: -- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-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_MAKE_OPTIONAL, "math-macro-make-optional". -- LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional". +The following pref variables are obsoleted in 2.1: -- LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param". +- \\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_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, "". +The following new LyX functions have been introduced: -- LFUN_INFO_INSERT, "info-insert". +- ipa-insert + Inserts an IPA (International Phonetic Alphabet) inset. -- LFUN_LAYOUT_RELOAD, "layout-reload". +- 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_LAYOUT_MODULES_CLEAR, "layout-modules-clear". +- spelling-continuously + Toggles continuous spell-checking. -- LFUN_LAYOUT_MODULE_ADD, "layout-module-add". +- vc-rename +- vc-copy + Renames or copies a file under version control. -- LFUN_NEXT_INSET_MODIFY, "next-inset-modify" +- buffer-forall + Applies to all non-hidden buffers. -- LFUN_INSET_EDIT, "inset-edit" +- environment-split + Splits the current environment with a Separator. -- LFUN_SET_GRAPHICS_GROUP, "set-graphics-group" +- 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_BRANCH_ACTIVATE, "branch-activate" +- buffer-export-as + Equivalent to the new -export-to command-line switch (see above). -- LFUN_BRANCH_DEACTIVATE, "branch-deactivate" - These can be used in export mode to turn branches on and off. - Thus, something like: - lyx -e pdf2 -x "branch-activate answers" finalexam.lyx - could be used to export a pdf with the answers branch included, without - one's having to open LyX and activate the branch manually. +- 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_NOTES_MUTATE, "notes-mutate" +- 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_FONT_BOLDSYMBOL, "font-boldsymbol" - This is the same as LFUN_FONT_BOLD except that in math mode \boldsymbol - is used instead of \mathbf. -- LFUN_COMMAND_ALTERNATIVES, "command-alternatives" - This works similarly to command-sequence, except that instead of running - each of the commands, it only runs the first one that is enabled. This can - be used to bind multiple functions to a single key, and then which one is - used will depend upon the context. +The following LyX functions have been changed: +- close-tab-group was renamed to tab-group-close. -The following LyX functions have been removed: +- split-view was renamed to view-split. -- LFUN_FILE_NEW. +- break-paragraph was renamed to paragraph-break. -- LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT. +- copy-label-as-reference was renamed to label-copy-as-reference. -- LFUN_FONT_CODE. -- LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted - via "space-insert hfill". +The following LyX key bindings have been changed: -- LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above). +- The binding "C-w" was moved from "buffer-close" to "view-close" + (only in cua.bind). -- LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above). +- sciword.bind was changed significantly (see #8364). The most important + change is that "math-delim" commands now work under Windows. -- LFUN_SERVER_GET_FONT. +The following LyX documents have been moved: -- LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT. +- 'AEA', 'JASA', 'springer', 'ACM-siggraph', and 'thesis' have been moved + from templates to examples (see #8643). -- LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT. -- LFUN_ACCENT_SPECIAL_CARON. +The following metadata files have been added to the tarball: -- LFUN_INSET_REFRESH. +- Linux desktop file specification and scalable icon has been + included in the tarball. -- LFUN_BREAK_PARAGRAPH_SKIP, LFUN_DELETE_BACKWARD_SKIP, LFUN_DELETE_FORWARD_SKIP. +- AppData file (appdata.xml). It will not be installed by default and + distribution maintainers need to handle this file themselves. -- LFUN_ERROR_NEXT. -- LFUN_MATH_IMPORT_SELECTION. Use LFUN_MATH_MODE instead. +Changes with respect to external programs and libraries: +-------------------------------------------------------- -- LFUN_BIBITEM_INSERT. +- 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 under the Help menu. +- 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 +----------------------------- -- New pLaTeX support for Japanese: - * Documents using this method can be backported to 1.5 in pricipal, but - the backported documents are not guaranteed to work, since 1.5 falls - back to the CJK package; expect the output to differ. - * pLaTeX provides a Japanese variant of BibTeX named "jbibtex", which will - be selected automatically by LyX. If you run into problems with this or - if you need to use an alternative BibTeX program, you can change this - setting in the LyX preferences (Output->LaTeX->BibTeX command). +- 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 ------------------------------------------------------- - - - -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).