development/FORMAT

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