UPGRADING

   1 How do I upgrade my existing LyX system to version 1.4.x?
   2 ---------------------------------------------------------
   3
   4 The format of the preferences file has changed slightly. LyX 1.4.x is
   5 able to read old preferences files, but it will save them in the new
   6 format, so it is not possible to run LyX 1.3.x and 1.4.x with the same
   7 personal configuration directory.
   8
   9 The format of the layout files has also changed, but LyX 1.4.x uses a
  10 converter layout2layout.py written in python that will convert old layout
  11 files on the fly. You can also call it manually on your layout files if
  12 you want to convert them to 1.4.x format permanently.
  13
  14 The format of the external template file has changed substantially.
  15 Automatic conversion is not available, so you need to convert your
  16 external templates manually. The new format of the external template
  17 configuration file is described in chapter 6.5 of the Customization Guide.
  18
  19 And of course, if you upgrade from LyX 1.2.x, remember that since
  20 1.3.0, you have to do the following changes:
  21
  22 One of the perennial bug bears of LyX users in the past has been that
  23 they have had to run Edit->Reconfigure when starting their new version
  24 of the code for the first time. Strange and wonderful things would
  25 often result if they forgot to do this, so LyX 1.3.0 now runs
  26 Edit->Reconfigure automatically the first time the program is run.
  27
  28 If you have your own layout files, you may need to update them a little:
  29
  30 - floats are now defined in the layout file, using the "Float"..."End"
  31   construct. In most cases, adding "Input stdfloats.inc" to your layout
  32   file is enough.
  33
  34 - counters are also defined in the layout files, using the
  35   "Counter"..."End" construct. As for floats, adding "Input
  36   stdfloats.inc" is probably a good idea.
  37
  38 And of course, if you upgrade from LyX 1.1.x, remember that since
  39 1.2.0, you have to do the following changes:
  40
  41 - all layout files should have a "DefaultStyle" entry
  42
  43 - the "Latex" font style does not exist anymore. If you really need
  44   its functionality, consider using the "PassThru" keyword instead.
  45
  46 The new layout format keywords are described in the Customization
  47 manual.
  48
  49 If you have your own binding files (especially math.bind), you will
  50 have to update them
  51
  52 - math-insert now takes a latex macro name as argument, so that
  53   "math-insert sqrt" should now be "\math-insert \sqrt"
  54
  55 - math-greek-toggle is now gone, and should be replaced by explicit
  56   bindings like
  57
  58   \bind "M-m g a"      "math-insert \alpha"
  59
  60
  61 Build requirements
  62 ------------------
  63
  64 LyX's graphics handling system has changed substantially. If you
  65 do not have the JPEG library installed, you may need to install
  66 it before you can use the graphics capabilities of LyX. If you
  67 do not have the ImageMagick command-line tools installed, you
  68 will need to modify the default set up of LyX, or install them,
  69 in order to get previews of your document's graphics.
  70
  71 Document transfer
  72 -----------------
  73
  74 LyX 1.4.x uses an external python script, lyx2lyx, to import documents
  75 written using previous versions of LyX. All versions of LyX as far back as
  76 0.12 are supported, so any klyx users still holding out for an alternative
  77 to xforms will finally be able to put their dinosaur to rest ;-)
  78
  79 Of course, this means that you must have python (at least version 1.5.2)
  80 installed in order to use LyX 1.4.x with your old documents.
  81
  82 lyx2lyx also has the framework in place to be able to convert documents
  83 to an earlier format. However, these converters have only been written
  84 for the conversion from 1.4.x to 1.3.x, so versions of LyX older than
  85 1.3.0 will NOT be able to read documents saved with LyX 1.4.x.
  86 The conversion from 1.4.x to 1.3.x is lossless as long as no new features
  87 are used. lyx2lyx tries hard to find something equivalent for new
  88 features such as boxes, but this is known to fail sometimes.
  89 LyX 1.3.7 contains an updated lyx2lyx that can read documents in 1.4.x
  90 format. LyX 1.4.x can also export to 1.3.x format for document transfer to
  91 older 1.3.x releases.
  92
  93 If you were previously (in LyX 1.1.x) using the floatflt paragraph
  94 option to wrap text around a figure, it was necessary to modify this
  95 for LyX 1.2.0 manually, as described in the manuals. The feature has
  96 been re-implemented as "Floting figure" inset in 1.3.0. Old files will
  97 be converted automatically, but you may want to convert the
  98 1.2.x-style ERT constructs with the native solution (see section 3.8
  99 of the Extended Features manual).
 100
 101 Since LyX 1.2.0, the babel package is loaded after the user-defined
 102 preamble (because some packages really need to be loaded before
 103 babel). If you relied, on babel being loaded before your own
 104 definitions, you can add an extra "\usepackage{babel}" statement at
 105 the beginning of your preamble.
 106
 107 http://bugzilla.lyx.org/show_bug.cgi?id=315