development/FORMAT

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