development/FORMAT

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