development/FORMAT

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