]> git.lyx.org Git - lyx.git/blobdiff - UPGRADING
use rpmbuild
[lyx.git] / UPGRADING
index 1d9e81a15888b5338a1e0654286914c42beb2c9d..749cc484c4441c512fc08a6b836353ca561e3071 100644 (file)
--- a/UPGRADING
+++ b/UPGRADING
@@ -1,27 +1,85 @@
-How do I upgrade my existing LyX system to version 1.0.4?
+How do I upgrade my existing LyX system to version 1.2.x?
 ---------------------------------------------------------
 
-If you upgrade from version 0.12.0 or 1.0.x, you shouldn't have 
-any problems.  Just run "make install", and it will automatically
-update the necessary files, provided that you install LyX the
-same place as an existing version.
+If you upgrade from version 1.1.6 or 1.1.5, you shouldn't have any
+problems. It is nevertheless a good idea to advise all users to run
+Edit->Reconfigure.
 
+If you have your own layout files, you may need to update them a little:
+
+- all layout files should have a "DefaultStyle" entry
+
+- the "Latex" font style does not exist anymore. If you really need
+  its functionality, consider using the "PassThru" keyword instead.
+
+The new layout format keywords are described in the Customization
+manual.
+
+If you have your own binding files (especially math.bind), you will
+have to update them
+
+- math-insert now takes a latex macro name as argument, so that
+  "math-insert sqrt" should now be "\math-insert \sqrt"
+
+- math-greek-toggle is now gone, and should be replaced by explicit
+  bindings like
+
+  \bind "M-m g a"      "math-insert \alpha"
+
+
+Build requirements
+------------------
+
+LyX's graphics handling system has changed substantially. 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 ImageMagick command-line tools installed, you
+will need to modify the default set up of LyX, or install them,
+in order to get previews of your document's graphics.
+
+Note: if you are using convert, and the graphics won't load in LyX,
+then you are probably seeing a bug in earlier versions of ImageMagick.
+You can either upgrade ImageMagick, change the convertor to use
+"convert -depth 8", which shold work around the problem, or set up
+a convertor to use a different conversion program as described in
+the documentation.
+
+http://bugzilla.lyx.org/show_bug.cgi?id=360
 Document transfer
 -----------------
 
 In general, you don't need to convert any documents saved with LyX
-v0.10, v0.12.0 or v1.0.x to use them with LyX v1.0.4.
+1.1.5 or 1.1.6 to use them with LyX 1.2.0.
+
+Older versions of LyX cannot read documents saved with LyX 1.2.0.
+LyX 1.2.0 can read most documents saved with lyx 1.1.6 correctly.
 
-LyX v1.0.x can read all documents saved with lyx-0.12.0 and later correctly.
-Documents saved with lyx-0.10.x are read correctly up to the old math 
-mode, which is not supported anymore. If you have documents with such 
-math formulas, you convert it using the program COLD, written by Preben 
-Rhandol. COLD can be found at:
+If you were previously using the floatflt paragraph option to
+wrap text around a figure, you will need to modify this for LyX 1.2.0
+manually, as described in the manuals. Please ask on the lyx-users
+list for assistance if you have trouble with this.
+Note that your document may rely on the floatflt package (for example,
+you may use \floatingfigure via LaTeX commands). If your document does
+not have "\usepackage{floatflt}" already in the user pre-amble, you will
+need to add it.
+The babel package is now loaded after the user-defined
+preamble (because some packages really need to be loaded before
+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://www.pvv.org/~randhol/lyx/COLD/
-  ftp://ftp.lyx.org/pub/lyx/contrib/
+http://bugzilla.lyx.org/show_bug.cgi?id=315
 
-or at one of LyX archive mirror sites listed in README.
+If you are using the minipage paragraph options in your document, you
+may find that LyX 1.2.0 fails to import them correctly as minipages.
+This might require some editing to correct this. If you have
+trouble with this, please ask the lyx-users mailing list for assistance,
+and we will be happy to help.
 
-Documents saved with LyX version 1.0.4 can be read correctly by 
-LyX v0.12.0 and v1.0.x, except for new features.
+http://bugzilla.lyx.org/show_bug.cgi?id=374
+http://bugzilla.lyx.org/show_bug.cgi?id=375
+http://bugzilla.lyx.org/show_bug.cgi?id=376