1 LyX file-format changes
2 -----------------------§
4 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 252: changed command inset syntax
10 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
21 \begin_inset LatexCommand cmdname
28 The order of the parameters and for each parameter the name and
29 optional/required bit is now stored in InsetCommandParams.
32 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
34 * format incremented to 251: save show_label param for charstyles.
36 On revert, the show_label param is just removed. Nothing to convert.
38 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
40 * Format incremented to 250: allow optional arg to environments
42 No material format change. Now optargs for environments are allowed
43 to be specified in layout files and will be handled properly. When
44 converted back to older formats, they will be ignored in LaTeX
47 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
49 * format incremented to 249: Unicode
51 LyX documents are now always encoded in utf8. The value of
52 \inputencoding does now only determine the encoding of the created
54 Up to format 248 the value of \inputencoding did also determine the
55 encoding of the LyX file:
57 \inputencoding LyX file encoding
58 auto as determined by the document language
60 everything else as determined by \inputencoding
62 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
64 * format incremented to 248: Basic booktabs support
66 The <features> tag has a new switch: booktabs="true|false".
67 An absent switch is equivalent to booktabs="false".
68 Horizontal lines are set with the booktabs package if this switch
71 The <row> tag of tabulars has the following new attributes:
72 topspace, bottomspace and interlinespace. All take a LyXLength
73 as value, or the special keyword "default".
75 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
77 * format incremented to 247. The Grand Font Interface Rewrite.
78 (1) Split font selection to rm, sf, tt:
79 \fontscheme -> \font_roman, \font_sans, \font_typewriter
81 \fontscheme \font_roman \font_sans \font_typewriter
82 default default default default
84 times times default default
85 palatino palatino default default
86 helvet default helvet default
87 avant default avant default
88 newcent newcent default default
89 bookman bookman default default
90 pslatex times (or \usepackage{pslatex})
92 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
93 lmodern, charter, utopia, ccfonts, chancery, beraserif
94 (-> \usepackage{<name>})
95 \font_sans: cmss, lmss, cmbr
96 (-> \renewcommand{\sfdefault}{<name>})
97 berasans (-> \usepackage{<name>})
98 \font_typewriter: cmtt, lmtt, cmtl,
99 (-> \renewcommand{\sfdefault}{<name>})
100 courier, luximono, beramono
101 (-> \usepackage{<name>})
102 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
103 (3) New param \font_sc (true, false).
104 (4) New param \font_osf (true, false).
105 (5) New param \font_sf_scale (float)
106 (6) New param \font_tt_scale (float)
107 Support for the following fonts has been added:
108 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
109 courier, lmodern, luximono, utopia.
110 Support for the following font has been removed:
111 pslatex (it's superseded by mathptmx (times)).
113 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
115 * format incremented to 246. The framed.sty package is
116 now supported with note types framed and shaded.
118 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
120 * format incremented to 245. The \quotes_times parameter
123 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
125 * format incremented to 244. Rename '\InsetSpace \,'
126 to '\InsetSpace \thinspace{}', because the comma was
127 not parsed by lyxlex, and '\InsetSpace \space' to
128 '\InsetSpace \space{}' in favour of consistency.
130 2005-07-18 José Matos <jamatos@lyx.org>
132 * format incremented to 243.
134 * this change only affects the preamble, the paperpackage
135 option was removed and papersize is changed to default.
137 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
139 * format incremented to 242. There is no file format per
140 se, but the "frenchb" language has been removed from lib/language
141 and has to be translated to "french" by lyx2lyx.
143 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
145 * format incremented to 241.
147 All following changes apply only to text in ERT insets. The
148 rationale is that text in ERT is simply ASCII text, and nothing more.
150 * paragraph breaks are now a single newline in latex and not a
151 paragraph break anymore (bug 698).
152 * \newline is not allowed anymore, because it is redundant (see above)
153 * layouts other than Standard, paragraph parameters and font changes
154 are not allowed anymore. They never made sense and were ignored for
155 latex output, but now they can't be read or set anymore (bug 922).
158 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
160 * format incremented to 240.
162 \output_changes {true|false}
163 (should the change tracking marks be visible in the output or not?)
164 * lyx2lyx should just delete the param in 239.
166 2005-01-06 José Matos <jamatos@lyx.org>
168 * format incremented to 239.
169 * the paragraph parameters are displayed in their own line. This
170 change is consistent with the insets behaviour, and corresponds
171 to a more uniform treatment of the paragraphs since some of them
172 had already their own line.
174 An example of a single paragraph follows:
176 \begin_layout Standard
177 \paragraph_spacing single
183 2004-12-03 José Matos <jamatos@lyx.org>
185 * format incremented to 238.
186 * The compatibility code to read old latex accents from 0.12.x in
187 InsetLatexAccent::checkContents has been removed.
188 The following translations are done:
190 "\i \xy" -> "\i \x{y}"
191 "\i \x y" -> "\i \x{y}"
192 "\i \x\i" -> "\i \x{\i}"
193 "\i \x\j" -> "\i \x{\j}"
194 x is a latex accent command, y the base character. \, i and j are
196 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
197 so formats 215 - 237 can have both versions.
200 2004-10-10 José Matos <jamatos@lyx.org>
202 * format incremented to 237.
203 * In the header, the following statments use now booleans values,
209 2004-08-15 José Matos <jamatos@lyx.org>
211 * format incremented to 236.
218 * The options for \papersize are changed:
221 * All whitespaces are removed at the end of lines, when
222 not necessary. As an example we have all the lines in the header that
223 do not belong to the preamble.
225 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
227 * format incremented to 235.
228 * \paperpackage had an off-by-one error. Translation table:
230 234: a4 a4wide widemarginsa4
231 235: none a4 a4wide widemarginsa4
233 The "widemarginsa4" setting of 235 has no equivalent in 234.
235 2004-05-12 Angus Leeming <leeming@lyx.org>
237 * format incremented to 234.
238 * the citation engine is specified explicitly rather than being
239 deduced from 3 bools.
242 \use_numerical_citations 0 -> \cite_engine <style>
245 where <style> is one of "basic", "natbib_authoryear",
246 "natbib_numerical" or "jurabib".
248 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
250 * format incremented to 233.
251 * insetgraphics does not allow filenames without extension anymore.
252 The complete filename has to be given.
254 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
256 * format incremented to 232.
258 * Support for bibtopic (sectioned bibliographies).
259 - bufferparam \use_bibtopic [1|0]
260 - the bibtex inset has a second argument for bibtopic's
261 btPrint{Cited|NotCited|All} command:
263 \begin_inset LatexCommand \bibtex[<style>]{<database>}
265 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
266 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
267 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
268 \bibliographystyle{<style>}
269 \begin{btSect}{<database>}
274 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
276 * format incremented to 231.
278 * Support for sidewaysfigure/sidewaystable (rotating package).
279 insetfloat has now a param \sideways [true|false] (default is false).
280 The param should be erased on downwards conversion, if it was true,
281 the inset should be replaced by
282 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
284 \begin{sidewaystable} <content> \end{sidewaystable}
287 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
289 * format incremented to 230.
291 * Support for a second optional argument in insetcommand.
292 currently, citation uses this to support natbibs second
293 optional argument \cite[before][after]{key}.
294 I think there's nothing to convert upwards. Downwards, the
295 commands with 2 optional args need to be converted to ERT.
297 * Support for jurabib (param \use_jurabib [1|0], default is 0).
298 When converting downwards, \usepackage{jurabib} has to be added
299 to the preamble and, if babel is used, \usepackage{babel} before
300 (jurabib fails if babel is called afterwards). If the natbib commands
301 are used together with jurabib, they have to be converted to ERT too.
303 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
305 * format incremented to 229.
306 * Minipages cannot be read anymore. All minipage insets will
307 be converted to frameless box insets between 228->229.
309 2003-12-15 Angus Leeming <leeming@lyx.org>
311 * format incremented to 228.
312 * Change the output of all insets derived from InsetCollapsable
313 except for InsetERT (which has a similar output already), changing lines
314 "collapsed true" -> "status collapsed"
315 "collapsed false" -> "status open".
316 * Change the output of InsetERT, changing lines
317 "status Collapsed" -> "status collapsed"
318 "status Open" -> "status open".
319 "status Inlined" -> "status inlined".
321 2003-12-10 Angus Leeming <leeming@lyx.org>
323 * format NOT incremented.
324 * add a 'draft' option to InsetExternal.
326 2003-12-10 Angus Leeming <leeming@lyx.org>
328 * format incremented to 227.
329 * Change the output of InsetBox:
330 \begin_inset Boxed -> \begin_inset Box Boxed
331 \begin_inset Doublebox -> \begin_inset Box Doublebox
332 \begin_inset Frameless -> \begin_inset Box Frameless
333 \begin_inset ovalbox -> \begin_inset Box ovalbox
334 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
335 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
337 2003-12-10 Angus Leeming <leeming@lyx.org>
339 * format incremented to 226.
340 * Change the output of InsetNote:
341 \begin_inset Note -> \begin_inset Note Note
342 \begin_inset Comment -> \begin_inset Note Comment
343 \begin_inset Greyedout -> \begin_inset Note Greyedout
345 2003-11-28 André Pönitz
347 * Remove space_above/space_below from Paragraph.
348 This is now handled by InsetVSpace.
350 2003-10-07 Angus Leeming <leeming@lyx.org>
352 * Add transformations to InsetExternal
354 boundingBox 0 0 20 20 the dimensions of the B.B..
355 Output if the B.B. is not empty.
356 clip clip the image to the B.B.
358 extra LaTeX "draft" 'extra' data passed to the primary
359 command for this output format.
360 (Possible formats LaTeX, PDFLaTeX,
361 LinuxDoc, DocBook, Ascii.)
362 The string can contain spaces and so
364 rotateAngle 30 Rotation of the data.
365 Output for non-zero rotation only.
366 rotateOrigin bottomleft Rotation origin.
367 Output for non-zero rotation and
368 non-default origin (center) only.
370 width 2cm Output only if the image is resized.
374 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
376 * Added box inset. File format:
378 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
383 inner_pos "b" t/c/b/s
385 width "100col%" unit+width-string
386 special "none" none/height/depth
388 height "1in" unit+width-string
389 height_special "totalheight" none/height/depth
391 collapsed false true/false
393 \begin_layout Standard
400 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
401 the pre-existing Minipage inset. Parameters translate as follows:
402 position 0/1/2 -> t/c/b
403 inner_position 0/1/2/3 -> inner_pos c/t/b/s
408 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
410 * attribute valignment="center" is replaced by valignment="middle"
411 for tabular columns and cells
413 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
415 * Added branch inset. File format:
417 branch definition in the header:
423 \begin_inset Branch <branchname>
424 collapsed false true/false
426 \begin_layout Standard
433 2003-07-28 José Matos <jamatos@lyx.org>
435 * \the_end is replaced with \end_document
437 2003-07-28 José Matos <jamatos@lyx.org>
439 * \layout is replaced with \begin_layout
441 2003-07-28 José Matos <jamatos@fep.up.pt>
445 * All layouts finish now with \end_layout
447 2003-06-04 Angus Leeming <leeming@lyx.org>
451 * the storage of the external inset has been changed from
453 \begin_inset External XFig,"file.fig",""
459 \begin_inset External
462 display <display_type>
467 throwing away the final arg (here "", more generally "<string>") that holds
468 the parameters variable.
469 Variables are output if present (filename) or different from the default
470 values (display, lyxscale).
472 Moreover, the RasterImage template has been scrapped. All RasterImage
473 external insets are now converted to Graphics insets.
475 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
477 * Added new space insets:
478 \SpecialChar ~ is now \InsetSpace ~
479 ERT: "\ " could be converted to InsetSpace \<space>
480 ERT: "\," could be converted to InsetSpace \,
482 2003-04-24 André Pönitz <poenitz@gmx.net>
484 * Added eqref support:
485 \begin_inset LatexCommand \eqref{label}
487 2003-03-14 Dekel Tsur
489 * Format bumped to 223.
491 2003-03-12 John Levon <levon@movementarian.org>
493 * Added \\end_header to signify the end of the header in a
496 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
498 2003-02-10 John Levon <levon@movementarian.org>
502 Added \\tracking_changes 0|1 to the header.
504 Added \\author to the header. This can be present multiple
505 times, and is of the form :
507 \\author "Real Name" email@address.com
509 Added \\change_deleted, \\change_inserted. Each of these does not
510 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
513 \\change_inserted author time
515 where author is an integer ID reference into the author list in
516 the header, and time is time_t.
518 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
520 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
522 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
524 New graphics dialog. With the removal of buttons in the dialog, also
525 keywords in the graphics inset went. The following keywords do not
535 Only non-default values are saved to the lyx files. The defaults of the remaining
545 BoundingBox <from file>
548 rotateOrigin centerBaseline
550 subcaptionText <empty>
553 The remaining keywords have sufficient overlap with the old ones for a
554 smooth reading of the 1.2.x inset keywords in most common cases.
556 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
557 They don't exist anymore and we can't translate them into a scaling value, while
558 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
559 argument is ignored and lost.
561 Only few compatibility issues are left for lyx2lyx:
563 ------------------------------------------------------------------------------
564 old-token new-token remove
565 ------------------------------------------------------------------------------
566 size_kind original / size_type 0 scale 100 width <val>
570 size_kind width_height / size_type 1 - scale <val>
572 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
573 ------------------------------------------------------------------------------
574 [replace old-token by new-token, and remove any of subsequent tokens as listed]
576 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
577 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
579 replace "rotateAngle <val>" by "rotateAngle 0"
582 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
584 Added \lyxlock for locked math inset when written to .lyx file.
585 When "downgrading" .lyx files this should simple be deleted but it
586 does not hurt at all if it stays in. It does not have to be added
590 2002-08-02 Angus Leeming <leeming@lyx.org>
592 Added a boolean "preview" flag to InsetCommandParams.
593 Currently it is written only by InsetInclude, because only this
594 class can generate a preview of its contents.
596 The LyX file now contains:
598 \begin_inset Include \input{snapshot_t=40.tex}
603 Earlier versions of LyX just swallow this extra token silently.
605 2002-08-12 Angus Leeming <leeming@lyx.org>
607 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
608 renamed as "size_kind" and "lyxsize_kind" respectively.
610 \begin_inset Graphics FormatVersion 1
617 - lyxsize_kind original
618 + lyxsize_type original