development/FORMAT

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