development/FORMAT

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