development/FORMAT

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