UPGRADING

   1 How do I upgrade my existing LyX system to version 1.6.x?
   2 ---------------------------------------------------------
   3
   4 * Upgrading from LyX 1.4.x and earlier:
   5
   6 The biggest change in 1.5 is the switch to Unicode. Please refer to
   7 the section "Document transfer" below for some things you might take
   8 into account before upgrading.
   9
  10 The format of the preferences file has changed slightly. LyX 1.5.x is
  11 able to read old preferences files, but it will save them in the new
  12 format, so it is not possible to run LyX 1.4.x and 1.5.x with the same
  13 personal configuration directory. If you are upgrading from 1.4.x and
  14 do not intend to continue using 1.4.x, you should delete your existing
  15 preferences file and allow LyX to create a new one.
  16
  17 The list of recently open files is now stored in a different location.
  18 It will therefore be reset when upgrading from LyX 1.4.x.
  19
  20 The format of the layout files has also changed, but LyX 1.5.x uses a
  21 converter layout2layout.py written in python that will convert old layout
  22 files on the fly (see below, section "Document transfer").
  23
  24 * Upgrading from LyX 1.3.x:
  25
  26 The format of the external template file has changed substantially with
  27 LyX 1.4.0. Automatic conversion is not available, so you need to convert
  28 your external templates manually. The new format of the external template
  29 configuration file is described in chapter 6.5 of the Customization Guide.
  30
  31 * Upgrading from LyX 1.2.x:
  32
  33 Since 1.3.0, you have to do the following changes:
  34
  35 One of the perennial bug bears of LyX users in the past has been that
  36 they have had to run Edit->Reconfigure when starting their new version
  37 of the code for the first time. Strange and wonderful things would
  38 often result if they forgot to do this, so LyX 1.3.0 now runs
  39 Edit->Reconfigure automatically the first time the program is run.
  40
  41 If you have your own layout files, you may need to update them a little:
  42
  43 - floats are now defined in the layout file, using the "Float"..."End"
  44   construct. In most cases, adding "Input stdfloats.inc" to your layout
  45   file is enough.
  46
  47 - counters are also defined in the layout files, using the
  48   "Counter"..."End" construct. As for floats, adding "Input
  49   stdfloats.inc" is probably a good idea.
  50
  51 * Upgrading from LyX 1.1.x:
  52
  53 - all layout files should have a "DefaultStyle" entry
  54
  55 - the "Latex" font style does not exist anymore. If you really need
  56   its functionality, consider using the "PassThru" keyword instead.
  57
  58 The new layout format keywords are described in the Customization
  59 manual.
  60
  61 If you have your own binding files (especially math.bind), you will
  62 have to update them
  63
  64 - math-insert now takes a latex macro name as argument, so that
  65   "math-insert sqrt" should now be "\math-insert \sqrt"
  66
  67 - math-greek-toggle is now gone, and should be replaced by explicit
  68   bindings like
  69
  70   \bind "M-m g a"      "math-insert \alpha"
  71
  72
  73 Build requirements
  74 ------------------
  75
  76 LyX 1.5 uses the Qt 4.x toolkit (version 4.1.1 or newer). Contrary to
  77 previous versions of LyX, it won't build against Qt 2.x or 3.x.
  78 Furthermore, the XForms frontend was dropped.
  79
  80 LyX's graphics handling system has changed substantially. If you
  81 do not have the JPEG library installed, you may need to install
  82 it before you can use the graphics capabilities of LyX. If you
  83 do not have the ImageMagick command-line tools installed, you
  84 will need to modify the default set up of LyX, or install them,
  85 in order to get previews of your document's graphics.
  86
  87 Document transfer
  88 -----------------
  89
  90 * Compatibility with older documents/layouts
  91
  92 LyX 1.5.x uses an external python script, lyx2lyx, to import documents
  93 written using previous versions of LyX. All versions of LyX as far back as
  94 0.12 are supported, so any klyx users still holding out for an alternative
  95 to xforms will finally be able to put their dinosaur to rest ;-)
  96
  97 Of course, this means that you must have python (at least version 2.3)
  98 installed in order to use LyX 1.5.x with your old documents.
  99
 100 lyx2lyx also has the framework in place to be able to convert documents
 101 to an earlier format (which requires python 2.3.4 at least). However,
 102 these converters have only been written for the conversion from 1.5.x
 103 to 1.4.x and 1.3.x, so versions of LyX older than 1.3.0 will NOT be able
 104 to read documents saved with LyX 1.5.x. The conversion from 1.5.x to
 105 1.4.x/1.3.x is lossless as long as no new features are used. lyx2lyx
 106 tries hard to find something equivalent for new features such as boxes,
 107 but this is known to fail sometimes. LyX 1.4.5.1 contains an updated
 108 lyx2lyx that can read documents in 1.5.x format. LyX 1.5.x can also
 109 export to 1.4.x format for document transfer to older 1.4.x releases.
 110
 111 Furthermore, LyX uses a converter layout2layout.py, also written in python
 112 that will convert old layout files on the fly. You can also call it manually
 113 on your layout files if you want to convert them to 1.5.x format permanently.
 114
 115 * Preparing for Unicode:
 116
 117 As of version 1.5.0, LyX uses Unicode internally. This is a major change that
 118 affects documents and layouts likewise. We have tried to do out best to make the
 119 transition as smooth as possible for you. However, there are some caveats:
 120
 121 - User layout files must be converted to UTF-8
 122
 123   In previous versions, layout styles were allowed to use non-ASCII names
 124   using the local encodings. LyX-1.5 now assumes that all layout files are
 125   UTF-8 encoded. This means that non-ASCII style names are still allowed
 126   but they must be valid UTF-8 strings. One way of doing the conversion
 127   is to use iconv. Using bash, the script below should work:
 128
 129      #! /bin/sh
 130
 131      cd /path/to/layouts
 132      for l in *
 133      do
 134        cp "$l" tmp.txt
 135        iconv -f latin1 -t utf8 tmp.txt -o "$l"
 136      done
 137      rm -f tmp.txt
 138
 139 - Inset encodings and Conversion from earlier LyX versions
 140
 141   As part of the transition to unicode, lyx2lyx (the scripts used for converting
 142   back and forth between different versions of the lyx files) converts old .lyx
 143   files, which may use a number of different encodings, to UTF-8. This conversion
 144   depends on correctly identifying the language of the text. There were previously
 145   some edge-cases (insets embedded in different-language text type scenarios) in
 146   which the language was incorrectly identified, which caused some text to
 147   appear incorrectly after having upgraded from older versions. This has now been
 148   fixed. Unfortunately, however, the fix cannot be applied to files which have
 149   already been converted past format 249. So if you have already converted
 150   your old files (using a development version or release candidate), this fix
 151   won't help, unless you still have the originals lying around (and haven't
 152   yet made too many changes to the newer versions ;) ).
 153
 154 Generally, it is probably wise to keep a backup of the old version of your
 155 files, at least until you are sure that the upgrade went smoothly (which it
 156 almost always will).
 157
 158 * Languages/encodings and insets
 159
 160 One of the bugs fixed in LyX 1.5.0 is that previously, there were certain
 161 specific cases in which the LaTeX generated did not correctly reflect
 162 language/encoding transitions in and around insets (footnotes, LyX notes).
 163 After much deliberation, it was decided not to change older files such that
 164 they will still reflect the old LaTeX output; rather, they will now correctly
 165 reflect the situation as it appears in the GUI. This means, however, that if
 166 you mangled the text in the GUI in the older versions, in order that it
 167 generate the correct LaTeX output, the LaTeX will now generate the mangled
 168 text. If this is problematic for you, please get in touch with us on the
 169 developers mailing list, we do have some possible solutions for this.
 170
 171 The effects of this will be more pronounced for RTL (Hebrew, Arabic, Farsi)
 172 users -- though they affect users of other languages as well.
 173
 174 * Floatflt in 1.2.x and older
 175
 176 If you were previously (in LyX 1.1.x) using the floatflt paragraph
 177 option to wrap text around a figure, it was necessary to modify this
 178 for LyX 1.2.0 manually, as described in the manuals. The feature has
 179 been re-implemented as "Floating figure" inset in 1.3.0. Old files will
 180 be converted automatically, but you may want to convert the
 181 1.2.x-style ERT constructs with the native solution (see section 3.8
 182 of the Extended Features manual).
 183
 184 * Babel changes since 1.2.x
 185
 186 Since LyX 1.2.0, the babel package is loaded after the user-defined
 187 preamble (because some packages really need to be loaded before
 188 babel). If you relied, on babel being loaded before your own
 189 definitions, you can add an extra "\usepackage{babel}" statement at
 190 the beginning of your preamble.
 191
 192 http://bugzilla.lyx.org/show_bug.cgi?id=315