]> git.lyx.org Git - lyx.git/blobdiff - UPGRADING
Prepare for 2.3.4-3
[lyx.git] / UPGRADING
index 76e2f55231a6654cefad4854ebee47db118ebe25..f28461caf17584c0fbb2fafd1faf55fdd58e53d6 100644 (file)
--- a/UPGRADING
+++ b/UPGRADING
@@ -1,8 +1,84 @@
-How do I upgrade my existing LyX system to version 2.0.x?
+How do I upgrade my existing LyX system to version 2.3.x?
 ---------------------------------------------------------
 
+* Upgrading from LyX 2.2.x:
+
+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.
+
+By default, LyX 2.3 outputs en- and em-dashes as -- and --- respectively,
+so that a line break can occur in the output immediately after the dash.
+Sometimes, this results in undesired line breaks or overfull lines due to
+suppression of hyphenation in the word preceding the dash.
+Select "Document->Settings->Fonts->Disallow line breaks after dashes"
+to keep the LyX 2.2 behaviour.
+See chapter 3.9.1.1, "Dashes and Line Breaks", of the User Guide
+for details.
+
+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.
+
+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.
+
+* Upgrading from LyX 2.1.x:
+
+The format of preference and session files has changed. LyX 2.2.x is able to
+read old files but will save them in the new format.
+
+The format of layout files has changed but, as before, layout2layout.py will
+convert older versions to the new format automatically.
+
+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.
+
+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.
+
+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!
+
+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).
+
+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. This may be needed if a document uses code that
+is specific to babel.
+
+* Upgrading from LyX 2.0.x:
+
+Python version >=2.4 is now required.
+
+Python version >3.0 is still not yet supported.
+
 * Upgrading from LyX 1.6.x:
 
+The typeset of your documents with non-english language can slightly
+change in case of math environments and floats. LyX 2.0.x now has its
+own translation machinery for the strings that are not translated by
+babel.
+
 The format of preference and session files has changed. LyX 2.0.x is
 able to read old files but will save them in the new format.
 
@@ -16,6 +92,9 @@ There has been a large change in how Flex insets are named.
 When exporting back to 1.6.x format user-defined flex insets will not
 be properly reverted. See RELEASE-NOTES for details.
 
+The UI layout named "classic.ui" and some localized keyboard bindings
+(sv, pt, fi) are not being shipped anymore.
+
 * Upgrading from LyX 1.5.x:
 
 The format of preference and session files has changed. LyX 1.6.x is
@@ -241,4 +320,4 @@ babel). If you relied, on babel being loaded before your own
 definitions, you can add an extra "\usepackage{babel}" statement at
 the beginning of your preamble.
 
-http://bugzilla.lyx.org/show_bug.cgi?id=315
+http://www.lyx.org/trac/ticket/315