development/FORMAT

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