1 LyX file-format changes
2 -----------------------
4 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
6 * format incremented to 265: fix LyX's table border line handling
7 With the fix (see bug 1746) LyX now takes care if the user has entered
8 a "|" character in the argument field of tables. Therefore the "|"
9 character has to be removed when also a table border is set.
11 2007-04-24 José Matos <jamatos@lyx.org>
13 * format incremented to 264:
14 textclass cv is renamed simplecv
16 2007-02-22 José Matos <jamatos@lyx.org>
18 * format incremented to 263: changes in the language names (overdue):
20 portuges -> portuguese
22 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
24 * format incremented to 262: Allow ascii \inputencoding
26 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
28 * format incremented to 261: \output_changes is now considered
29 even if \tracking_changes is false. This allows to output existing
30 changes even if future changes are not tracked anymore.
33 \tracking_changes false
36 is therefore converted to
38 \tracking_changes false
41 on upgrade. Nothing is done on downgrade since the new behaviour is
42 not supported in older formats.
44 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
46 * format incremented to 260: Allow utf8x \inputencoding
48 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
50 * format incremented to 259:
51 Old: Spaces at start or end of font changes were output outside of
52 the font change, i.e. not 'xx\textbf{ yy }zz', but
54 New: Spaces are always output with the font set by the user.
56 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
58 * format incremented to 258: new \lyxline definition
60 \\newcommand{\\lyxline}[1]{
61 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
64 \\newcommand{\\lyxline}[1][1pt]{%
66 \\rule[.5ex]{\\linewidth}{#1}\\par}
67 The new definition is more robust, see bug 1988 and now really takes care about
68 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
70 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
72 * format incremented to 257: Caption styles have been replaced by
73 InsetCaption. This is at the same time also a layout file format
74 change to format 3. layout2layout removes caption layouts from old
76 Note that InsetCaption did exist before this format, but was never
77 used. Old files containing do nevertheless still work.
78 Of course users can still define a Caption style in layout files,
79 but the special treatment in LyX is gone (apart from the sensitive
82 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
84 * format incremented to 256: allow some new inputenc settings.
85 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
87 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
89 * format incremented to 255: new insets for \clearpage and
90 \cleardoublepage. They are written inline to the file, exactly like
93 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
95 * format incremented to 254: new header parameter \use_esint.
96 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
99 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
101 * format incremented to 253: new nomenclature and printnomenclature
102 insets. These are standard InsetCommand with the following parameters:
103 \nomenclature[prefix]{symbol}{description}
104 \printnomenclature[labelwidth]
106 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
108 * format incremented to 252: changed command inset syntax
112 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
123 \begin_inset LatexCommand cmdname
130 The order of the parameters and for each parameter the name and
131 optional/required bit is now stored in InsetCommandParams.
133 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
135 * format incremented to 251: save show_label param for charstyles.
137 On revert, the show_label param is just removed. Nothing to convert.
139 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
141 * Format incremented to 250: allow optional arg to environments
143 No material format change. Now optargs for environments are allowed
144 to be specified in layout files and will be handled properly. When
145 converted back to older formats, they will be ignored in LaTeX
148 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
150 * format incremented to 249: Unicode
152 LyX documents are now always encoded in utf8. The value of
153 \inputencoding does now only determine the encoding of the created
155 Up to format 248 the value of \inputencoding did also determine the
156 encoding of the LyX file:
158 \inputencoding LyX file encoding
159 auto as determined by the document and character
162 everything else as determined by \inputencoding
164 The difference between auto and default is only the LaTeX output:
165 auto causes loading of the inputenc package, default does not.
167 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
169 * format incremented to 248: Basic booktabs support
171 The <features> tag has a new switch: booktabs="true|false".
172 An absent switch is equivalent to booktabs="false".
173 Horizontal lines are set with the booktabs package if this switch
176 The <row> tag of tabulars has the following new attributes:
177 topspace, bottomspace and interlinespace. All take a LyXLength
178 as value, or the special keyword "default".
180 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
182 * format incremented to 247. The Grand Font Interface Rewrite.
183 (1) Split font selection to rm, sf, tt:
184 \fontscheme -> \font_roman, \font_sans, \font_typewriter
186 \fontscheme \font_roman \font_sans \font_typewriter
187 default default default default
188 ae ae default default
189 times times default default
190 palatino palatino default default
191 helvet default helvet default
192 avant default avant default
193 newcent newcent default default
194 bookman bookman default default
195 pslatex times (or \usepackage{pslatex})
197 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
198 lmodern, charter, utopia, ccfonts, chancery, beraserif
199 (-> \usepackage{<name>})
200 \font_sans: cmss, lmss, cmbr
201 (-> \renewcommand{\sfdefault}{<name>})
202 berasans (-> \usepackage{<name>})
203 \font_typewriter: cmtt, lmtt, cmtl,
204 (-> \renewcommand{\sfdefault}{<name>})
205 courier, luximono, beramono
206 (-> \usepackage{<name>})
207 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
208 (3) New param \font_sc (true, false).
209 (4) New param \font_osf (true, false).
210 (5) New param \font_sf_scale (float)
211 (6) New param \font_tt_scale (float)
212 Support for the following fonts has been added:
213 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
214 courier, lmodern, luximono, utopia.
215 Support for the following font has been removed:
216 pslatex (it's superseded by mathptmx (times)).
218 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
220 * format incremented to 246. The framed.sty package is
221 now supported with note types framed and shaded.
223 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
225 * format incremented to 245. The \quotes_times parameter
228 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
230 * format incremented to 244. Rename '\InsetSpace \,'
231 to '\InsetSpace \thinspace{}', because the comma was
232 not parsed by lyxlex, and '\InsetSpace \space' to
233 '\InsetSpace \space{}' in favour of consistency.
235 2005-07-18 José Matos <jamatos@lyx.org>
237 * format incremented to 243.
239 * this change only affects the preamble, the paperpackage
240 option was removed and papersize is changed to default.
242 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
244 * format incremented to 242. There is no file format per
245 se, but the "frenchb" language has been removed from lib/language
246 and has to be translated to "french" by lyx2lyx.
248 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
250 * format incremented to 241.
252 All following changes apply only to text in ERT insets. The
253 rationale is that text in ERT is simply ASCII text, and nothing more.
255 * paragraph breaks are now a single newline in latex and not a
256 paragraph break anymore (bug 698).
257 * \newline is not allowed anymore, because it is redundant (see above)
258 * layouts other than Standard, paragraph parameters and font changes
259 are not allowed anymore. They never made sense and were ignored for
260 latex output, but now they can't be read or set anymore (bug 922).
263 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
265 * format incremented to 240.
267 \output_changes {true|false}
268 (should the change tracking marks be visible in the output or not?)
269 * lyx2lyx should just delete the param in 239.
271 2005-01-06 José Matos <jamatos@lyx.org>
273 * format incremented to 239.
274 * the paragraph parameters are displayed in their own line. This
275 change is consistent with the insets behaviour, and corresponds
276 to a more uniform treatment of the paragraphs since some of them
277 had already their own line.
279 An example of a single paragraph follows:
281 \begin_layout Standard
282 \paragraph_spacing single
288 2004-12-03 José Matos <jamatos@lyx.org>
290 * format incremented to 238.
291 * The compatibility code to read old latex accents from 0.12.x in
292 InsetLatexAccent::checkContents has been removed.
293 The following translations are done:
295 "\i \xy" -> "\i \x{y}"
296 "\i \x y" -> "\i \x{y}"
297 "\i \x\i" -> "\i \x{\i}"
298 "\i \x\j" -> "\i \x{\j}"
299 x is a latex accent command, y the base character. \, i and j are
301 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
302 so formats 215 - 237 can have both versions.
305 2004-10-10 José Matos <jamatos@lyx.org>
307 * format incremented to 237.
308 * In the header, the following statments use now booleans values,
314 2004-08-15 José Matos <jamatos@lyx.org>
316 * format incremented to 236.
323 * The options for \papersize are changed:
326 * All whitespaces are removed at the end of lines, when
327 not necessary. As an example we have all the lines in the header that
328 do not belong to the preamble.
330 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
332 * format incremented to 235.
333 * \paperpackage had an off-by-one error. Translation table:
335 234: a4 a4wide widemarginsa4
336 235: none a4 a4wide widemarginsa4
338 The "widemarginsa4" setting of 235 has no equivalent in 234.
340 2004-05-12 Angus Leeming <leeming@lyx.org>
342 * format incremented to 234.
343 * the citation engine is specified explicitly rather than being
344 deduced from 3 bools.
347 \use_numerical_citations 0 -> \cite_engine <style>
350 where <style> is one of "basic", "natbib_authoryear",
351 "natbib_numerical" or "jurabib".
353 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
355 * format incremented to 233.
356 * insetgraphics does not allow filenames without extension anymore.
357 The complete filename has to be given.
359 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
361 * format incremented to 232.
363 * Support for bibtopic (sectioned bibliographies).
364 - bufferparam \use_bibtopic [1|0]
365 - the bibtex inset has a second argument for bibtopic's
366 btPrint{Cited|NotCited|All} command:
368 \begin_inset LatexCommand \bibtex[<style>]{<database>}
370 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
371 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
372 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
373 \bibliographystyle{<style>}
374 \begin{btSect}{<database>}
379 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
381 * format incremented to 231.
383 * Support for sidewaysfigure/sidewaystable (rotating package).
384 insetfloat has now a param \sideways [true|false] (default is false).
385 The param should be erased on downwards conversion, if it was true,
386 the inset should be replaced by
387 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
389 \begin{sidewaystable} <content> \end{sidewaystable}
392 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
394 * format incremented to 230.
396 * Support for a second optional argument in insetcommand.
397 currently, citation uses this to support natbibs second
398 optional argument \cite[before][after]{key}.
399 I think there's nothing to convert upwards. Downwards, the
400 commands with 2 optional args need to be converted to ERT.
402 * Support for jurabib (param \use_jurabib [1|0], default is 0).
403 When converting downwards, \usepackage{jurabib} has to be added
404 to the preamble and, if babel is used, \usepackage{babel} before
405 (jurabib fails if babel is called afterwards). If the natbib commands
406 are used together with jurabib, they have to be converted to ERT too.
408 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
410 * format incremented to 229.
411 * Minipages cannot be read anymore. All minipage insets will
412 be converted to frameless box insets between 228->229.
414 2003-12-15 Angus Leeming <leeming@lyx.org>
416 * format incremented to 228.
417 * Change the output of all insets derived from InsetCollapsable
418 except for InsetERT (which has a similar output already), changing lines
419 "collapsed true" -> "status collapsed"
420 "collapsed false" -> "status open".
421 * Change the output of InsetERT, changing lines
422 "status Collapsed" -> "status collapsed"
423 "status Open" -> "status open".
424 "status Inlined" -> "status inlined".
426 2003-12-10 Angus Leeming <leeming@lyx.org>
428 * format NOT incremented.
429 * add a 'draft' option to InsetExternal.
431 2003-12-10 Angus Leeming <leeming@lyx.org>
433 * format incremented to 227.
434 * Change the output of InsetBox:
435 \begin_inset Boxed -> \begin_inset Box Boxed
436 \begin_inset Doublebox -> \begin_inset Box Doublebox
437 \begin_inset Frameless -> \begin_inset Box Frameless
438 \begin_inset ovalbox -> \begin_inset Box ovalbox
439 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
440 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
442 2003-12-10 Angus Leeming <leeming@lyx.org>
444 * format incremented to 226.
445 * Change the output of InsetNote:
446 \begin_inset Note -> \begin_inset Note Note
447 \begin_inset Comment -> \begin_inset Note Comment
448 \begin_inset Greyedout -> \begin_inset Note Greyedout
450 2003-11-28 André Pönitz
452 * Remove space_above/space_below from Paragraph.
453 This is now handled by InsetVSpace.
455 2003-10-07 Angus Leeming <leeming@lyx.org>
457 * Add transformations to InsetExternal
459 boundingBox 0 0 20 20 the dimensions of the B.B..
460 Output if the B.B. is not empty.
461 clip clip the image to the B.B.
463 extra LaTeX "draft" 'extra' data passed to the primary
464 command for this output format.
465 (Possible formats LaTeX, PDFLaTeX,
466 LinuxDoc, DocBook, Ascii.)
467 The string can contain spaces and so
469 rotateAngle 30 Rotation of the data.
470 Output for non-zero rotation only.
471 rotateOrigin bottomleft Rotation origin.
472 Output for non-zero rotation and
473 non-default origin (center) only.
475 width 2cm Output only if the image is resized.
479 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
481 * Added box inset. File format:
483 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
488 inner_pos "b" t/c/b/s
490 width "100col%" unit+width-string
491 special "none" none/height/depth
493 height "1in" unit+width-string
494 height_special "totalheight" none/height/depth
496 collapsed false true/false
498 \begin_layout Standard
505 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
506 the pre-existing Minipage inset. Parameters translate as follows:
507 position 0/1/2 -> t/c/b
508 inner_position 0/1/2/3 -> inner_pos c/t/b/s
513 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
515 * attribute valignment="center" is replaced by valignment="middle"
516 for tabular columns and cells
518 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
520 * Added branch inset. File format:
522 branch definition in the header:
528 \begin_inset Branch <branchname>
529 collapsed false true/false
531 \begin_layout Standard
538 2003-07-28 José Matos <jamatos@lyx.org>
540 * \the_end is replaced with \end_document
542 2003-07-28 José Matos <jamatos@lyx.org>
544 * \layout is replaced with \begin_layout
546 2003-07-28 José Matos <jamatos@fep.up.pt>
550 * All layouts finish now with \end_layout
552 2003-06-04 Angus Leeming <leeming@lyx.org>
556 * the storage of the external inset has been changed from
558 \begin_inset External XFig,"file.fig",""
564 \begin_inset External
567 display <display_type>
572 throwing away the final arg (here "", more generally "<string>") that holds
573 the parameters variable.
574 Variables are output if present (filename) or different from the default
575 values (display, lyxscale).
577 Moreover, the RasterImage template has been scrapped. All RasterImage
578 external insets are now converted to Graphics insets.
580 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
582 * Added new space insets:
583 \SpecialChar ~ is now \InsetSpace ~
584 ERT: "\ " could be converted to InsetSpace \<space>
585 ERT: "\," could be converted to InsetSpace \,
587 2003-04-24 André Pönitz <poenitz@gmx.net>
589 * Added eqref support:
590 \begin_inset LatexCommand \eqref{label}
592 2003-03-14 Dekel Tsur
594 * Format bumped to 223.
596 2003-03-12 John Levon <levon@movementarian.org>
598 * Added \\end_header to signify the end of the header in a
601 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
603 2003-02-10 John Levon <levon@movementarian.org>
607 Added \\tracking_changes 0|1 to the header.
609 Added \\author to the header. This can be present multiple
610 times, and is of the form :
612 \\author "Real Name" email@address.com
614 Added \\change_deleted, \\change_inserted. Each of these does not
615 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
618 \\change_inserted author time
620 where author is an integer ID reference into the author list in
621 the header, and time is time_t.
623 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
625 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
627 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
629 New graphics dialog. With the removal of buttons in the dialog, also
630 keywords in the graphics inset went. The following keywords do not
640 Only non-default values are saved to the lyx files. The defaults of the remaining
650 BoundingBox <from file>
653 rotateOrigin centerBaseline
655 subcaptionText <empty>
658 The remaining keywords have sufficient overlap with the old ones for a
659 smooth reading of the 1.2.x inset keywords in most common cases.
661 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
662 They don't exist anymore and we can't translate them into a scaling value, while
663 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
664 argument is ignored and lost.
666 Only few compatibility issues are left for lyx2lyx:
668 ------------------------------------------------------------------------------
669 old-token new-token remove
670 ------------------------------------------------------------------------------
671 size_kind original / size_type 0 scale 100 width <val>
675 size_kind width_height / size_type 1 - scale <val>
677 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
678 ------------------------------------------------------------------------------
679 [replace old-token by new-token, and remove any of subsequent tokens as listed]
681 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
682 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
684 replace "rotateAngle <val>" by "rotateAngle 0"
687 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
689 Added \lyxlock for locked math inset when written to .lyx file.
690 When "downgrading" .lyx files this should simple be deleted but it
691 does not hurt at all if it stays in. It does not have to be added
695 2002-08-02 Angus Leeming <leeming@lyx.org>
697 Added a boolean "preview" flag to InsetCommandParams.
698 Currently it is written only by InsetInclude, because only this
699 class can generate a preview of its contents.
701 The LyX file now contains:
703 \begin_inset Include \input{snapshot_t=40.tex}
708 Earlier versions of LyX just swallow this extra token silently.
710 2002-08-12 Angus Leeming <leeming@lyx.org>
712 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
713 renamed as "size_kind" and "lyxsize_kind" respectively.
715 \begin_inset Graphics FormatVersion 1
722 - lyxsize_kind original
723 + lyxsize_type original