]> git.lyx.org Git - lyx.git/blobdiff - UPGRADING
#9130 Text in main work area isn't rendered with high resolution
[lyx.git] / UPGRADING
index c85094051ba595393bc6684841df9d6450c93133..122f92d8f8acb2b4c7ef6ea3f3124ba5c92aab37 100644 (file)
--- a/UPGRADING
+++ b/UPGRADING
@@ -1,15 +1,34 @@
-How do I upgrade my existing LyX system to version 2.0.x?
+How do I upgrade my existing LyX system to version 2.1.x?
 ---------------------------------------------------------
 
+* 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.
 
-The format of layout files has changed but, as before,
-layout2layout.py will convert older versions to the new format
-automatically.
+The format of layout files has changed but, as before, layout2layout.py
+will convert older versions to the new format automatically.
+
+The syntax of the languages file has been changed. If you use a
+modified languages file, you will need to adapt it to the new syntax.
 
+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:
 
@@ -92,7 +111,7 @@ have to update them
 Build requirements
 ------------------
 
-LyX 2.0 uses the Qt 4.x toolkit (version 4.4.0 or newer).
+LyX 2.0 uses the Qt 4.x toolkit (see INSTALL file).
 
 If you do not have the JPEG library installed, you may need to install it
 before you can use the graphics capabilities of LyX. If you do not have the
@@ -126,6 +145,37 @@ Furthermore, LyX uses a converter layout2layout.py, also written in python
 that will convert old layout files on the fly. You can also call it manually
 on your layout files if you want to convert them to 2.0.x format permanently.
 
+* Formatted references
+
+Before version 2.0, LyX used the LaTeX package "prettyref" to produce 
+"formatted references", such as "Section 2.1". This package has several 
+shortcomings when used in a non-English environment, not least of which is 
+that it has no mechanism for internationalization. (See bug #6421 and those
+it references.) 
+
+As of LyX 2.0, users can choose whether to use prettyref or, alternatively,
+the "refstyle" package. The current version of refstyle, v0.5, ships with 
+translations for several languages and provides an easy mechanism for users
+to translate the references it produces into still other languages. It also 
+defines many more commands than prettyref does, including, for example, ones
+to produce "ranges", such as "Sections 2.1 to 2.3". Some LyX developers are 
+already working with the refstyle maintainer, Danie Els, to make it work more 
+easily  with LyX and to extend the translations it provides. (You are invited 
+to contribute translations, too!)
+
+Because many LyX users already have customized prettyref for their purposes,
+LyX 1.6.x files opened in LyX 2.0 will continue to use prettref by default.
+New LyX 2.0 files will use refstyle by default. Both can of course be changed 
+in Document>Settings. Please be advised, however, that prettyref support is to
+be considered deprecated: It may well be removed in LyX 2.1, and all users are
+encouraged to adapt their layout files, etc, to refstyle.
+
+Doing so is fairly simple. With prettyref, one has declarations such as:
+    \newrefformat{for}(Formula \ref{#1}}
+The refstyle equivalent is:
+    \newref{for}{refcmd={Formula \ref{#1}}}
+The translation is obviously trivial.
+
 * Preparing for Unicode:
 
 As of version 1.5.0, LyX uses Unicode internally. This is a major change that
@@ -134,8 +184,8 @@ transition as smooth as possible for you. However, there are some caveats:
 
 - User layout files must be converted to UTF-8
 
-  In previous versions, layout styles were allowed to use non-ASCII names
-  using the local encodings. LyX-1.5 now assumes that all layout files are
+  In versions prior to 1.5.0, layout styles were allowed to use non-ASCII names
+  using the local encodings. LyX-1.5 and later assume that all layout files are
   UTF-8 encoded. This means that non-ASCII style names are still allowed
   but they must be valid UTF-8 strings. One way of doing the conversion
   is to use iconv. Using bash, the script below should work:
@@ -205,4 +255,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