development/FORMAT

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