development/FORMAT

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