development/FORMAT

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