1 LyX file-format changes
2 -----------------------
4 2007-08-17 Martin Vermeer
6 * format incremented to 279: CharStyle names are now
7 expected to be of form CharStyle:Name.
11 * format incremented to 278: Close begin_deeper with a
12 corresponding end_deeper (the only case where it matters is
13 at the end of the body).
17 * format incremented to 277: lyx is able to create invalid
18 table where a multicolumn does not have a first cell
19 (required by the table file format)
21 2007-07-20 Dov Feldstern <dov@lyx.org>
23 * format *not* incremented; fixed format 249 conversion, so that it now
24 correctly deals with encodings in footnotes (part of bug 3613)
26 2007-06-26 Uwe Stöhr <uwestoehr@web.de> and Dov Feldstern <dov@lyx.org>
28 * format incremented to 276: switching exsting language 'arabic' to
29 'arabic_arabtex'; this is to differentiate from the new arabic support
30 using the arabi package.
32 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
34 * format incremented to 275: add graphics params scaleBeforeRotation
37 2007-06-13 Dov Feldstern <dov@lyx.org>
38 * format incremented to 274: applying the conversion done in format 259
39 to the \lang property, which was forgotten back then... This is
40 slightly more complicated, because the default language has to be
41 determined on a per-paragraph basis.
43 2007-06-13 Bo Peng <ben.bob@gmail.com>
44 * format incremented to 273: add --Separator-- environment to
45 separate consecutive environments
47 2007-06-13 Bo Peng <bpeng@lyx.org>
48 * format incremented to 272: convert listings to ERT because
49 earlier versions of lyx can not handle unrecognizable
52 2007-05-15 José Matos <jamatos@lyx.org>
53 * format incremented to 271: extended textclasses accept the
54 normal font sizes: 10, 11 and 12pt.
56 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
57 * format incremented to 270: support beamer \alert, \structure
59 2007-05-08 Bo Peng <ben.bob@gmail.com>
60 * format incremented to 269: add listings support
61 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
62 - add inset listings, with options lstparams and inline, e.g.
64 lstparams "xleftmargin=50pt,language=Python"
66 - add \lstinputlisting Include type. e.g.
67 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
69 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
71 * format incremented to 268: add support for the CJK encodings
72 - all encodings supported by CJK.sty are now in lib/encodings
73 - lib/encoding has got two new flags:
75 "inputenc" for those languages that use the inputenc-package and
76 "CJK" for the CJK encodings
77 - "fixed"/"variable" to divide between multi- or single-byte encoding
78 - lib/languages allows now to set an empty language for babel
79 in this case babel isn't called.
81 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
83 * format incremented to 267: add plain utf8 encoding (for XeTeX).
85 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
87 * format incremented to 266:
88 Support for the Armenian language
90 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
92 * format incremented to 265: fix LyX's table border line handling
93 With the fix (see bug 1746) LyX now takes care if the user has entered
94 a "|" character in the argument field of tables. Therefore the "|"
95 character has to be removed when also a table border is set.
97 2007-04-24 José Matos <jamatos@lyx.org>
99 * format incremented to 264:
100 textclass cv is renamed simplecv
102 2007-02-22 José Matos <jamatos@lyx.org>
104 * format incremented to 263: changes in the language names (overdue):
106 portuges -> portuguese
108 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
110 * format incremented to 262: Allow ascii \inputencoding
112 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
114 * format incremented to 261: \output_changes is now considered
115 even if \tracking_changes is false. This allows to output existing
116 changes even if future changes are not tracked anymore.
119 \tracking_changes false
122 is therefore converted to
124 \tracking_changes false
125 \output_changes false
127 on upgrade. Nothing is done on downgrade since the new behaviour is
128 not supported in older formats.
130 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
132 * format incremented to 260: Allow utf8x \inputencoding
134 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
136 * format incremented to 259:
137 Old: Spaces at start or end of font changes were output outside of
138 the font change, i.e. not 'xx\textbf{ yy }zz', but
140 New: Spaces are always output with the font set by the user.
142 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
144 * format incremented to 258: new \lyxline definition
146 \\newcommand{\\lyxline}[1]{
147 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
150 \\newcommand{\\lyxline}[1][1pt]{%
152 \\rule[.5ex]{\\linewidth}{#1}\\par}
153 The new definition is more robust, see bug 1988 and now really takes care about
154 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
156 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
158 * format incremented to 257: Caption styles have been replaced by
159 InsetCaption. This is at the same time also a layout file format
160 change to format 3. layout2layout removes caption layouts from old
162 Note that InsetCaption did exist before this format, but was never
163 used. Old files containing do nevertheless still work.
164 Of course users can still define a Caption style in layout files,
165 but the special treatment in LyX is gone (apart from the sensitive
168 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
170 * format incremented to 256: allow some new inputenc settings.
171 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
173 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
175 * format incremented to 255: new insets for \clearpage and
176 \cleardoublepage. They are written inline to the file, exactly like
179 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
181 * format incremented to 254: new header parameter \use_esint.
182 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
185 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
187 * format incremented to 253: new nomenclature and printnomenclature
188 insets. These are standard InsetCommand with the following parameters:
189 \nomenclature[prefix]{symbol}{description}
190 \printnomenclature[labelwidth]
192 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
194 * format incremented to 252: changed command inset syntax
198 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
209 \begin_inset LatexCommand cmdname
216 The order of the parameters and for each parameter the name and
217 optional/required bit is now stored in InsetCommandParams.
219 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
221 * format incremented to 251: save show_label param for charstyles.
223 On revert, the show_label param is just removed. Nothing to convert.
225 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
227 * Format incremented to 250: allow optional arg to environments
229 No material format change. Now optargs for environments are allowed
230 to be specified in layout files and will be handled properly. When
231 converted back to older formats, they will be ignored in LaTeX
234 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
236 * format incremented to 249: Unicode
238 LyX documents are now always encoded in utf8. The value of
239 \inputencoding does now only determine the encoding of the created
241 Up to format 248 the value of \inputencoding did also determine the
242 encoding of the LyX file:
244 \inputencoding LyX file encoding
245 auto as determined by the document and character
248 everything else as determined by \inputencoding
250 The difference between auto and default is only the LaTeX output:
251 auto causes loading of the inputenc package, default does not.
253 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
255 * format incremented to 248: Basic booktabs support
257 The <features> tag has a new switch: booktabs="true|false".
258 An absent switch is equivalent to booktabs="false".
259 Horizontal lines are set with the booktabs package if this switch
262 The <row> tag of tabulars has the following new attributes:
263 topspace, bottomspace and interlinespace. All take a LyXLength
264 as value, or the special keyword "default".
266 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
268 * format incremented to 247. The Grand Font Interface Rewrite.
269 (1) Split font selection to rm, sf, tt:
270 \fontscheme -> \font_roman, \font_sans, \font_typewriter
272 \fontscheme \font_roman \font_sans \font_typewriter
273 default default default default
274 ae ae default default
275 times times default default
276 palatino palatino default default
277 helvet default helvet default
278 avant default avant default
279 newcent newcent default default
280 bookman bookman default default
281 pslatex times (or \usepackage{pslatex})
283 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
284 lmodern, charter, utopia, ccfonts, chancery, beraserif
285 (-> \usepackage{<name>})
286 \font_sans: cmss, lmss, cmbr
287 (-> \renewcommand{\sfdefault}{<name>})
288 berasans (-> \usepackage{<name>})
289 \font_typewriter: cmtt, lmtt, cmtl,
290 (-> \renewcommand{\sfdefault}{<name>})
291 courier, luximono, beramono
292 (-> \usepackage{<name>})
293 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
294 (3) New param \font_sc (true, false).
295 (4) New param \font_osf (true, false).
296 (5) New param \font_sf_scale (float)
297 (6) New param \font_tt_scale (float)
298 Support for the following fonts has been added:
299 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
300 courier, lmodern, luximono, utopia.
301 Support for the following font has been removed:
302 pslatex (it's superseded by mathptmx (times)).
304 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
306 * format incremented to 246. The framed.sty package is
307 now supported with note types framed and shaded.
309 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
311 * format incremented to 245. The \quotes_times parameter
314 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
316 * format incremented to 244. Rename '\InsetSpace \,'
317 to '\InsetSpace \thinspace{}', because the comma was
318 not parsed by lyxlex, and '\InsetSpace \space' to
319 '\InsetSpace \space{}' in favour of consistency.
321 2005-07-18 José Matos <jamatos@lyx.org>
323 * format incremented to 243.
325 * this change only affects the preamble, the paperpackage
326 option was removed and papersize is changed to default.
328 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
330 * format incremented to 242. There is no file format per
331 se, but the "frenchb" language has been removed from lib/language
332 and has to be translated to "french" by lyx2lyx.
334 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
336 * format incremented to 241.
338 All following changes apply only to text in ERT insets. The
339 rationale is that text in ERT is simply ASCII text, and nothing more.
341 * paragraph breaks are now a single newline in latex and not a
342 paragraph break anymore (bug 698).
343 * \newline is not allowed anymore, because it is redundant (see above)
344 * layouts other than Standard, paragraph parameters and font changes
345 are not allowed anymore. They never made sense and were ignored for
346 latex output, but now they can't be read or set anymore (bug 922).
349 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
351 * format incremented to 240.
353 \output_changes {true|false}
354 (should the change tracking marks be visible in the output or not?)
355 * lyx2lyx should just delete the param in 239.
357 2005-01-06 José Matos <jamatos@lyx.org>
359 * format incremented to 239.
360 * the paragraph parameters are displayed in their own line. This
361 change is consistent with the insets behaviour, and corresponds
362 to a more uniform treatment of the paragraphs since some of them
363 had already their own line.
365 An example of a single paragraph follows:
367 \begin_layout Standard
368 \paragraph_spacing single
374 2004-12-03 José Matos <jamatos@lyx.org>
376 * format incremented to 238.
377 * The compatibility code to read old latex accents from 0.12.x in
378 InsetLatexAccent::checkContents has been removed.
379 The following translations are done:
381 "\i \xy" -> "\i \x{y}"
382 "\i \x y" -> "\i \x{y}"
383 "\i \x\i" -> "\i \x{\i}"
384 "\i \x\j" -> "\i \x{\j}"
385 x is a latex accent command, y the base character. \, i and j are
387 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
388 so formats 215 - 237 can have both versions.
391 2004-10-10 José Matos <jamatos@lyx.org>
393 * format incremented to 237.
394 * In the header, the following statments use now booleans values,
400 2004-08-15 José Matos <jamatos@lyx.org>
402 * format incremented to 236.
409 * The options for \papersize are changed:
412 * All whitespaces are removed at the end of lines, when
413 not necessary. As an example we have all the lines in the header that
414 do not belong to the preamble.
416 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
418 * format incremented to 235.
419 * \paperpackage had an off-by-one error. Translation table:
421 234: a4 a4wide widemarginsa4
422 235: none a4 a4wide widemarginsa4
424 The "widemarginsa4" setting of 235 has no equivalent in 234.
426 2004-05-12 Angus Leeming <leeming@lyx.org>
428 * format incremented to 234.
429 * the citation engine is specified explicitly rather than being
430 deduced from 3 bools.
433 \use_numerical_citations 0 -> \cite_engine <style>
436 where <style> is one of "basic", "natbib_authoryear",
437 "natbib_numerical" or "jurabib".
439 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
441 * format incremented to 233.
442 * insetgraphics does not allow filenames without extension anymore.
443 The complete filename has to be given.
445 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
447 * format incremented to 232.
449 * Support for bibtopic (sectioned bibliographies).
450 - bufferparam \use_bibtopic [1|0]
451 - the bibtex inset has a second argument for bibtopic's
452 btPrint{Cited|NotCited|All} command:
454 \begin_inset LatexCommand \bibtex[<style>]{<database>}
456 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
457 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
458 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
459 \bibliographystyle{<style>}
460 \begin{btSect}{<database>}
465 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
467 * format incremented to 231.
469 * Support for sidewaysfigure/sidewaystable (rotating package).
470 insetfloat has now a param \sideways [true|false] (default is false).
471 The param should be erased on downwards conversion, if it was true,
472 the inset should be replaced by
473 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
475 \begin{sidewaystable} <content> \end{sidewaystable}
478 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
480 * format incremented to 230.
482 * Support for a second optional argument in insetcommand.
483 currently, citation uses this to support natbibs second
484 optional argument \cite[before][after]{key}.
485 I think there's nothing to convert upwards. Downwards, the
486 commands with 2 optional args need to be converted to ERT.
488 * Support for jurabib (param \use_jurabib [1|0], default is 0).
489 When converting downwards, \usepackage{jurabib} has to be added
490 to the preamble and, if babel is used, \usepackage{babel} before
491 (jurabib fails if babel is called afterwards). If the natbib commands
492 are used together with jurabib, they have to be converted to ERT too.
494 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
496 * format incremented to 229.
497 * Minipages cannot be read anymore. All minipage insets will
498 be converted to frameless box insets between 228->229.
500 2003-12-15 Angus Leeming <leeming@lyx.org>
502 * format incremented to 228.
503 * Change the output of all insets derived from InsetCollapsable
504 except for InsetERT (which has a similar output already), changing lines
505 "collapsed true" -> "status collapsed"
506 "collapsed false" -> "status open".
507 * Change the output of InsetERT, changing lines
508 "status Collapsed" -> "status collapsed"
509 "status Open" -> "status open".
510 "status Inlined" -> "status inlined".
512 2003-12-10 Angus Leeming <leeming@lyx.org>
514 * format NOT incremented.
515 * add a 'draft' option to InsetExternal.
517 2003-12-10 Angus Leeming <leeming@lyx.org>
519 * format incremented to 227.
520 * Change the output of InsetBox:
521 \begin_inset Boxed -> \begin_inset Box Boxed
522 \begin_inset Doublebox -> \begin_inset Box Doublebox
523 \begin_inset Frameless -> \begin_inset Box Frameless
524 \begin_inset ovalbox -> \begin_inset Box ovalbox
525 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
526 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
528 2003-12-10 Angus Leeming <leeming@lyx.org>
530 * format incremented to 226.
531 * Change the output of InsetNote:
532 \begin_inset Note -> \begin_inset Note Note
533 \begin_inset Comment -> \begin_inset Note Comment
534 \begin_inset Greyedout -> \begin_inset Note Greyedout
536 2003-11-28 André Pönitz
538 * Remove space_above/space_below from Paragraph.
539 This is now handled by InsetVSpace.
541 2003-10-07 Angus Leeming <leeming@lyx.org>
543 * Add transformations to InsetExternal
545 boundingBox 0 0 20 20 the dimensions of the B.B..
546 Output if the B.B. is not empty.
547 clip clip the image to the B.B.
549 extra LaTeX "draft" 'extra' data passed to the primary
550 command for this output format.
551 (Possible formats LaTeX, PDFLaTeX,
552 LinuxDoc, DocBook, Ascii.)
553 The string can contain spaces and so
555 rotateAngle 30 Rotation of the data.
556 Output for non-zero rotation only.
557 rotateOrigin bottomleft Rotation origin.
558 Output for non-zero rotation and
559 non-default origin (center) only.
561 width 2cm Output only if the image is resized.
565 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
567 * Added box inset. File format:
569 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
574 inner_pos "b" t/c/b/s
576 width "100col%" unit+width-string
577 special "none" none/height/depth
579 height "1in" unit+width-string
580 height_special "totalheight" none/height/depth
582 collapsed false true/false
584 \begin_layout Standard
591 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
592 the pre-existing Minipage inset. Parameters translate as follows:
593 position 0/1/2 -> t/c/b
594 inner_position 0/1/2/3 -> inner_pos c/t/b/s
599 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
601 * attribute valignment="center" is replaced by valignment="middle"
602 for tabular columns and cells
604 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
606 * Added branch inset. File format:
608 branch definition in the header:
614 \begin_inset Branch <branchname>
615 collapsed false true/false
617 \begin_layout Standard
624 2003-07-28 José Matos <jamatos@lyx.org>
626 * \the_end is replaced with \end_document
628 2003-07-28 José Matos <jamatos@lyx.org>
630 * \layout is replaced with \begin_layout
632 2003-07-28 José Matos <jamatos@fep.up.pt>
636 * All layouts finish now with \end_layout
638 2003-06-04 Angus Leeming <leeming@lyx.org>
642 * the storage of the external inset has been changed from
644 \begin_inset External XFig,"file.fig",""
650 \begin_inset External
653 display <display_type>
658 throwing away the final arg (here "", more generally "<string>") that holds
659 the parameters variable.
660 Variables are output if present (filename) or different from the default
661 values (display, lyxscale).
663 Moreover, the RasterImage template has been scrapped. All RasterImage
664 external insets are now converted to Graphics insets.
666 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
668 * Added new space insets:
669 \SpecialChar ~ is now \InsetSpace ~
670 ERT: "\ " could be converted to InsetSpace \<space>
671 ERT: "\," could be converted to InsetSpace \,
673 2003-04-24 André Pönitz <poenitz@gmx.net>
675 * Added eqref support:
676 \begin_inset LatexCommand \eqref{label}
678 2003-03-14 Dekel Tsur
680 * Format bumped to 223.
682 2003-03-12 John Levon <levon@movementarian.org>
684 * Added \\end_header to signify the end of the header in a
687 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
689 2003-02-10 John Levon <levon@movementarian.org>
693 Added \\tracking_changes 0|1 to the header.
695 Added \\author to the header. This can be present multiple
696 times, and is of the form :
698 \\author "Real Name" email@address.com
700 Added \\change_deleted, \\change_inserted. Each of these does not
701 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
704 \\change_inserted author time
706 where author is an integer ID reference into the author list in
707 the header, and time is time_t.
709 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
711 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
713 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
715 New graphics dialog. With the removal of buttons in the dialog, also
716 keywords in the graphics inset went. The following keywords do not
726 Only non-default values are saved to the lyx files. The defaults of the remaining
736 BoundingBox <from file>
739 rotateOrigin centerBaseline
741 subcaptionText <empty>
744 The remaining keywords have sufficient overlap with the old ones for a
745 smooth reading of the 1.2.x inset keywords in most common cases.
747 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
748 They don't exist anymore and we can't translate them into a scaling value, while
749 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
750 argument is ignored and lost.
752 Only few compatibility issues are left for lyx2lyx:
754 ------------------------------------------------------------------------------
755 old-token new-token remove
756 ------------------------------------------------------------------------------
757 size_kind original / size_type 0 scale 100 width <val>
761 size_kind width_height / size_type 1 - scale <val>
763 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
764 ------------------------------------------------------------------------------
765 [replace old-token by new-token, and remove any of subsequent tokens as listed]
767 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
768 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
770 replace "rotateAngle <val>" by "rotateAngle 0"
773 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
775 Added \lyxlock for locked math inset when written to .lyx file.
776 When "downgrading" .lyx files this should simple be deleted but it
777 does not hurt at all if it stays in. It does not have to be added
781 2002-08-02 Angus Leeming <leeming@lyx.org>
783 Added a boolean "preview" flag to InsetCommandParams.
784 Currently it is written only by InsetInclude, because only this
785 class can generate a preview of its contents.
787 The LyX file now contains:
789 \begin_inset Include \input{snapshot_t=40.tex}
794 Earlier versions of LyX just swallow this extra token silently.
796 2002-08-12 Angus Leeming <leeming@lyx.org>
798 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
799 renamed as "size_kind" and "lyxsize_kind" respectively.
801 \begin_inset Graphics FormatVersion 1
808 - lyxsize_kind original
809 + lyxsize_type original