development/FORMAT

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