1 LyX file-format changes
2 -----------------------
3 2007-05-15 José Matos <jamatos@lyx.org>
4 * format incremented to 271: extended textclasses accept the
5 normal font sizes: 10, 11 and 12pt.
7 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
8 * format incremented to 270: support beamer \alert, \structure
10 2007-05-08 Bo Peng <ben.bob@gmail.com>
11 * format incremented to 269: add listings support
12 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
13 - add inset listings, with options lstparams and inline, e.g.
15 lstparams "xleftmargin=50pt,language=Python"
17 - add \lstinputlisting Include type. e.g.
18 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
20 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
22 * format incremented to 268: add support for the CJK encodings
23 - all encodings supported by CJK.sty are now in lib/encodings
24 - lib/encoding has got two new flags:
26 "inputenc" for those languages that use the inputenc-package and
27 "CJK" for the CJK encodings
28 - "fixed"/"variable" to divide between multi- or single-byte encoding
29 - lib/languages allows now to set an empty language for babel
30 in this case babel isn't called.
32 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
34 * format incremented to 267: add plain utf8 encoding (for XeTeX).
36 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
38 * format incremented to 266:
39 Support for the Armenian language
41 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
43 * format incremented to 265: fix LyX's table border line handling
44 With the fix (see bug 1746) LyX now takes care if the user has entered
45 a "|" character in the argument field of tables. Therefore the "|"
46 character has to be removed when also a table border is set.
48 2007-04-24 José Matos <jamatos@lyx.org>
50 * format incremented to 264:
51 textclass cv is renamed simplecv
53 2007-02-22 José Matos <jamatos@lyx.org>
55 * format incremented to 263: changes in the language names (overdue):
57 portuges -> portuguese
59 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
61 * format incremented to 262: Allow ascii \inputencoding
63 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
65 * format incremented to 261: \output_changes is now considered
66 even if \tracking_changes is false. This allows to output existing
67 changes even if future changes are not tracked anymore.
70 \tracking_changes false
73 is therefore converted to
75 \tracking_changes false
78 on upgrade. Nothing is done on downgrade since the new behaviour is
79 not supported in older formats.
81 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
83 * format incremented to 260: Allow utf8x \inputencoding
85 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
87 * format incremented to 259:
88 Old: Spaces at start or end of font changes were output outside of
89 the font change, i.e. not 'xx\textbf{ yy }zz', but
91 New: Spaces are always output with the font set by the user.
93 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
95 * format incremented to 258: new \lyxline definition
97 \\newcommand{\\lyxline}[1]{
98 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
101 \\newcommand{\\lyxline}[1][1pt]{%
103 \\rule[.5ex]{\\linewidth}{#1}\\par}
104 The new definition is more robust, see bug 1988 and now really takes care about
105 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
107 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
109 * format incremented to 257: Caption styles have been replaced by
110 InsetCaption. This is at the same time also a layout file format
111 change to format 3. layout2layout removes caption layouts from old
113 Note that InsetCaption did exist before this format, but was never
114 used. Old files containing do nevertheless still work.
115 Of course users can still define a Caption style in layout files,
116 but the special treatment in LyX is gone (apart from the sensitive
119 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
121 * format incremented to 256: allow some new inputenc settings.
122 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
124 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
126 * format incremented to 255: new insets for \clearpage and
127 \cleardoublepage. They are written inline to the file, exactly like
130 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
132 * format incremented to 254: new header parameter \use_esint.
133 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
136 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
138 * format incremented to 253: new nomenclature and printnomenclature
139 insets. These are standard InsetCommand with the following parameters:
140 \nomenclature[prefix]{symbol}{description}
141 \printnomenclature[labelwidth]
143 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
145 * format incremented to 252: changed command inset syntax
149 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
160 \begin_inset LatexCommand cmdname
167 The order of the parameters and for each parameter the name and
168 optional/required bit is now stored in InsetCommandParams.
170 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
172 * format incremented to 251: save show_label param for charstyles.
174 On revert, the show_label param is just removed. Nothing to convert.
176 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
178 * Format incremented to 250: allow optional arg to environments
180 No material format change. Now optargs for environments are allowed
181 to be specified in layout files and will be handled properly. When
182 converted back to older formats, they will be ignored in LaTeX
185 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
187 * format incremented to 249: Unicode
189 LyX documents are now always encoded in utf8. The value of
190 \inputencoding does now only determine the encoding of the created
192 Up to format 248 the value of \inputencoding did also determine the
193 encoding of the LyX file:
195 \inputencoding LyX file encoding
196 auto as determined by the document and character
199 everything else as determined by \inputencoding
201 The difference between auto and default is only the LaTeX output:
202 auto causes loading of the inputenc package, default does not.
204 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
206 * format incremented to 248: Basic booktabs support
208 The <features> tag has a new switch: booktabs="true|false".
209 An absent switch is equivalent to booktabs="false".
210 Horizontal lines are set with the booktabs package if this switch
213 The <row> tag of tabulars has the following new attributes:
214 topspace, bottomspace and interlinespace. All take a LyXLength
215 as value, or the special keyword "default".
217 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
219 * format incremented to 247. The Grand Font Interface Rewrite.
220 (1) Split font selection to rm, sf, tt:
221 \fontscheme -> \font_roman, \font_sans, \font_typewriter
223 \fontscheme \font_roman \font_sans \font_typewriter
224 default default default default
225 ae ae default default
226 times times default default
227 palatino palatino default default
228 helvet default helvet default
229 avant default avant default
230 newcent newcent default default
231 bookman bookman default default
232 pslatex times (or \usepackage{pslatex})
234 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
235 lmodern, charter, utopia, ccfonts, chancery, beraserif
236 (-> \usepackage{<name>})
237 \font_sans: cmss, lmss, cmbr
238 (-> \renewcommand{\sfdefault}{<name>})
239 berasans (-> \usepackage{<name>})
240 \font_typewriter: cmtt, lmtt, cmtl,
241 (-> \renewcommand{\sfdefault}{<name>})
242 courier, luximono, beramono
243 (-> \usepackage{<name>})
244 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
245 (3) New param \font_sc (true, false).
246 (4) New param \font_osf (true, false).
247 (5) New param \font_sf_scale (float)
248 (6) New param \font_tt_scale (float)
249 Support for the following fonts has been added:
250 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
251 courier, lmodern, luximono, utopia.
252 Support for the following font has been removed:
253 pslatex (it's superseded by mathptmx (times)).
255 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
257 * format incremented to 246. The framed.sty package is
258 now supported with note types framed and shaded.
260 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
262 * format incremented to 245. The \quotes_times parameter
265 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
267 * format incremented to 244. Rename '\InsetSpace \,'
268 to '\InsetSpace \thinspace{}', because the comma was
269 not parsed by lyxlex, and '\InsetSpace \space' to
270 '\InsetSpace \space{}' in favour of consistency.
272 2005-07-18 José Matos <jamatos@lyx.org>
274 * format incremented to 243.
276 * this change only affects the preamble, the paperpackage
277 option was removed and papersize is changed to default.
279 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
281 * format incremented to 242. There is no file format per
282 se, but the "frenchb" language has been removed from lib/language
283 and has to be translated to "french" by lyx2lyx.
285 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
287 * format incremented to 241.
289 All following changes apply only to text in ERT insets. The
290 rationale is that text in ERT is simply ASCII text, and nothing more.
292 * paragraph breaks are now a single newline in latex and not a
293 paragraph break anymore (bug 698).
294 * \newline is not allowed anymore, because it is redundant (see above)
295 * layouts other than Standard, paragraph parameters and font changes
296 are not allowed anymore. They never made sense and were ignored for
297 latex output, but now they can't be read or set anymore (bug 922).
300 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
302 * format incremented to 240.
304 \output_changes {true|false}
305 (should the change tracking marks be visible in the output or not?)
306 * lyx2lyx should just delete the param in 239.
308 2005-01-06 José Matos <jamatos@lyx.org>
310 * format incremented to 239.
311 * the paragraph parameters are displayed in their own line. This
312 change is consistent with the insets behaviour, and corresponds
313 to a more uniform treatment of the paragraphs since some of them
314 had already their own line.
316 An example of a single paragraph follows:
318 \begin_layout Standard
319 \paragraph_spacing single
325 2004-12-03 José Matos <jamatos@lyx.org>
327 * format incremented to 238.
328 * The compatibility code to read old latex accents from 0.12.x in
329 InsetLatexAccent::checkContents has been removed.
330 The following translations are done:
332 "\i \xy" -> "\i \x{y}"
333 "\i \x y" -> "\i \x{y}"
334 "\i \x\i" -> "\i \x{\i}"
335 "\i \x\j" -> "\i \x{\j}"
336 x is a latex accent command, y the base character. \, i and j are
338 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
339 so formats 215 - 237 can have both versions.
342 2004-10-10 José Matos <jamatos@lyx.org>
344 * format incremented to 237.
345 * In the header, the following statments use now booleans values,
351 2004-08-15 José Matos <jamatos@lyx.org>
353 * format incremented to 236.
360 * The options for \papersize are changed:
363 * All whitespaces are removed at the end of lines, when
364 not necessary. As an example we have all the lines in the header that
365 do not belong to the preamble.
367 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
369 * format incremented to 235.
370 * \paperpackage had an off-by-one error. Translation table:
372 234: a4 a4wide widemarginsa4
373 235: none a4 a4wide widemarginsa4
375 The "widemarginsa4" setting of 235 has no equivalent in 234.
377 2004-05-12 Angus Leeming <leeming@lyx.org>
379 * format incremented to 234.
380 * the citation engine is specified explicitly rather than being
381 deduced from 3 bools.
384 \use_numerical_citations 0 -> \cite_engine <style>
387 where <style> is one of "basic", "natbib_authoryear",
388 "natbib_numerical" or "jurabib".
390 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
392 * format incremented to 233.
393 * insetgraphics does not allow filenames without extension anymore.
394 The complete filename has to be given.
396 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
398 * format incremented to 232.
400 * Support for bibtopic (sectioned bibliographies).
401 - bufferparam \use_bibtopic [1|0]
402 - the bibtex inset has a second argument for bibtopic's
403 btPrint{Cited|NotCited|All} command:
405 \begin_inset LatexCommand \bibtex[<style>]{<database>}
407 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
408 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
409 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
410 \bibliographystyle{<style>}
411 \begin{btSect}{<database>}
416 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
418 * format incremented to 231.
420 * Support for sidewaysfigure/sidewaystable (rotating package).
421 insetfloat has now a param \sideways [true|false] (default is false).
422 The param should be erased on downwards conversion, if it was true,
423 the inset should be replaced by
424 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
426 \begin{sidewaystable} <content> \end{sidewaystable}
429 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
431 * format incremented to 230.
433 * Support for a second optional argument in insetcommand.
434 currently, citation uses this to support natbibs second
435 optional argument \cite[before][after]{key}.
436 I think there's nothing to convert upwards. Downwards, the
437 commands with 2 optional args need to be converted to ERT.
439 * Support for jurabib (param \use_jurabib [1|0], default is 0).
440 When converting downwards, \usepackage{jurabib} has to be added
441 to the preamble and, if babel is used, \usepackage{babel} before
442 (jurabib fails if babel is called afterwards). If the natbib commands
443 are used together with jurabib, they have to be converted to ERT too.
445 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
447 * format incremented to 229.
448 * Minipages cannot be read anymore. All minipage insets will
449 be converted to frameless box insets between 228->229.
451 2003-12-15 Angus Leeming <leeming@lyx.org>
453 * format incremented to 228.
454 * Change the output of all insets derived from InsetCollapsable
455 except for InsetERT (which has a similar output already), changing lines
456 "collapsed true" -> "status collapsed"
457 "collapsed false" -> "status open".
458 * Change the output of InsetERT, changing lines
459 "status Collapsed" -> "status collapsed"
460 "status Open" -> "status open".
461 "status Inlined" -> "status inlined".
463 2003-12-10 Angus Leeming <leeming@lyx.org>
465 * format NOT incremented.
466 * add a 'draft' option to InsetExternal.
468 2003-12-10 Angus Leeming <leeming@lyx.org>
470 * format incremented to 227.
471 * Change the output of InsetBox:
472 \begin_inset Boxed -> \begin_inset Box Boxed
473 \begin_inset Doublebox -> \begin_inset Box Doublebox
474 \begin_inset Frameless -> \begin_inset Box Frameless
475 \begin_inset ovalbox -> \begin_inset Box ovalbox
476 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
477 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
479 2003-12-10 Angus Leeming <leeming@lyx.org>
481 * format incremented to 226.
482 * Change the output of InsetNote:
483 \begin_inset Note -> \begin_inset Note Note
484 \begin_inset Comment -> \begin_inset Note Comment
485 \begin_inset Greyedout -> \begin_inset Note Greyedout
487 2003-11-28 André Pönitz
489 * Remove space_above/space_below from Paragraph.
490 This is now handled by InsetVSpace.
492 2003-10-07 Angus Leeming <leeming@lyx.org>
494 * Add transformations to InsetExternal
496 boundingBox 0 0 20 20 the dimensions of the B.B..
497 Output if the B.B. is not empty.
498 clip clip the image to the B.B.
500 extra LaTeX "draft" 'extra' data passed to the primary
501 command for this output format.
502 (Possible formats LaTeX, PDFLaTeX,
503 LinuxDoc, DocBook, Ascii.)
504 The string can contain spaces and so
506 rotateAngle 30 Rotation of the data.
507 Output for non-zero rotation only.
508 rotateOrigin bottomleft Rotation origin.
509 Output for non-zero rotation and
510 non-default origin (center) only.
512 width 2cm Output only if the image is resized.
516 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
518 * Added box inset. File format:
520 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
525 inner_pos "b" t/c/b/s
527 width "100col%" unit+width-string
528 special "none" none/height/depth
530 height "1in" unit+width-string
531 height_special "totalheight" none/height/depth
533 collapsed false true/false
535 \begin_layout Standard
542 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
543 the pre-existing Minipage inset. Parameters translate as follows:
544 position 0/1/2 -> t/c/b
545 inner_position 0/1/2/3 -> inner_pos c/t/b/s
550 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
552 * attribute valignment="center" is replaced by valignment="middle"
553 for tabular columns and cells
555 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
557 * Added branch inset. File format:
559 branch definition in the header:
565 \begin_inset Branch <branchname>
566 collapsed false true/false
568 \begin_layout Standard
575 2003-07-28 José Matos <jamatos@lyx.org>
577 * \the_end is replaced with \end_document
579 2003-07-28 José Matos <jamatos@lyx.org>
581 * \layout is replaced with \begin_layout
583 2003-07-28 José Matos <jamatos@fep.up.pt>
587 * All layouts finish now with \end_layout
589 2003-06-04 Angus Leeming <leeming@lyx.org>
593 * the storage of the external inset has been changed from
595 \begin_inset External XFig,"file.fig",""
601 \begin_inset External
604 display <display_type>
609 throwing away the final arg (here "", more generally "<string>") that holds
610 the parameters variable.
611 Variables are output if present (filename) or different from the default
612 values (display, lyxscale).
614 Moreover, the RasterImage template has been scrapped. All RasterImage
615 external insets are now converted to Graphics insets.
617 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
619 * Added new space insets:
620 \SpecialChar ~ is now \InsetSpace ~
621 ERT: "\ " could be converted to InsetSpace \<space>
622 ERT: "\," could be converted to InsetSpace \,
624 2003-04-24 André Pönitz <poenitz@gmx.net>
626 * Added eqref support:
627 \begin_inset LatexCommand \eqref{label}
629 2003-03-14 Dekel Tsur
631 * Format bumped to 223.
633 2003-03-12 John Levon <levon@movementarian.org>
635 * Added \\end_header to signify the end of the header in a
638 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
640 2003-02-10 John Levon <levon@movementarian.org>
644 Added \\tracking_changes 0|1 to the header.
646 Added \\author to the header. This can be present multiple
647 times, and is of the form :
649 \\author "Real Name" email@address.com
651 Added \\change_deleted, \\change_inserted. Each of these does not
652 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
655 \\change_inserted author time
657 where author is an integer ID reference into the author list in
658 the header, and time is time_t.
660 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
662 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
664 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
666 New graphics dialog. With the removal of buttons in the dialog, also
667 keywords in the graphics inset went. The following keywords do not
677 Only non-default values are saved to the lyx files. The defaults of the remaining
687 BoundingBox <from file>
690 rotateOrigin centerBaseline
692 subcaptionText <empty>
695 The remaining keywords have sufficient overlap with the old ones for a
696 smooth reading of the 1.2.x inset keywords in most common cases.
698 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
699 They don't exist anymore and we can't translate them into a scaling value, while
700 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
701 argument is ignored and lost.
703 Only few compatibility issues are left for lyx2lyx:
705 ------------------------------------------------------------------------------
706 old-token new-token remove
707 ------------------------------------------------------------------------------
708 size_kind original / size_type 0 scale 100 width <val>
712 size_kind width_height / size_type 1 - scale <val>
714 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
715 ------------------------------------------------------------------------------
716 [replace old-token by new-token, and remove any of subsequent tokens as listed]
718 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
719 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
721 replace "rotateAngle <val>" by "rotateAngle 0"
724 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
726 Added \lyxlock for locked math inset when written to .lyx file.
727 When "downgrading" .lyx files this should simple be deleted but it
728 does not hurt at all if it stays in. It does not have to be added
732 2002-08-02 Angus Leeming <leeming@lyx.org>
734 Added a boolean "preview" flag to InsetCommandParams.
735 Currently it is written only by InsetInclude, because only this
736 class can generate a preview of its contents.
738 The LyX file now contains:
740 \begin_inset Include \input{snapshot_t=40.tex}
745 Earlier versions of LyX just swallow this extra token silently.
747 2002-08-12 Angus Leeming <leeming@lyx.org>
749 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
750 renamed as "size_kind" and "lyxsize_kind" respectively.
752 \begin_inset Graphics FormatVersion 1
759 - lyxsize_kind original
760 + lyxsize_type original