development/FORMAT

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