1 LyX file-format changes
2 -----------------------
4 2007-08-17 Martin Vermeer
6 * format incremented to 280: the show_label parameter
7 is depreciated in favour of (Collapsable) status.
9 2007-08-17 Martin Vermeer
11 * format incremented to 279: CharStyle names are now
12 expected to be of form CharStyle:Name.
16 * format incremented to 278: Close begin_deeper with a
17 corresponding end_deeper (the only case where it matters is
18 at the end of the body).
22 * format incremented to 277: lyx is able to create invalid
23 table where a multicolumn does not have a first cell
24 (required by the table file format)
26 2007-07-20 Dov Feldstern <dov@lyx.org>
28 * format *not* incremented; fixed format 249 conversion, so that it now
29 correctly deals with encodings in footnotes (part of bug 3613)
31 2007-06-26 Uwe Stöhr <uwestoehr@web.de> and Dov Feldstern <dov@lyx.org>
33 * format incremented to 276: switching exsting language 'arabic' to
34 'arabic_arabtex'; this is to differentiate from the new arabic support
35 using the arabi package.
37 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
39 * format incremented to 275: add graphics params scaleBeforeRotation
42 2007-06-13 Dov Feldstern <dov@lyx.org>
43 * format incremented to 274: applying the conversion done in format 259
44 to the \lang property, which was forgotten back then... This is
45 slightly more complicated, because the default language has to be
46 determined on a per-paragraph basis.
48 2007-06-13 Bo Peng <ben.bob@gmail.com>
49 * format incremented to 273: add --Separator-- environment to
50 separate consecutive environments
52 2007-06-13 Bo Peng <bpeng@lyx.org>
53 * format incremented to 272: convert listings to ERT because
54 earlier versions of lyx can not handle unrecognizable
57 2007-05-15 José Matos <jamatos@lyx.org>
58 * format incremented to 271: extended textclasses accept the
59 normal font sizes: 10, 11 and 12pt.
61 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
62 * format incremented to 270: support beamer \alert, \structure
64 2007-05-08 Bo Peng <ben.bob@gmail.com>
65 * format incremented to 269: add listings support
66 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
67 - add inset listings, with options lstparams and inline, e.g.
69 lstparams "xleftmargin=50pt,language=Python"
71 - add \lstinputlisting Include type. e.g.
72 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
74 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
76 * format incremented to 268: add support for the CJK encodings
77 - all encodings supported by CJK.sty are now in lib/encodings
78 - lib/encoding has got two new flags:
80 "inputenc" for those languages that use the inputenc-package and
81 "CJK" for the CJK encodings
82 - "fixed"/"variable" to divide between multi- or single-byte encoding
83 - lib/languages allows now to set an empty language for babel
84 in this case babel isn't called.
86 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
88 * format incremented to 267: add plain utf8 encoding (for XeTeX).
90 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
92 * format incremented to 266:
93 Support for the Armenian language
95 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
97 * format incremented to 265: fix LyX's table border line handling
98 With the fix (see bug 1746) LyX now takes care if the user has entered
99 a "|" character in the argument field of tables. Therefore the "|"
100 character has to be removed when also a table border is set.
102 2007-04-24 José Matos <jamatos@lyx.org>
104 * format incremented to 264:
105 textclass cv is renamed simplecv
107 2007-02-22 José Matos <jamatos@lyx.org>
109 * format incremented to 263: changes in the language names (overdue):
111 portuges -> portuguese
113 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
115 * format incremented to 262: Allow ascii \inputencoding
117 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
119 * format incremented to 261: \output_changes is now considered
120 even if \tracking_changes is false. This allows to output existing
121 changes even if future changes are not tracked anymore.
124 \tracking_changes false
127 is therefore converted to
129 \tracking_changes false
130 \output_changes false
132 on upgrade. Nothing is done on downgrade since the new behaviour is
133 not supported in older formats.
135 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
137 * format incremented to 260: Allow utf8x \inputencoding
139 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
141 * format incremented to 259:
142 Old: Spaces at start or end of font changes were output outside of
143 the font change, i.e. not 'xx\textbf{ yy }zz', but
145 New: Spaces are always output with the font set by the user.
147 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
149 * format incremented to 258: new \lyxline definition
151 \\newcommand{\\lyxline}[1]{
152 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
155 \\newcommand{\\lyxline}[1][1pt]{%
157 \\rule[.5ex]{\\linewidth}{#1}\\par}
158 The new definition is more robust, see bug 1988 and now really takes care about
159 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
161 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
163 * format incremented to 257: Caption styles have been replaced by
164 InsetCaption. This is at the same time also a layout file format
165 change to format 3. layout2layout removes caption layouts from old
167 Note that InsetCaption did exist before this format, but was never
168 used. Old files containing do nevertheless still work.
169 Of course users can still define a Caption style in layout files,
170 but the special treatment in LyX is gone (apart from the sensitive
173 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
175 * format incremented to 256: allow some new inputenc settings.
176 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
178 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
180 * format incremented to 255: new insets for \clearpage and
181 \cleardoublepage. They are written inline to the file, exactly like
184 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
186 * format incremented to 254: new header parameter \use_esint.
187 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
190 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
192 * format incremented to 253: new nomenclature and printnomenclature
193 insets. These are standard InsetCommand with the following parameters:
194 \nomenclature[prefix]{symbol}{description}
195 \printnomenclature[labelwidth]
197 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
199 * format incremented to 252: changed command inset syntax
203 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
214 \begin_inset LatexCommand cmdname
221 The order of the parameters and for each parameter the name and
222 optional/required bit is now stored in InsetCommandParams.
224 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
226 * format incremented to 251: save show_label param for charstyles.
228 On revert, the show_label param is just removed. Nothing to convert.
230 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
232 * Format incremented to 250: allow optional arg to environments
234 No material format change. Now optargs for environments are allowed
235 to be specified in layout files and will be handled properly. When
236 converted back to older formats, they will be ignored in LaTeX
239 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
241 * format incremented to 249: Unicode
243 LyX documents are now always encoded in utf8. The value of
244 \inputencoding does now only determine the encoding of the created
246 Up to format 248 the value of \inputencoding did also determine the
247 encoding of the LyX file:
249 \inputencoding LyX file encoding
250 auto as determined by the document and character
253 everything else as determined by \inputencoding
255 The difference between auto and default is only the LaTeX output:
256 auto causes loading of the inputenc package, default does not.
258 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
260 * format incremented to 248: Basic booktabs support
262 The <features> tag has a new switch: booktabs="true|false".
263 An absent switch is equivalent to booktabs="false".
264 Horizontal lines are set with the booktabs package if this switch
267 The <row> tag of tabulars has the following new attributes:
268 topspace, bottomspace and interlinespace. All take a LyXLength
269 as value, or the special keyword "default".
271 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
273 * format incremented to 247. The Grand Font Interface Rewrite.
274 (1) Split font selection to rm, sf, tt:
275 \fontscheme -> \font_roman, \font_sans, \font_typewriter
277 \fontscheme \font_roman \font_sans \font_typewriter
278 default default default default
279 ae ae default default
280 times times default default
281 palatino palatino default default
282 helvet default helvet default
283 avant default avant default
284 newcent newcent default default
285 bookman bookman default default
286 pslatex times (or \usepackage{pslatex})
288 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
289 lmodern, charter, utopia, ccfonts, chancery, beraserif
290 (-> \usepackage{<name>})
291 \font_sans: cmss, lmss, cmbr
292 (-> \renewcommand{\sfdefault}{<name>})
293 berasans (-> \usepackage{<name>})
294 \font_typewriter: cmtt, lmtt, cmtl,
295 (-> \renewcommand{\sfdefault}{<name>})
296 courier, luximono, beramono
297 (-> \usepackage{<name>})
298 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
299 (3) New param \font_sc (true, false).
300 (4) New param \font_osf (true, false).
301 (5) New param \font_sf_scale (float)
302 (6) New param \font_tt_scale (float)
303 Support for the following fonts has been added:
304 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
305 courier, lmodern, luximono, utopia.
306 Support for the following font has been removed:
307 pslatex (it's superseded by mathptmx (times)).
309 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
311 * format incremented to 246. The framed.sty package is
312 now supported with note types framed and shaded.
314 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
316 * format incremented to 245. The \quotes_times parameter
319 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
321 * format incremented to 244. Rename '\InsetSpace \,'
322 to '\InsetSpace \thinspace{}', because the comma was
323 not parsed by lyxlex, and '\InsetSpace \space' to
324 '\InsetSpace \space{}' in favour of consistency.
326 2005-07-18 José Matos <jamatos@lyx.org>
328 * format incremented to 243.
330 * this change only affects the preamble, the paperpackage
331 option was removed and papersize is changed to default.
333 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
335 * format incremented to 242. There is no file format per
336 se, but the "frenchb" language has been removed from lib/language
337 and has to be translated to "french" by lyx2lyx.
339 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
341 * format incremented to 241.
343 All following changes apply only to text in ERT insets. The
344 rationale is that text in ERT is simply ASCII text, and nothing more.
346 * paragraph breaks are now a single newline in latex and not a
347 paragraph break anymore (bug 698).
348 * \newline is not allowed anymore, because it is redundant (see above)
349 * layouts other than Standard, paragraph parameters and font changes
350 are not allowed anymore. They never made sense and were ignored for
351 latex output, but now they can't be read or set anymore (bug 922).
354 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
356 * format incremented to 240.
358 \output_changes {true|false}
359 (should the change tracking marks be visible in the output or not?)
360 * lyx2lyx should just delete the param in 239.
362 2005-01-06 José Matos <jamatos@lyx.org>
364 * format incremented to 239.
365 * the paragraph parameters are displayed in their own line. This
366 change is consistent with the insets behaviour, and corresponds
367 to a more uniform treatment of the paragraphs since some of them
368 had already their own line.
370 An example of a single paragraph follows:
372 \begin_layout Standard
373 \paragraph_spacing single
379 2004-12-03 José Matos <jamatos@lyx.org>
381 * format incremented to 238.
382 * The compatibility code to read old latex accents from 0.12.x in
383 InsetLatexAccent::checkContents has been removed.
384 The following translations are done:
386 "\i \xy" -> "\i \x{y}"
387 "\i \x y" -> "\i \x{y}"
388 "\i \x\i" -> "\i \x{\i}"
389 "\i \x\j" -> "\i \x{\j}"
390 x is a latex accent command, y the base character. \, i and j are
392 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
393 so formats 215 - 237 can have both versions.
396 2004-10-10 José Matos <jamatos@lyx.org>
398 * format incremented to 237.
399 * In the header, the following statments use now booleans values,
405 2004-08-15 José Matos <jamatos@lyx.org>
407 * format incremented to 236.
414 * The options for \papersize are changed:
417 * All whitespaces are removed at the end of lines, when
418 not necessary. As an example we have all the lines in the header that
419 do not belong to the preamble.
421 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
423 * format incremented to 235.
424 * \paperpackage had an off-by-one error. Translation table:
426 234: a4 a4wide widemarginsa4
427 235: none a4 a4wide widemarginsa4
429 The "widemarginsa4" setting of 235 has no equivalent in 234.
431 2004-05-12 Angus Leeming <leeming@lyx.org>
433 * format incremented to 234.
434 * the citation engine is specified explicitly rather than being
435 deduced from 3 bools.
438 \use_numerical_citations 0 -> \cite_engine <style>
441 where <style> is one of "basic", "natbib_authoryear",
442 "natbib_numerical" or "jurabib".
444 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
446 * format incremented to 233.
447 * insetgraphics does not allow filenames without extension anymore.
448 The complete filename has to be given.
450 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
452 * format incremented to 232.
454 * Support for bibtopic (sectioned bibliographies).
455 - bufferparam \use_bibtopic [1|0]
456 - the bibtex inset has a second argument for bibtopic's
457 btPrint{Cited|NotCited|All} command:
459 \begin_inset LatexCommand \bibtex[<style>]{<database>}
461 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
462 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
463 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
464 \bibliographystyle{<style>}
465 \begin{btSect}{<database>}
470 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
472 * format incremented to 231.
474 * Support for sidewaysfigure/sidewaystable (rotating package).
475 insetfloat has now a param \sideways [true|false] (default is false).
476 The param should be erased on downwards conversion, if it was true,
477 the inset should be replaced by
478 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
480 \begin{sidewaystable} <content> \end{sidewaystable}
483 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
485 * format incremented to 230.
487 * Support for a second optional argument in insetcommand.
488 currently, citation uses this to support natbibs second
489 optional argument \cite[before][after]{key}.
490 I think there's nothing to convert upwards. Downwards, the
491 commands with 2 optional args need to be converted to ERT.
493 * Support for jurabib (param \use_jurabib [1|0], default is 0).
494 When converting downwards, \usepackage{jurabib} has to be added
495 to the preamble and, if babel is used, \usepackage{babel} before
496 (jurabib fails if babel is called afterwards). If the natbib commands
497 are used together with jurabib, they have to be converted to ERT too.
499 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
501 * format incremented to 229.
502 * Minipages cannot be read anymore. All minipage insets will
503 be converted to frameless box insets between 228->229.
505 2003-12-15 Angus Leeming <leeming@lyx.org>
507 * format incremented to 228.
508 * Change the output of all insets derived from InsetCollapsable
509 except for InsetERT (which has a similar output already), changing lines
510 "collapsed true" -> "status collapsed"
511 "collapsed false" -> "status open".
512 * Change the output of InsetERT, changing lines
513 "status Collapsed" -> "status collapsed"
514 "status Open" -> "status open".
515 "status Inlined" -> "status inlined".
517 2003-12-10 Angus Leeming <leeming@lyx.org>
519 * format NOT incremented.
520 * add a 'draft' option to InsetExternal.
522 2003-12-10 Angus Leeming <leeming@lyx.org>
524 * format incremented to 227.
525 * Change the output of InsetBox:
526 \begin_inset Boxed -> \begin_inset Box Boxed
527 \begin_inset Doublebox -> \begin_inset Box Doublebox
528 \begin_inset Frameless -> \begin_inset Box Frameless
529 \begin_inset ovalbox -> \begin_inset Box ovalbox
530 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
531 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
533 2003-12-10 Angus Leeming <leeming@lyx.org>
535 * format incremented to 226.
536 * Change the output of InsetNote:
537 \begin_inset Note -> \begin_inset Note Note
538 \begin_inset Comment -> \begin_inset Note Comment
539 \begin_inset Greyedout -> \begin_inset Note Greyedout
541 2003-11-28 André Pönitz
543 * Remove space_above/space_below from Paragraph.
544 This is now handled by InsetVSpace.
546 2003-10-07 Angus Leeming <leeming@lyx.org>
548 * Add transformations to InsetExternal
550 boundingBox 0 0 20 20 the dimensions of the B.B..
551 Output if the B.B. is not empty.
552 clip clip the image to the B.B.
554 extra LaTeX "draft" 'extra' data passed to the primary
555 command for this output format.
556 (Possible formats LaTeX, PDFLaTeX,
557 LinuxDoc, DocBook, Ascii.)
558 The string can contain spaces and so
560 rotateAngle 30 Rotation of the data.
561 Output for non-zero rotation only.
562 rotateOrigin bottomleft Rotation origin.
563 Output for non-zero rotation and
564 non-default origin (center) only.
566 width 2cm Output only if the image is resized.
570 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
572 * Added box inset. File format:
574 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
579 inner_pos "b" t/c/b/s
581 width "100col%" unit+width-string
582 special "none" none/height/depth
584 height "1in" unit+width-string
585 height_special "totalheight" none/height/depth
587 collapsed false true/false
589 \begin_layout Standard
596 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
597 the pre-existing Minipage inset. Parameters translate as follows:
598 position 0/1/2 -> t/c/b
599 inner_position 0/1/2/3 -> inner_pos c/t/b/s
604 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
606 * attribute valignment="center" is replaced by valignment="middle"
607 for tabular columns and cells
609 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
611 * Added branch inset. File format:
613 branch definition in the header:
619 \begin_inset Branch <branchname>
620 collapsed false true/false
622 \begin_layout Standard
629 2003-07-28 José Matos <jamatos@lyx.org>
631 * \the_end is replaced with \end_document
633 2003-07-28 José Matos <jamatos@lyx.org>
635 * \layout is replaced with \begin_layout
637 2003-07-28 José Matos <jamatos@fep.up.pt>
641 * All layouts finish now with \end_layout
643 2003-06-04 Angus Leeming <leeming@lyx.org>
647 * the storage of the external inset has been changed from
649 \begin_inset External XFig,"file.fig",""
655 \begin_inset External
658 display <display_type>
663 throwing away the final arg (here "", more generally "<string>") that holds
664 the parameters variable.
665 Variables are output if present (filename) or different from the default
666 values (display, lyxscale).
668 Moreover, the RasterImage template has been scrapped. All RasterImage
669 external insets are now converted to Graphics insets.
671 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
673 * Added new space insets:
674 \SpecialChar ~ is now \InsetSpace ~
675 ERT: "\ " could be converted to InsetSpace \<space>
676 ERT: "\," could be converted to InsetSpace \,
678 2003-04-24 André Pönitz <poenitz@gmx.net>
680 * Added eqref support:
681 \begin_inset LatexCommand \eqref{label}
683 2003-03-14 Dekel Tsur
685 * Format bumped to 223.
687 2003-03-12 John Levon <levon@movementarian.org>
689 * Added \\end_header to signify the end of the header in a
692 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
694 2003-02-10 John Levon <levon@movementarian.org>
698 Added \\tracking_changes 0|1 to the header.
700 Added \\author to the header. This can be present multiple
701 times, and is of the form :
703 \\author "Real Name" email@address.com
705 Added \\change_deleted, \\change_inserted. Each of these does not
706 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
709 \\change_inserted author time
711 where author is an integer ID reference into the author list in
712 the header, and time is time_t.
714 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
716 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
718 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
720 New graphics dialog. With the removal of buttons in the dialog, also
721 keywords in the graphics inset went. The following keywords do not
731 Only non-default values are saved to the lyx files. The defaults of the remaining
741 BoundingBox <from file>
744 rotateOrigin centerBaseline
746 subcaptionText <empty>
749 The remaining keywords have sufficient overlap with the old ones for a
750 smooth reading of the 1.2.x inset keywords in most common cases.
752 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
753 They don't exist anymore and we can't translate them into a scaling value, while
754 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
755 argument is ignored and lost.
757 Only few compatibility issues are left for lyx2lyx:
759 ------------------------------------------------------------------------------
760 old-token new-token remove
761 ------------------------------------------------------------------------------
762 size_kind original / size_type 0 scale 100 width <val>
766 size_kind width_height / size_type 1 - scale <val>
768 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
769 ------------------------------------------------------------------------------
770 [replace old-token by new-token, and remove any of subsequent tokens as listed]
772 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
773 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
775 replace "rotateAngle <val>" by "rotateAngle 0"
778 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
780 Added \lyxlock for locked math inset when written to .lyx file.
781 When "downgrading" .lyx files this should simple be deleted but it
782 does not hurt at all if it stays in. It does not have to be added
786 2002-08-02 Angus Leeming <leeming@lyx.org>
788 Added a boolean "preview" flag to InsetCommandParams.
789 Currently it is written only by InsetInclude, because only this
790 class can generate a preview of its contents.
792 The LyX file now contains:
794 \begin_inset Include \input{snapshot_t=40.tex}
799 Earlier versions of LyX just swallow this extra token silently.
801 2002-08-12 Angus Leeming <leeming@lyx.org>
803 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
804 renamed as "size_kind" and "lyxsize_kind" respectively.
806 \begin_inset Graphics FormatVersion 1
813 - lyxsize_kind original
814 + lyxsize_type original