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