]> git.lyx.org Git - lyx.git/blobdiff - RELEASE-NOTES
projects / lyx.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
tiger support on mac snow leopard, include Qt4 frameworks, smart build script with...
[lyx.git] / RELEASE-NOTES
diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 87bdabbd86f71d1333a36bdda61d4a3665b09a94..0d0cc31d91fffb8dc4dffaba4d1ffa7db0d49339 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -1,6 +1,6 @@
-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.
+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.
 
 Note that fixes are available for some of these, but they have not yet
 been applied because of incomplete testing.
 
@@ -8,240 +8,169 @@ been applied because of incomplete testing.
 Interface changes
 -----------------
 
 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 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.
 
 
-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.
+Bash completion script was added to the tarball.
 
 
-Some of the LyX functions have changed names:
+The following variables are obsoleted in 2.0
 
 
-- A new LFUN_SPECIALCHAR_INSERT has been implemented that obsoletes the
-  different LFUNs for single special characters:
+- \plaintext_roff_command (was not used anymore)
 
 
-  * 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"
+- \personal_dictionary, \spell_command, \use_input_encoding,
+  \use_personal_dictionary and \use_spell_lib (ispell support has been
+  removed)
 
 
-- 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.
+- \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 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 function LFUN_FLOAT_LIST has been renamed to LFUN_FLOAT_LIST_INSERT.
-
-- The functions delete-back/forward has been renamed to
-  char-delete-back/forward.
-
-- The functions LFUN_FONT_FREE_APPLY/UPDATE has been renamed to
-  LFUN_TEXTSTYLE_APPLY/UPDATE.
-
-- The functions LFUN_SERVER_GET_NAME has been renamed to
-  LFUN_SERVER_GET_FILENAME.
+- \custom_export_command and \custom_export_format
 
 
 The following new LyX functions have been introduced:
 
 
 
 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_WORD_FINDAD ("word-findadv").
 
 
-- LFUN_COMPLETION_CANCEL, "completion-cancel"
+- LFUN_REGEXP_MODE ("regexp-mode").
 
 
-- LFUN_COMPLETION_ACCEPT, "completion-accept"
+- LFUN_PHANTOM_INSERT ("phantom-insert").
 
 
-- LFUN_CLOSE_TAB_GROUP, "close-tab-group".
+- LFUN_INSET_BEGIN ("inset-begin").
 
 
-- LFUN_SPLIT_VIEW, "split-view".
+- LFUN_INSET_END (""inset-end"").
 
 
-- LFUN_UI_TOGGLE, "ui-toggle".
+- LFUN_INSET_BEGIN_SELECT ("inset-begin-select").
 
 
-- LFUN_SCROLL, "scroll".
+- LFUN_INSET_END_SELECT ("inset-end-select").
 
 
-- LFUN_MATH_MACRO, "math-macro".
+- LFUN_CHANGE_PREVIOUS ("change-previous").
 
 
-- LFUN_MATH_MACRO_UNFOLD, "math-macro-unfold".
+- LFUN_LABEL_INSERT_AS_REF ("label-insert-as-reference").
 
 
-- LFUN_MATH_MACRO_FOLD, "math-macro-fold".
+- LFUN_SECTION_SELECT ("section-select").
 
 
-- LFUN_MATH_MACRO_ADD_PARAM, "math-macro-add-param".
+- LFUN_FONT_UNDERLINE ("font-underline").
 
 
-- LFUN_MATH_MACRO_REMOVE_PARAM, "math-macro-remove-param".
+- LFUN_FONT_STRIKEOUT ("font-strikeout").
 
 
-- LFUN_MATH_MACRO_APPEND_GREEDY_PARAM, "math-macro-append-greedy-param".
+- LFUN_FONT_UULINE ("font-underunderline").
 
 
-- LFUN_MATH_MACRO_REMOVE_GREEDY_PARAM, "math-macro-remove-greedy-param".
+- LFUN_FONT_UWAVE ("font-underwave").
 
 
-- LFUN_MATH_MACRO_MAKE_OPTIONAL, "math-macro-make-optional".
+- LFUN_BRANCHES_RENAME ("branches-rename").
 
 
-- LFUN_MATH_MACRO_MAKE_NONOPTIONAL, "math-macro-make-nonoptional".
+- LFUN_BRANCH_ADD_INSERT ("branch-add-insert").
 
 
-- LFUN_MATH_MACRO_ADD_OPTIONAL_PARAM, "math-macro-add-optional-param".
+- LFUN_BUFFER_CLOSE_ALL ("buffer-close-all").
 
 
-- LFUN_MATH_MACRO_REMOVE_OPTIONAL_PARAM, "math-macro-remove-optional-param".
+- LFUN_INSET_FORALL ("inset-forall").
 
 
-- LFUN_MATH_MACRO_ADD_GREEDY_OPTIONAL_PARAM, "math-macro-add-greedy-optional-param".
+- LFUN_DEBUG_LEVEL_SET ("debug-level-set").
 
 
-- LFUN_WORD_LEFT, "word-left".
+- LFUN_INSET_SELECT_ALL ("inset-select-all").
 
 
-- LFUN_WORD_LEFT_SELECT, "word-left-select".
+- LFUN_MATH_AMS_MATRIX ("math-ams-matrix").
 
 
-- LFUN_WORD_RIGHT, "word-right".
+- LFUN_VC_COMPARE ("vc-compare").
 
 
-- LFUN_WORD_RIGHT_SELECT, "word-right-select".
+- LFUN_SPELLING_ADD ("spelling-add").
 
 
-- LFUN_CHAR_LEFT, "char-left".
+- LFUN_SPELLING_IGNORE ("spelling-ignore").
 
 
-- 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_BRANCH_ACTIVATE, "branch-activate"
-
-- 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.
-
-- LFUN_NOTES_MUTATE, "notes-mutate"
-
-- LFUN_FONT_BOLDSYMBOL, "font-boldsymbol"
-  This is the same as LFUN_FONT_BOLD except that in math mode \boldsymbol
-  is used instead of \mathbf.
+The following LyX functions have been removed:
 
 
-- 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.
+- LFUN_NEXT_INSET_TOGGLE ("next-inset-toggle"): use "inset-toggle" instead.
 
 
+- LFUN_NEXT_INSET_MODIFY ("next-inset-modify"): use "inset-modify" instead.
 
 
-The following LyX functions have been removed:
+- LFUN_PARAGRAPH_SPACING ("paragraph-spacing"): use "paragraph-params" instead.
 
 
-- LFUN_FILE_NEW.
+- 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>
 
 
-- LFUN_BREAK_PARAGRAPH_KEEP_LAYOUT.
+- LFUN_ALL_INSETS_TOGGLE ("all-insets-toggle"): replace
+    all-insets-toggle <ACTION> <TARGET>
+    all-insets-toggle <ACTION>
+  with the more generic function inset-forall
+    inset-forall <TARGET> inset-toggle <ACTION>
+    inset-forall * inset-toggle <ACTION>
+  There is a difference in the <TARGET> parameter, which is would be
+  like "note" in the first case and "Note" in the second.
 
 
-- LFUN_FONT_CODE.
+- LFUN_TABULAR_FEATURE ("tabular-feature"): use "inset-modify" instead.
 
 
-- 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).
+The following LyX functions have been changed:
 
 
-- LFUN_CLEARDOUBLEPAGE_INSERT. Now part of LFUN_NEWPAGE_INSERT (see above).
+- 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.
 
 
-- LFUN_SERVER_GET_FONT.
 
 
-- LFUN_EXTERNAL_EDIT. Superseded by the more general LFUN_INSET_EDIT.
+New external programs and libaries:
+-----------------------------------
 
 
-- LFUN_GRAPHICS_EDIT. Superseded by the more general LFUN_INSET_EDIT.
+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.
 
 
-- LFUN_ACCENT_SPECIAL_CARON.
+1.) SPELLCHECKING:
 
 
-- LFUN_INSET_REFRESH.
+* Direct support for ispell and hspell has been dropped. However, ispell
+  and hspell are still accessible via the enchant wrapper (see below).
 
 
-- LFUN_BREAK_PARAGRAPH_SKIP, LFUN_DELETE_BACKWARD_SKIP, LFUN_DELETE_FORWARD_SKIP.
+* 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.).
 
 
-- LFUN_ERROR_NEXT.
+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.
 
 
-- LFUN_MATH_IMPORT_SELECTION. Use LFUN_MATH_MODE instead.
+2.) THESAURUS:
 
 
-- LFUN_BIBITEM_INSERT.
+* 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.
 
 
-For the detailed description of LyX functions look under the Help menu.
+* 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 1.6.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).
+Known issues in version 2.0.0
+-----------------------------
 
 
 
 
-Caveats when upgrading from earlier versions to 1.6.x
+Caveats when upgrading from earlier versions to 2.0.x
 -------------------------------------------------------
 
 
 -------------------------------------------------------
 
 
@@ -250,3 +179,7 @@ Caveats when upgrading from earlier versions to 1.6.x
 Note: There may later be an updated list of known issues online at
        http://wiki.lyx.org/LyX/ReleaseNotes
 
 Note: There may later be an updated list of known issues online at
        http://wiki.lyx.org/LyX/ReleaseNotes
 
+TODO
+----
+- Somebody should create a rc2rc script...
+  http://www.lyx.org/trac/changeset/27531
The LyX Source Repository