development/FORMAT

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