development/FORMAT

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