development/FORMAT

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