development/FORMAT

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