development/FORMAT

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