development/FORMAT

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