1 LyX file-format changes
2 -----------------------§
4 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 261: \output_changes is now considered
7 even if \tracking_changes is false. This allows to output existing
8 changes even if future changes are not tracked anymore.
11 \tracking_changes false
14 is therefore converted to
16 \tracking_changes false
19 on upgrade. Nothing is done on downgrade since the new behaviour is
20 not supported in older formats.
22 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
24 * format incremented to 260: Allow utf8x \inputencoding
26 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
28 * format incremented to 259:
29 Old: Spaces at start or end of font changes were output outside of
30 the font change, i.e. not 'xx\textbf{ yy }zz', but
32 New: Spaces are always output with the font set by the user.
36 * format incremented to 258: new \lyxline definition
38 \\newcommand{\\lyxline}[1]{
39 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
42 \\newcommand{\\lyxline}[1][1pt]{%
44 \\rule[.5ex]{\\linewidth}{#1}\\par}
45 The new definition is more robust, see bug 1988 and now really takes care about
46 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
48 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
50 * format incremented to 257: Caption styles have been replaced by
51 InsetCaption. This is at the same time also a layout file format
52 change to format 3. layout2layout removes caption layouts from old
54 Note that InsetCaption did exist before this format, but was never
55 used. Old files containing do nevertheless still work.
56 Of course users can still define a Caption style in layout files,
57 but the special treatment in LyX is gone (apart from the sensitive
60 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
62 * format incremented to 256: allow some new inputenc settings.
63 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
65 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
67 * format incremented to 255: new insets for \clearpage and
68 \cleardoublepage. They are written inline to the file, exactly like
71 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
73 * format incremented to 254: new header parameter \use_esint.
74 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
77 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
79 * format incremented to 253: new nomenclature and printnomenclature
80 insets. These are standard InsetCommand with the following parameters:
81 \nomenclature[prefix]{symbol}{description}
82 \printnomenclature[labelwidth]
84 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
86 * format incremented to 252: changed command inset syntax
90 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
101 \begin_inset LatexCommand cmdname
108 The order of the parameters and for each parameter the name and
109 optional/required bit is now stored in InsetCommandParams.
111 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
113 * format incremented to 251: save show_label param for charstyles.
115 On revert, the show_label param is just removed. Nothing to convert.
117 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
119 * Format incremented to 250: allow optional arg to environments
121 No material format change. Now optargs for environments are allowed
122 to be specified in layout files and will be handled properly. When
123 converted back to older formats, they will be ignored in LaTeX
126 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
128 * format incremented to 249: Unicode
130 LyX documents are now always encoded in utf8. The value of
131 \inputencoding does now only determine the encoding of the created
133 Up to format 248 the value of \inputencoding did also determine the
134 encoding of the LyX file:
136 \inputencoding LyX file encoding
137 auto as determined by the document and character
140 everything else as determined by \inputencoding
142 The difference between auto and default is only the LaTeX output:
143 auto causes loading of the inputenc package, default does not.
145 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
147 * format incremented to 248: Basic booktabs support
149 The <features> tag has a new switch: booktabs="true|false".
150 An absent switch is equivalent to booktabs="false".
151 Horizontal lines are set with the booktabs package if this switch
154 The <row> tag of tabulars has the following new attributes:
155 topspace, bottomspace and interlinespace. All take a LyXLength
156 as value, or the special keyword "default".
158 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
160 * format incremented to 247. The Grand Font Interface Rewrite.
161 (1) Split font selection to rm, sf, tt:
162 \fontscheme -> \font_roman, \font_sans, \font_typewriter
164 \fontscheme \font_roman \font_sans \font_typewriter
165 default default default default
166 ae ae default default
167 times times default default
168 palatino palatino default default
169 helvet default helvet default
170 avant default avant default
171 newcent newcent default default
172 bookman bookman default default
173 pslatex times (or \usepackage{pslatex})
175 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
176 lmodern, charter, utopia, ccfonts, chancery, beraserif
177 (-> \usepackage{<name>})
178 \font_sans: cmss, lmss, cmbr
179 (-> \renewcommand{\sfdefault}{<name>})
180 berasans (-> \usepackage{<name>})
181 \font_typewriter: cmtt, lmtt, cmtl,
182 (-> \renewcommand{\sfdefault}{<name>})
183 courier, luximono, beramono
184 (-> \usepackage{<name>})
185 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
186 (3) New param \font_sc (true, false).
187 (4) New param \font_osf (true, false).
188 (5) New param \font_sf_scale (float)
189 (6) New param \font_tt_scale (float)
190 Support for the following fonts has been added:
191 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
192 courier, lmodern, luximono, utopia.
193 Support for the following font has been removed:
194 pslatex (it's superseded by mathptmx (times)).
196 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
198 * format incremented to 246. The framed.sty package is
199 now supported with note types framed and shaded.
201 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
203 * format incremented to 245. The \quotes_times parameter
206 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
208 * format incremented to 244. Rename '\InsetSpace \,'
209 to '\InsetSpace \thinspace{}', because the comma was
210 not parsed by lyxlex, and '\InsetSpace \space' to
211 '\InsetSpace \space{}' in favour of consistency.
213 2005-07-18 José Matos <jamatos@lyx.org>
215 * format incremented to 243.
217 * this change only affects the preamble, the paperpackage
218 option was removed and papersize is changed to default.
220 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
222 * format incremented to 242. There is no file format per
223 se, but the "frenchb" language has been removed from lib/language
224 and has to be translated to "french" by lyx2lyx.
226 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
228 * format incremented to 241.
230 All following changes apply only to text in ERT insets. The
231 rationale is that text in ERT is simply ASCII text, and nothing more.
233 * paragraph breaks are now a single newline in latex and not a
234 paragraph break anymore (bug 698).
235 * \newline is not allowed anymore, because it is redundant (see above)
236 * layouts other than Standard, paragraph parameters and font changes
237 are not allowed anymore. They never made sense and were ignored for
238 latex output, but now they can't be read or set anymore (bug 922).
241 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
243 * format incremented to 240.
245 \output_changes {true|false}
246 (should the change tracking marks be visible in the output or not?)
247 * lyx2lyx should just delete the param in 239.
249 2005-01-06 José Matos <jamatos@lyx.org>
251 * format incremented to 239.
252 * the paragraph parameters are displayed in their own line. This
253 change is consistent with the insets behaviour, and corresponds
254 to a more uniform treatment of the paragraphs since some of them
255 had already their own line.
257 An example of a single paragraph follows:
259 \begin_layout Standard
260 \paragraph_spacing single
266 2004-12-03 José Matos <jamatos@lyx.org>
268 * format incremented to 238.
269 * The compatibility code to read old latex accents from 0.12.x in
270 InsetLatexAccent::checkContents has been removed.
271 The following translations are done:
273 "\i \xy" -> "\i \x{y}"
274 "\i \x y" -> "\i \x{y}"
275 "\i \x\i" -> "\i \x{\i}"
276 "\i \x\j" -> "\i \x{\j}"
277 x is a latex accent command, y the base character. \, i and j are
279 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
280 so formats 215 - 237 can have both versions.
283 2004-10-10 José Matos <jamatos@lyx.org>
285 * format incremented to 237.
286 * In the header, the following statments use now booleans values,
292 2004-08-15 José Matos <jamatos@lyx.org>
294 * format incremented to 236.
301 * The options for \papersize are changed:
304 * All whitespaces are removed at the end of lines, when
305 not necessary. As an example we have all the lines in the header that
306 do not belong to the preamble.
308 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
310 * format incremented to 235.
311 * \paperpackage had an off-by-one error. Translation table:
313 234: a4 a4wide widemarginsa4
314 235: none a4 a4wide widemarginsa4
316 The "widemarginsa4" setting of 235 has no equivalent in 234.
318 2004-05-12 Angus Leeming <leeming@lyx.org>
320 * format incremented to 234.
321 * the citation engine is specified explicitly rather than being
322 deduced from 3 bools.
325 \use_numerical_citations 0 -> \cite_engine <style>
328 where <style> is one of "basic", "natbib_authoryear",
329 "natbib_numerical" or "jurabib".
331 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
333 * format incremented to 233.
334 * insetgraphics does not allow filenames without extension anymore.
335 The complete filename has to be given.
337 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
339 * format incremented to 232.
341 * Support for bibtopic (sectioned bibliographies).
342 - bufferparam \use_bibtopic [1|0]
343 - the bibtex inset has a second argument for bibtopic's
344 btPrint{Cited|NotCited|All} command:
346 \begin_inset LatexCommand \bibtex[<style>]{<database>}
348 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
349 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
350 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
351 \bibliographystyle{<style>}
352 \begin{btSect}{<database>}
357 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
359 * format incremented to 231.
361 * Support for sidewaysfigure/sidewaystable (rotating package).
362 insetfloat has now a param \sideways [true|false] (default is false).
363 The param should be erased on downwards conversion, if it was true,
364 the inset should be replaced by
365 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
367 \begin{sidewaystable} <content> \end{sidewaystable}
370 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
372 * format incremented to 230.
374 * Support for a second optional argument in insetcommand.
375 currently, citation uses this to support natbibs second
376 optional argument \cite[before][after]{key}.
377 I think there's nothing to convert upwards. Downwards, the
378 commands with 2 optional args need to be converted to ERT.
380 * Support for jurabib (param \use_jurabib [1|0], default is 0).
381 When converting downwards, \usepackage{jurabib} has to be added
382 to the preamble and, if babel is used, \usepackage{babel} before
383 (jurabib fails if babel is called afterwards). If the natbib commands
384 are used together with jurabib, they have to be converted to ERT too.
386 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
388 * format incremented to 229.
389 * Minipages cannot be read anymore. All minipage insets will
390 be converted to frameless box insets between 228->229.
392 2003-12-15 Angus Leeming <leeming@lyx.org>
394 * format incremented to 228.
395 * Change the output of all insets derived from InsetCollapsable
396 except for InsetERT (which has a similar output already), changing lines
397 "collapsed true" -> "status collapsed"
398 "collapsed false" -> "status open".
399 * Change the output of InsetERT, changing lines
400 "status Collapsed" -> "status collapsed"
401 "status Open" -> "status open".
402 "status Inlined" -> "status inlined".
404 2003-12-10 Angus Leeming <leeming@lyx.org>
406 * format NOT incremented.
407 * add a 'draft' option to InsetExternal.
409 2003-12-10 Angus Leeming <leeming@lyx.org>
411 * format incremented to 227.
412 * Change the output of InsetBox:
413 \begin_inset Boxed -> \begin_inset Box Boxed
414 \begin_inset Doublebox -> \begin_inset Box Doublebox
415 \begin_inset Frameless -> \begin_inset Box Frameless
416 \begin_inset ovalbox -> \begin_inset Box ovalbox
417 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
418 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
420 2003-12-10 Angus Leeming <leeming@lyx.org>
422 * format incremented to 226.
423 * Change the output of InsetNote:
424 \begin_inset Note -> \begin_inset Note Note
425 \begin_inset Comment -> \begin_inset Note Comment
426 \begin_inset Greyedout -> \begin_inset Note Greyedout
428 2003-11-28 André Pönitz
430 * Remove space_above/space_below from Paragraph.
431 This is now handled by InsetVSpace.
433 2003-10-07 Angus Leeming <leeming@lyx.org>
435 * Add transformations to InsetExternal
437 boundingBox 0 0 20 20 the dimensions of the B.B..
438 Output if the B.B. is not empty.
439 clip clip the image to the B.B.
441 extra LaTeX "draft" 'extra' data passed to the primary
442 command for this output format.
443 (Possible formats LaTeX, PDFLaTeX,
444 LinuxDoc, DocBook, Ascii.)
445 The string can contain spaces and so
447 rotateAngle 30 Rotation of the data.
448 Output for non-zero rotation only.
449 rotateOrigin bottomleft Rotation origin.
450 Output for non-zero rotation and
451 non-default origin (center) only.
453 width 2cm Output only if the image is resized.
457 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
459 * Added box inset. File format:
461 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
466 inner_pos "b" t/c/b/s
468 width "100col%" unit+width-string
469 special "none" none/height/depth
471 height "1in" unit+width-string
472 height_special "totalheight" none/height/depth
474 collapsed false true/false
476 \begin_layout Standard
483 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
484 the pre-existing Minipage inset. Parameters translate as follows:
485 position 0/1/2 -> t/c/b
486 inner_position 0/1/2/3 -> inner_pos c/t/b/s
491 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
493 * attribute valignment="center" is replaced by valignment="middle"
494 for tabular columns and cells
496 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
498 * Added branch inset. File format:
500 branch definition in the header:
506 \begin_inset Branch <branchname>
507 collapsed false true/false
509 \begin_layout Standard
516 2003-07-28 José Matos <jamatos@lyx.org>
518 * \the_end is replaced with \end_document
520 2003-07-28 José Matos <jamatos@lyx.org>
522 * \layout is replaced with \begin_layout
524 2003-07-28 José Matos <jamatos@fep.up.pt>
528 * All layouts finish now with \end_layout
530 2003-06-04 Angus Leeming <leeming@lyx.org>
534 * the storage of the external inset has been changed from
536 \begin_inset External XFig,"file.fig",""
542 \begin_inset External
545 display <display_type>
550 throwing away the final arg (here "", more generally "<string>") that holds
551 the parameters variable.
552 Variables are output if present (filename) or different from the default
553 values (display, lyxscale).
555 Moreover, the RasterImage template has been scrapped. All RasterImage
556 external insets are now converted to Graphics insets.
558 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
560 * Added new space insets:
561 \SpecialChar ~ is now \InsetSpace ~
562 ERT: "\ " could be converted to InsetSpace \<space>
563 ERT: "\," could be converted to InsetSpace \,
565 2003-04-24 André Pönitz <poenitz@gmx.net>
567 * Added eqref support:
568 \begin_inset LatexCommand \eqref{label}
570 2003-03-14 Dekel Tsur
572 * Format bumped to 223.
574 2003-03-12 John Levon <levon@movementarian.org>
576 * Added \\end_header to signify the end of the header in a
579 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
581 2003-02-10 John Levon <levon@movementarian.org>
585 Added \\tracking_changes 0|1 to the header.
587 Added \\author to the header. This can be present multiple
588 times, and is of the form :
590 \\author "Real Name" email@address.com
592 Added \\change_deleted, \\change_inserted. Each of these does not
593 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
596 \\change_inserted author time
598 where author is an integer ID reference into the author list in
599 the header, and time is time_t.
601 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
603 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
605 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
607 New graphics dialog. With the removal of buttons in the dialog, also
608 keywords in the graphics inset went. The following keywords do not
618 Only non-default values are saved to the lyx files. The defaults of the remaining
628 BoundingBox <from file>
631 rotateOrigin centerBaseline
633 subcaptionText <empty>
636 The remaining keywords have sufficient overlap with the old ones for a
637 smooth reading of the 1.2.x inset keywords in most common cases.
639 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
640 They don't exist anymore and we can't translate them into a scaling value, while
641 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
642 argument is ignored and lost.
644 Only few compatibility issues are left for lyx2lyx:
646 ------------------------------------------------------------------------------
647 old-token new-token remove
648 ------------------------------------------------------------------------------
649 size_kind original / size_type 0 scale 100 width <val>
653 size_kind width_height / size_type 1 - scale <val>
655 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
656 ------------------------------------------------------------------------------
657 [replace old-token by new-token, and remove any of subsequent tokens as listed]
659 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
660 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
662 replace "rotateAngle <val>" by "rotateAngle 0"
665 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
667 Added \lyxlock for locked math inset when written to .lyx file.
668 When "downgrading" .lyx files this should simple be deleted but it
669 does not hurt at all if it stays in. It does not have to be added
673 2002-08-02 Angus Leeming <leeming@lyx.org>
675 Added a boolean "preview" flag to InsetCommandParams.
676 Currently it is written only by InsetInclude, because only this
677 class can generate a preview of its contents.
679 The LyX file now contains:
681 \begin_inset Include \input{snapshot_t=40.tex}
686 Earlier versions of LyX just swallow this extra token silently.
688 2002-08-12 Angus Leeming <leeming@lyx.org>
690 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
691 renamed as "size_kind" and "lyxsize_kind" respectively.
693 \begin_inset Graphics FormatVersion 1
700 - lyxsize_kind original
701 + lyxsize_type original