development/FORMAT

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