development/FORMAT

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