X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=RELEASE-NOTES;h=d8b626ea5478741e646ddc06a5c4570d4287d962;hb=8479e06b54e1ae955ae4f567a234856efaa2b04d;hp=428b4fe58adf66c97ce127ceca4e27b4ec011be1;hpb=11441c85605e023e7c9a0a5d78cd608b6b5e1321;p=lyx.git diff --git a/RELEASE-NOTES b/RELEASE-NOTES index 428b4fe58a..d8b626ea54 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -1,75 +1,193 @@ -This file lists interface changes that might affect users in 1.5.0 and -also some known problems in LyX 1.5.0 that did not occur in -1.4.5. Note that fixes are available for many of these, but they have -not yet been applied because of incomplete testing. +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. Interface changes ----------------- -Some of the LyX functions have changed names : +Some of the LyX functions have changed names: +- A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the + different LFUNs for single special characters: -Known issues with version 1.5.0 + * 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 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. + +- The function LFUN_PAGEBREAK_INSERT, "pagebreak-insert" has been renamed to + LFUN_NEWPAGE_INSERT, "newpage-insert". It obsololetes the following functions: + + * LFUN_PAGEBREAK_INSERT: removed. "pagebreak-insert" has been replaced by + "newpage-insert pagebreak" + + * LFUN_CLEARPAGE_INSERT: removed. "clearpage-insert" has been replaced by + "newpage-insert clearpage" + + * LFUN_CLEARDOUBLEPAGE_INSERT: removed. "clearpage-insert" has been replaced + by "newpage-insert cleardoublepage" + +- The function LFUN_WORDS_COUNT, "words-count", has been replaced by + LFUN_STATISTICS, "statistics", which counts more than words. + +- The function LFUN_MATH_NUMBER, "math-number", has been renamed to + LFUN_MATH_NUMBER_TOGGLE. + +- 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 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 functions LFUN_HTML_INSERT, "html-insert", LFUN_URL_INSERT, "url-insert" was + superseded by LFUN_HYPERLINK_INSERT, "href-insert". + + +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_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". + +- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param". + +- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param". + +- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param". + +- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param". + +- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional". + +- 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". + +- 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, "". + +- LFUN_INFO_INSERT, "info-insert". + +- LFUN_LAYOUT_RELOAD, "layout-reload". + +- LFUN_LAYOUT_MODULES_CLEAR, "layout-modules-clear". + +- LFUN_LAYOUT_MODULE_ADD, "layout-module-add". + +- LFUN_NEXT_INSET_MODIFY, "next-inset-modify" + +- LFUN_INSET_EDIT, "inset-edit" + +- LFUN_SET_GRAPHICS_GROUP, "set-graphics-group" + +- LFUN_GRAPHICS_GROUPS_UNIFY, "graphics-groups-unify" + +The following new LyX functions have been removed: + +- LFUN_FILE_NEW. + +- LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT. + +- LFUN_FONT_CODE. + +- LFUN_HFILL_INSERT. HFills are now part of InsetSpace and have to be inserted + via "space-insert hfill". + +- LFUN_CLEARPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above). + +- LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above). + +- LFUN_SERVER_GET_FONT. + +- LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT. + +- LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT. + +- LFUN_ACCENT_SPECIAL_CARON. + +- LFUN_INSET_REFRESH. + +For the detailed description of LyX functions look into doxygen documentation. + + +Known issues in version 1.6.0 ------------------------------------ -- User layout files must be converted to UTF-8 - -In previous version, layout styles were allowed to use non-ASCII names -using the local encodings. LyX-1.5 now assumes that all layout files are -UTF-8 encoded. This means that non-ASCII style names are still allowed -but they nust be valid UTF-8 strings. One way of doing the conversion -is to use iconv. Using bash, the script below should work: - -cd /path/to/layouts -for l in * -do - cp $l tmp.txt - iconv -f latin1 -t utf8 tmp.txt -o $l -done -rm tmp.txt - -- Cursor restoration problems with Multiple-View - -When using multiple Windows to edit different parts of the -same document, the cursor position is sometimes not correctly restored -when you switch from one view to the other. - -- Languages/encodings and insets - -One of the bugs fixed in LyX 1.5.0 is that previously, there were certain -specific cases in which the LaTeX generated did not correctly reflect -language/encoding transitions in and around insets (footnotes, LyX notes). -After much deliberation, it was decided not to change older files such that -they will still reflect the old LaTeX output; rather, they will now correctly -reflect the situation as it appears in the GUI. This means, however, that if -you mangled the text in the GUI in the older versions, in order that it -generate the correct LaTeX output, the LaTeX will now generate the mangled -text. If this is problematic for you, please get in touch with us on the -developers mailing list, we do have some possible solutions for this. - -The effects of this will be more pronounced for RTL (Hebrew, Arabic, Farsi) -users --- though they affect users of other languages as well. - -- Inset encodings and Conversion from earlier LyX versions - -One of the main new features in version 1.5.0 is Unicode. As part of the -transition, lyx2lyx (the scripts used for converting back and forth between -different versions of the lyx files) converts old .lyx files, which may use -a number of different encodings, to UTF-8. This conversion depends on -correctly identifying the language of the text. There were previously some -edge-cases (insets embedded in different-language text type scenarios) in -which the language was incorrectly identified, which caused some text to -appear incorrectly after having upgraded from older versions. This has now been -fixed. Unfortunately, however, the fix cannot be applied to files which have -already been converted past format 249. So if you have already converted -your old files (using a development version or release candidate), this fix -won't help, unless you still have the originals lying around (and haven't -yet made too many changes to the newer versions ;) ). - -Generally, it is probably wise to keep a backup of the old version of your -files, at least until you are sure that the upgrade went smoothly (which it -almost always will). +- ... + + +Caveats when upgrading from earlier versions to 1.6.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