1 LyX file-format changes
2 -----------------------§
3 2007-02-22 José Matos <jamatos@lyx.org>
5 * format incremented to 263: changes in the language names (overdue):
9 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
11 * format incremented to 262: Allow ascii \inputencoding
13 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
15 * format incremented to 261: \output_changes is now considered
16 even if \tracking_changes is false. This allows to output existing
17 changes even if future changes are not tracked anymore.
20 \tracking_changes false
23 is therefore converted to
25 \tracking_changes false
28 on upgrade. Nothing is done on downgrade since the new behaviour is
29 not supported in older formats.
31 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
33 * format incremented to 260: Allow utf8x \inputencoding
35 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
37 * format incremented to 259:
38 Old: Spaces at start or end of font changes were output outside of
39 the font change, i.e. not 'xx\textbf{ yy }zz', but
41 New: Spaces are always output with the font set by the user.
45 * format incremented to 258: new \lyxline definition
47 \\newcommand{\\lyxline}[1]{
48 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
51 \\newcommand{\\lyxline}[1][1pt]{%
53 \\rule[.5ex]{\\linewidth}{#1}\\par}
54 The new definition is more robust, see bug 1988 and now really takes care about
55 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
57 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
59 * format incremented to 257: Caption styles have been replaced by
60 InsetCaption. This is at the same time also a layout file format
61 change to format 3. layout2layout removes caption layouts from old
63 Note that InsetCaption did exist before this format, but was never
64 used. Old files containing do nevertheless still work.
65 Of course users can still define a Caption style in layout files,
66 but the special treatment in LyX is gone (apart from the sensitive
69 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
71 * format incremented to 256: allow some new inputenc settings.
72 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
74 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
76 * format incremented to 255: new insets for \clearpage and
77 \cleardoublepage. They are written inline to the file, exactly like
80 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
82 * format incremented to 254: new header parameter \use_esint.
83 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
86 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
88 * format incremented to 253: new nomenclature and printnomenclature
89 insets. These are standard InsetCommand with the following parameters:
90 \nomenclature[prefix]{symbol}{description}
91 \printnomenclature[labelwidth]
93 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
95 * format incremented to 252: changed command inset syntax
99 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
110 \begin_inset LatexCommand cmdname
117 The order of the parameters and for each parameter the name and
118 optional/required bit is now stored in InsetCommandParams.
120 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
122 * format incremented to 251: save show_label param for charstyles.
124 On revert, the show_label param is just removed. Nothing to convert.
126 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
128 * Format incremented to 250: allow optional arg to environments
130 No material format change. Now optargs for environments are allowed
131 to be specified in layout files and will be handled properly. When
132 converted back to older formats, they will be ignored in LaTeX
135 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
137 * format incremented to 249: Unicode
139 LyX documents are now always encoded in utf8. The value of
140 \inputencoding does now only determine the encoding of the created
142 Up to format 248 the value of \inputencoding did also determine the
143 encoding of the LyX file:
145 \inputencoding LyX file encoding
146 auto as determined by the document and character
149 everything else as determined by \inputencoding
151 The difference between auto and default is only the LaTeX output:
152 auto causes loading of the inputenc package, default does not.
154 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
156 * format incremented to 248: Basic booktabs support
158 The <features> tag has a new switch: booktabs="true|false".
159 An absent switch is equivalent to booktabs="false".
160 Horizontal lines are set with the booktabs package if this switch
163 The <row> tag of tabulars has the following new attributes:
164 topspace, bottomspace and interlinespace. All take a LyXLength
165 as value, or the special keyword "default".
167 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
169 * format incremented to 247. The Grand Font Interface Rewrite.
170 (1) Split font selection to rm, sf, tt:
171 \fontscheme -> \font_roman, \font_sans, \font_typewriter
173 \fontscheme \font_roman \font_sans \font_typewriter
174 default default default default
175 ae ae default default
176 times times default default
177 palatino palatino default default
178 helvet default helvet default
179 avant default avant default
180 newcent newcent default default
181 bookman bookman default default
182 pslatex times (or \usepackage{pslatex})
184 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
185 lmodern, charter, utopia, ccfonts, chancery, beraserif
186 (-> \usepackage{<name>})
187 \font_sans: cmss, lmss, cmbr
188 (-> \renewcommand{\sfdefault}{<name>})
189 berasans (-> \usepackage{<name>})
190 \font_typewriter: cmtt, lmtt, cmtl,
191 (-> \renewcommand{\sfdefault}{<name>})
192 courier, luximono, beramono
193 (-> \usepackage{<name>})
194 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
195 (3) New param \font_sc (true, false).
196 (4) New param \font_osf (true, false).
197 (5) New param \font_sf_scale (float)
198 (6) New param \font_tt_scale (float)
199 Support for the following fonts has been added:
200 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
201 courier, lmodern, luximono, utopia.
202 Support for the following font has been removed:
203 pslatex (it's superseded by mathptmx (times)).
205 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
207 * format incremented to 246. The framed.sty package is
208 now supported with note types framed and shaded.
210 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
212 * format incremented to 245. The \quotes_times parameter
215 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
217 * format incremented to 244. Rename '\InsetSpace \,'
218 to '\InsetSpace \thinspace{}', because the comma was
219 not parsed by lyxlex, and '\InsetSpace \space' to
220 '\InsetSpace \space{}' in favour of consistency.
222 2005-07-18 José Matos <jamatos@lyx.org>
224 * format incremented to 243.
226 * this change only affects the preamble, the paperpackage
227 option was removed and papersize is changed to default.
229 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
231 * format incremented to 242. There is no file format per
232 se, but the "frenchb" language has been removed from lib/language
233 and has to be translated to "french" by lyx2lyx.
235 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
237 * format incremented to 241.
239 All following changes apply only to text in ERT insets. The
240 rationale is that text in ERT is simply ASCII text, and nothing more.
242 * paragraph breaks are now a single newline in latex and not a
243 paragraph break anymore (bug 698).
244 * \newline is not allowed anymore, because it is redundant (see above)
245 * layouts other than Standard, paragraph parameters and font changes
246 are not allowed anymore. They never made sense and were ignored for
247 latex output, but now they can't be read or set anymore (bug 922).
250 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
252 * format incremented to 240.
254 \output_changes {true|false}
255 (should the change tracking marks be visible in the output or not?)
256 * lyx2lyx should just delete the param in 239.
258 2005-01-06 José Matos <jamatos@lyx.org>
260 * format incremented to 239.
261 * the paragraph parameters are displayed in their own line. This
262 change is consistent with the insets behaviour, and corresponds
263 to a more uniform treatment of the paragraphs since some of them
264 had already their own line.
266 An example of a single paragraph follows:
268 \begin_layout Standard
269 \paragraph_spacing single
275 2004-12-03 José Matos <jamatos@lyx.org>
277 * format incremented to 238.
278 * The compatibility code to read old latex accents from 0.12.x in
279 InsetLatexAccent::checkContents has been removed.
280 The following translations are done:
282 "\i \xy" -> "\i \x{y}"
283 "\i \x y" -> "\i \x{y}"
284 "\i \x\i" -> "\i \x{\i}"
285 "\i \x\j" -> "\i \x{\j}"
286 x is a latex accent command, y the base character. \, i and j are
288 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
289 so formats 215 - 237 can have both versions.
292 2004-10-10 José Matos <jamatos@lyx.org>
294 * format incremented to 237.
295 * In the header, the following statments use now booleans values,
301 2004-08-15 José Matos <jamatos@lyx.org>
303 * format incremented to 236.
310 * The options for \papersize are changed:
313 * All whitespaces are removed at the end of lines, when
314 not necessary. As an example we have all the lines in the header that
315 do not belong to the preamble.
317 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
319 * format incremented to 235.
320 * \paperpackage had an off-by-one error. Translation table:
322 234: a4 a4wide widemarginsa4
323 235: none a4 a4wide widemarginsa4
325 The "widemarginsa4" setting of 235 has no equivalent in 234.
327 2004-05-12 Angus Leeming <leeming@lyx.org>
329 * format incremented to 234.
330 * the citation engine is specified explicitly rather than being
331 deduced from 3 bools.
334 \use_numerical_citations 0 -> \cite_engine <style>
337 where <style> is one of "basic", "natbib_authoryear",
338 "natbib_numerical" or "jurabib".
340 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
342 * format incremented to 233.
343 * insetgraphics does not allow filenames without extension anymore.
344 The complete filename has to be given.
346 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
348 * format incremented to 232.
350 * Support for bibtopic (sectioned bibliographies).
351 - bufferparam \use_bibtopic [1|0]
352 - the bibtex inset has a second argument for bibtopic's
353 btPrint{Cited|NotCited|All} command:
355 \begin_inset LatexCommand \bibtex[<style>]{<database>}
357 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
358 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
359 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
360 \bibliographystyle{<style>}
361 \begin{btSect}{<database>}
366 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
368 * format incremented to 231.
370 * Support for sidewaysfigure/sidewaystable (rotating package).
371 insetfloat has now a param \sideways [true|false] (default is false).
372 The param should be erased on downwards conversion, if it was true,
373 the inset should be replaced by
374 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
376 \begin{sidewaystable} <content> \end{sidewaystable}
379 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
381 * format incremented to 230.
383 * Support for a second optional argument in insetcommand.
384 currently, citation uses this to support natbibs second
385 optional argument \cite[before][after]{key}.
386 I think there's nothing to convert upwards. Downwards, the
387 commands with 2 optional args need to be converted to ERT.
389 * Support for jurabib (param \use_jurabib [1|0], default is 0).
390 When converting downwards, \usepackage{jurabib} has to be added
391 to the preamble and, if babel is used, \usepackage{babel} before
392 (jurabib fails if babel is called afterwards). If the natbib commands
393 are used together with jurabib, they have to be converted to ERT too.
395 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
397 * format incremented to 229.
398 * Minipages cannot be read anymore. All minipage insets will
399 be converted to frameless box insets between 228->229.
401 2003-12-15 Angus Leeming <leeming@lyx.org>
403 * format incremented to 228.
404 * Change the output of all insets derived from InsetCollapsable
405 except for InsetERT (which has a similar output already), changing lines
406 "collapsed true" -> "status collapsed"
407 "collapsed false" -> "status open".
408 * Change the output of InsetERT, changing lines
409 "status Collapsed" -> "status collapsed"
410 "status Open" -> "status open".
411 "status Inlined" -> "status inlined".
413 2003-12-10 Angus Leeming <leeming@lyx.org>
415 * format NOT incremented.
416 * add a 'draft' option to InsetExternal.
418 2003-12-10 Angus Leeming <leeming@lyx.org>
420 * format incremented to 227.
421 * Change the output of InsetBox:
422 \begin_inset Boxed -> \begin_inset Box Boxed
423 \begin_inset Doublebox -> \begin_inset Box Doublebox
424 \begin_inset Frameless -> \begin_inset Box Frameless
425 \begin_inset ovalbox -> \begin_inset Box ovalbox
426 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
427 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
429 2003-12-10 Angus Leeming <leeming@lyx.org>
431 * format incremented to 226.
432 * Change the output of InsetNote:
433 \begin_inset Note -> \begin_inset Note Note
434 \begin_inset Comment -> \begin_inset Note Comment
435 \begin_inset Greyedout -> \begin_inset Note Greyedout
437 2003-11-28 André Pönitz
439 * Remove space_above/space_below from Paragraph.
440 This is now handled by InsetVSpace.
442 2003-10-07 Angus Leeming <leeming@lyx.org>
444 * Add transformations to InsetExternal
446 boundingBox 0 0 20 20 the dimensions of the B.B..
447 Output if the B.B. is not empty.
448 clip clip the image to the B.B.
450 extra LaTeX "draft" 'extra' data passed to the primary
451 command for this output format.
452 (Possible formats LaTeX, PDFLaTeX,
453 LinuxDoc, DocBook, Ascii.)
454 The string can contain spaces and so
456 rotateAngle 30 Rotation of the data.
457 Output for non-zero rotation only.
458 rotateOrigin bottomleft Rotation origin.
459 Output for non-zero rotation and
460 non-default origin (center) only.
462 width 2cm Output only if the image is resized.
466 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
468 * Added box inset. File format:
470 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
475 inner_pos "b" t/c/b/s
477 width "100col%" unit+width-string
478 special "none" none/height/depth
480 height "1in" unit+width-string
481 height_special "totalheight" none/height/depth
483 collapsed false true/false
485 \begin_layout Standard
492 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
493 the pre-existing Minipage inset. Parameters translate as follows:
494 position 0/1/2 -> t/c/b
495 inner_position 0/1/2/3 -> inner_pos c/t/b/s
500 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
502 * attribute valignment="center" is replaced by valignment="middle"
503 for tabular columns and cells
505 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
507 * Added branch inset. File format:
509 branch definition in the header:
515 \begin_inset Branch <branchname>
516 collapsed false true/false
518 \begin_layout Standard
525 2003-07-28 José Matos <jamatos@lyx.org>
527 * \the_end is replaced with \end_document
529 2003-07-28 José Matos <jamatos@lyx.org>
531 * \layout is replaced with \begin_layout
533 2003-07-28 José Matos <jamatos@fep.up.pt>
537 * All layouts finish now with \end_layout
539 2003-06-04 Angus Leeming <leeming@lyx.org>
543 * the storage of the external inset has been changed from
545 \begin_inset External XFig,"file.fig",""
551 \begin_inset External
554 display <display_type>
559 throwing away the final arg (here "", more generally "<string>") that holds
560 the parameters variable.
561 Variables are output if present (filename) or different from the default
562 values (display, lyxscale).
564 Moreover, the RasterImage template has been scrapped. All RasterImage
565 external insets are now converted to Graphics insets.
567 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
569 * Added new space insets:
570 \SpecialChar ~ is now \InsetSpace ~
571 ERT: "\ " could be converted to InsetSpace \<space>
572 ERT: "\," could be converted to InsetSpace \,
574 2003-04-24 André Pönitz <poenitz@gmx.net>
576 * Added eqref support:
577 \begin_inset LatexCommand \eqref{label}
579 2003-03-14 Dekel Tsur
581 * Format bumped to 223.
583 2003-03-12 John Levon <levon@movementarian.org>
585 * Added \\end_header to signify the end of the header in a
588 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
590 2003-02-10 John Levon <levon@movementarian.org>
594 Added \\tracking_changes 0|1 to the header.
596 Added \\author to the header. This can be present multiple
597 times, and is of the form :
599 \\author "Real Name" email@address.com
601 Added \\change_deleted, \\change_inserted. Each of these does not
602 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
605 \\change_inserted author time
607 where author is an integer ID reference into the author list in
608 the header, and time is time_t.
610 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
612 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
614 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
616 New graphics dialog. With the removal of buttons in the dialog, also
617 keywords in the graphics inset went. The following keywords do not
627 Only non-default values are saved to the lyx files. The defaults of the remaining
637 BoundingBox <from file>
640 rotateOrigin centerBaseline
642 subcaptionText <empty>
645 The remaining keywords have sufficient overlap with the old ones for a
646 smooth reading of the 1.2.x inset keywords in most common cases.
648 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
649 They don't exist anymore and we can't translate them into a scaling value, while
650 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
651 argument is ignored and lost.
653 Only few compatibility issues are left for lyx2lyx:
655 ------------------------------------------------------------------------------
656 old-token new-token remove
657 ------------------------------------------------------------------------------
658 size_kind original / size_type 0 scale 100 width <val>
662 size_kind width_height / size_type 1 - scale <val>
664 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
665 ------------------------------------------------------------------------------
666 [replace old-token by new-token, and remove any of subsequent tokens as listed]
668 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
669 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
671 replace "rotateAngle <val>" by "rotateAngle 0"
674 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
676 Added \lyxlock for locked math inset when written to .lyx file.
677 When "downgrading" .lyx files this should simple be deleted but it
678 does not hurt at all if it stays in. It does not have to be added
682 2002-08-02 Angus Leeming <leeming@lyx.org>
684 Added a boolean "preview" flag to InsetCommandParams.
685 Currently it is written only by InsetInclude, because only this
686 class can generate a preview of its contents.
688 The LyX file now contains:
690 \begin_inset Include \input{snapshot_t=40.tex}
695 Earlier versions of LyX just swallow this extra token silently.
697 2002-08-12 Angus Leeming <leeming@lyx.org>
699 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
700 renamed as "size_kind" and "lyxsize_kind" respectively.
702 \begin_inset Graphics FormatVersion 1
709 - lyxsize_kind original
710 + lyxsize_type original