development/FORMAT

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