development/FORMAT

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