development/FORMAT

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