development/FORMAT

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