development/FORMAT

   1 LyX file-format changes
   2 -----------------------
   3
   4 2004-03-29  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
   5
   6         * format incremented to 231.
   7
   8         * Support for sidewaysfigure/sidewaystable (rotating package).
   9         insetfloat has now a param \sideways [true|false] (default is false).
  10         The param should be erased on downwards conversion, if it was true,
  11         the inset should be replaced by
  12         \begin{sidewaysfigure} <content> \end{sidewaysfigure}
  13         resp.
  14         \begin{sidewaystable} <content> \end{sidewaystable}
  15         i.e. ERT.
  16
  17 2004-02-23  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
  18
  19         * format incremented to 230.
  20
  21         * Support for a second optional argument in insetcommand.
  22         currently, citation uses this to support natbibs second
  23         optional argument \cite[before][after]{key}.
  24         I think there's nothing to convert upwards. Downwards, the
  25         commands with 2 optional args need to be converted to ERT.
  26
  27         * Support for jurabib (param \use_jurabib [1|0], default is 0).
  28         When converting downwards, \usepackage{jurabib} has to be added
  29         to the preamble and, if babel is used, \usepackage{babel} before
  30         (jurabib fails if babel is called afterwards). If the natbib commands
  31         are used together with jurabib, they have to be converted to ERT too.
  32
  33 2003-12-29  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
  34
  35         * format incremented to 229.
  36         * Minipages cannot be read anymore. All minipage insets will
  37         be converted to frameless box insets between 228->229.
  38
  39 2003-12-15  Angus Leeming  <leeming@lyx.org>
  40
  41         * format incremented to 228.
  42         * Change the output of all insets derived from InsetCollapsable
  43         except for InsetERT (which has a similar output already), changing lines
  44         "collapsed true" -> "status collapsed"
  45         "collapsed false" -> "status open".
  46         * Change the output of InsetERT, changing lines
  47         "status Collapsed" -> "status collapsed"
  48         "status Open" -> "status open".
  49         "status Inlined" -> "status inlined".
  50
  51 2003-12-10  Angus Leeming  <leeming@lyx.org>
  52
  53         * format NOT incremented.
  54         * add a 'draft' option to InsetExternal.
  55
  56 2003-12-10  Angus Leeming  <leeming@lyx.org>
  57
  58         * format incremented to 227.
  59         * Change the output of InsetBox:
  60         \begin_inset Boxed -> \begin_inset Box Boxed
  61         \begin_inset Doublebox -> \begin_inset Box Doublebox
  62         \begin_inset Frameless -> \begin_inset Box Frameless
  63         \begin_inset ovalbox -> \begin_inset Box ovalbox
  64         \begin_inset Ovalbox -> \begin_inset Box Ovalbox
  65         \begin_inset Shadowbox -> \begin_inset Box Shadowbox
  66
  67 2003-12-10  Angus Leeming  <leeming@lyx.org>
  68
  69         * format incremented to 226.
  70         * Change the output of InsetNote:
  71         \begin_inset Note -> \begin_inset Note Note
  72         \begin_inset Comment -> \begin_inset Note Comment
  73         \begin_inset Greyedout -> \begin_inset Note Greyedout
  74
  75 2003-11-28  André Pönitz
  76
  77         * Remove space_above/space_below from Paragraph.
  78     This is now handled by InsetVSpace.
  79
  80 2003-10-07  Angus Leeming  <leeming@lyx.org>
  81
  82         * Add transformations to InsetExternal
  83
  84         boundingBox 0 0 20 20           the dimensions of the B.B..
  85                                         Output if the B.B. is not empty.
  86         clip                            clip the image to the B.B.
  87                                         Output if true.
  88         extra LaTeX "draft"             'extra' data passed to the primary
  89                                         command for this output format.
  90                                         (Possible formats LaTeX, PDFLaTeX,
  91                                          LinuxDoc, DocBook, Ascii.)
  92                                         The string can contain spaces and so
  93                                         is wrapped in "...".
  94         rotateAngle 30                  Rotation of the data.
  95                                         Output for non-zero rotation only.
  96         rotateOrigin bottomleft         Rotation origin.
  97                                         Output for non-zero rotation and
  98                                         non-default origin (center) only.
  99         scale 50
 100         width 2cm                       Output only if the image is resized.
 101         height 2cm
 102         keepAspectRatio
 103
 104 2003-10-07  Martin Vermeer  <martin.vermeer@hut.fi>
 105
 106         * Added box inset. File format:
 107
 108         \begin_inset Ovalbox            Boxed/Frameless/ovalbox/Ovalbox
 109                                             /Shadowbox/Doublebox
 110         position "b"                    t/c/b
 111         hor_pos "c"                     l/c/r/s
 112         has_inner_box 1                 1/0
 113         inner_pos "b"                   t/c/b/s
 114         use_parbox 0                    1/0
 115         width "100col%"                 unit+width-string
 116         special "none"                  none/height/depth
 117                                             /totalheight/width
 118         height "1in"                    unit+width-string
 119         height_special "totalheight"    none/height/depth
 120                                             /totalheight/width
 121         collapsed false                 true/false
 122
 123         \begin_layout Standard
 124
 125         <box contents>
 126         \end_layout
 127
 128         \end_inset
 129
 130         This box (Frameless, has_inner_box=1, use_parbox=0) replaces
 131         the pre-existing Minipage inset. Parameters translate as follows:
 132         position                        0/1/2   -> t/c/b
 133         inner_position                  0/1/2/3 -> inner_pos c/t/b/s
 134         height                          same
 135         width                           same
 136         collapsed                       same
 137
 138 2003-08-19  Michael Schmitt  <michael.schmitt@teststep.org>
 139
 140         * attribute valignment="center" is replaced by valignment="middle"
 141         for tabular columns and cells
 142
 143 2003-07-28  José Matos  <jamatos@lyx.org>
 144
 145         * \the_end is replaced with \end_document
 146
 147 2003-07-28  José Matos  <jamatos@lyx.org>
 148
 149         * \layout is replaced with \begin_layout
 150
 151 2003-07-28  José Matos  <jamatos@fep.up.pt>
 152
 153         Format bumped to 225
 154
 155         * All layouts finish now with \end_layout
 156
 157 2003-06-04  Angus Leeming  <leeming@lyx.org>
 158
 159         Format bumped to 224
 160
 161         * the storage of the external inset has been changed from
 162
 163                 \begin_inset External XFig,"file.fig",""
 164
 165                 \end_inset
 166
 167         to this
 168
 169                 \begin_inset External
 170                         template XFig
 171                         filename file.fig
 172                         display <display_type>
 173                         lyxscale <scale>
 174
 175                 \end_inset
 176
 177         throwing away the final arg (here "", more generally "<string>") that holds
 178         the parameters variable.
 179         Variables are output if present (filename) or different from the default
 180         values (display, lyxscale).
 181
 182         Moreover, the RasterImage template has been scrapped. All RasterImage
 183         external insets are now converted to Graphics insets.
 184
 185 2003-05-20  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
 186
 187         * Added new space insets:
 188                 \SpecialChar ~ is now \InsetSpace ~
 189                 ERT: "\ " could be converted to InsetSpace \<space>
 190                 ERT: "\," could be converted to InsetSpace \,
 191
 192 2003-03-12  John Levon  <levon@movementarian.org>
 193
 194         * Added \\end_header to signify the end of the header in a
 195           more robust fashion.
 196
 197         * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
 198
 199 2003-02-10  John Levon  <levon@movementarian.org>
 200
 201         Format bumped to 222
 202
 203         Added \\tracking_changes 0|1 to the header.
 204
 205         Added \\author to the header. This can be present multiple
 206         times, and is of the form :
 207
 208         \\author "Real Name" email@address.com
 209
 210         Added \\change_deleted, \\change_inserted. Each of these does not
 211         span a paragraph, and is delimited by "\\change_unchanged\n". Both are
 212         of the form :
 213
 214         \\change_inserted author time
 215
 216         where author is an integer ID reference into the author list in
 217         the header, and time is time_t.
 218
 219 2002-10-24  Rob Lahaye  <lahaye@snu.ac.kr>
 220
 221         * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
 222
 223 2002-08-22  Rob Lahaye <lahaye@snu.ac.kr>
 224
 225 New graphics dialog. With the removal of buttons in the dialog, also
 226 keywords in the graphics inset went. The following keywords do not
 227 exist anymore:
 228         lyxsize_kind
 229         lyxsize_type
 230         lyxwidth
 231         lyxheight
 232         size_kind
 233         size_type
 234         rotate
 235
 236 Only non-default values are saved to the lyx files. The defaults of the remaining
 237 keywords are;
 238         filename <empty>
 239         lyxscale 100
 240         display default
 241         scale 100
 242         width <empty>
 243         height <empty>
 244         draft <off>
 245         noUnzip <off>
 246         BoundingBox <from file>
 247         clip <off>
 248         rotateAngle 0
 249         rotateOrigin centerBaseline
 250         subcaption <off>
 251         subcaptionText <empty>
 252         special <empty>
 253
 254 The remaining keywords have sufficient overlap with the old ones for a
 255 smooth reading of the 1.2.x inset keywords in most common cases.
 256
 257 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
 258 They don't exist anymore and we can't translate them into a scaling value, while
 259 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
 260 argument is ignored and lost.
 261
 262 Only few compatibility issues are left for lyx2lyx:
 263
 264 ------------------------------------------------------------------------------
 265 old-token                                   new-token         remove
 266 ------------------------------------------------------------------------------
 267 size_kind original / size_type 0            scale 100         width <val>
 268                                                               height <val>
 269                                                               scale <val>
 270
 271 size_kind width_height / size_type 1            -             scale <val>
 272
 273 lyxsize_kind original / lyxsize_type 0      lyxscale 100      lyxscale <val>
 274 ------------------------------------------------------------------------------
 275 [replace old-token by new-token, and remove any of subsequent tokens as listed]
 276
 277 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
 278    if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
 279    then
 280         replace "rotateAngle <val>" by "rotateAngle 0"
 281
 282
 283 2002-08-12  Andre' Poenitz <poenitz@gmx.de>
 284
 285 Added \lyxlock for locked math inset when written to .lyx file.
 286 When "downgrading" .lyx files this should simple be deleted but it
 287 does not hurt at all if it stays in. It does not have to be added
 288 when "upgrading".
 289
 290
 291 2002-08-02  Angus Leeming  <leeming@lyx.org>
 292
 293 Added a boolean "preview" flag to InsetCommandParams.
 294 Currently it is written only by InsetInclude, because only this
 295 class can generate a preview of its contents.
 296
 297 The LyX file now contains:
 298
 299  \begin_inset Include \input{snapshot_t=40.tex}
 300 +preview true
 301
 302  \end_inset
 303
 304 Earlier versions of LyX just swallow this extra token silently.
 305
 306 2002-08-12  Angus Leeming  <leeming@lyx.org>
 307
 308 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
 309 renamed as "size_kind" and "lyxsize_kind" respectively.
 310
 311  \begin_inset Graphics FormatVersion 1
 312         filename file.eps
 313         display default
 314 -       size_kind original
 315 +       size_type original
 316         width 7cm
 317         rotateOrigin center
 318 -       lyxsize_kind original
 319 +       lyxsize_type original
 320         lyxwidth 4cm
 321
 322  \end_inset
 323