1 LyX file-format changes
2 -----------------------
3 2007-06-13 Bo Peng <bpeng@lyx.org>
4 * format incremented to 272: convert listings to ERT because
5 earlier versions of lyx can not handle unrecognizable
8 2007-05-15 José Matos <jamatos@lyx.org>
9 * format incremented to 271: extended textclasses accept the
10 normal font sizes: 10, 11 and 12pt.
12 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
13 * format incremented to 270: support beamer \alert, \structure
15 2007-05-08 Bo Peng <ben.bob@gmail.com>
16 * format incremented to 269: add listings support
17 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
18 - add inset listings, with options lstparams and inline, e.g.
20 lstparams "xleftmargin=50pt,language=Python"
22 - add \lstinputlisting Include type. e.g.
23 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
25 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
27 * format incremented to 268: add support for the CJK encodings
28 - all encodings supported by CJK.sty are now in lib/encodings
29 - lib/encoding has got two new flags:
31 "inputenc" for those languages that use the inputenc-package and
32 "CJK" for the CJK encodings
33 - "fixed"/"variable" to divide between multi- or single-byte encoding
34 - lib/languages allows now to set an empty language for babel
35 in this case babel isn't called.
37 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
39 * format incremented to 267: add plain utf8 encoding (for XeTeX).
41 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
43 * format incremented to 266:
44 Support for the Armenian language
46 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
48 * format incremented to 265: fix LyX's table border line handling
49 With the fix (see bug 1746) LyX now takes care if the user has entered
50 a "|" character in the argument field of tables. Therefore the "|"
51 character has to be removed when also a table border is set.
53 2007-04-24 José Matos <jamatos@lyx.org>
55 * format incremented to 264:
56 textclass cv is renamed simplecv
58 2007-02-22 José Matos <jamatos@lyx.org>
60 * format incremented to 263: changes in the language names (overdue):
62 portuges -> portuguese
64 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
66 * format incremented to 262: Allow ascii \inputencoding
68 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
70 * format incremented to 261: \output_changes is now considered
71 even if \tracking_changes is false. This allows to output existing
72 changes even if future changes are not tracked anymore.
75 \tracking_changes false
78 is therefore converted to
80 \tracking_changes false
83 on upgrade. Nothing is done on downgrade since the new behaviour is
84 not supported in older formats.
86 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
88 * format incremented to 260: Allow utf8x \inputencoding
90 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
92 * format incremented to 259:
93 Old: Spaces at start or end of font changes were output outside of
94 the font change, i.e. not 'xx\textbf{ yy }zz', but
96 New: Spaces are always output with the font set by the user.
98 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
100 * format incremented to 258: new \lyxline definition
102 \\newcommand{\\lyxline}[1]{
103 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
106 \\newcommand{\\lyxline}[1][1pt]{%
108 \\rule[.5ex]{\\linewidth}{#1}\\par}
109 The new definition is more robust, see bug 1988 and now really takes care about
110 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
112 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
114 * format incremented to 257: Caption styles have been replaced by
115 InsetCaption. This is at the same time also a layout file format
116 change to format 3. layout2layout removes caption layouts from old
118 Note that InsetCaption did exist before this format, but was never
119 used. Old files containing do nevertheless still work.
120 Of course users can still define a Caption style in layout files,
121 but the special treatment in LyX is gone (apart from the sensitive
124 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
126 * format incremented to 256: allow some new inputenc settings.
127 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
129 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
131 * format incremented to 255: new insets for \clearpage and
132 \cleardoublepage. They are written inline to the file, exactly like
135 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
137 * format incremented to 254: new header parameter \use_esint.
138 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
141 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
143 * format incremented to 253: new nomenclature and printnomenclature
144 insets. These are standard InsetCommand with the following parameters:
145 \nomenclature[prefix]{symbol}{description}
146 \printnomenclature[labelwidth]
148 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
150 * format incremented to 252: changed command inset syntax
154 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
165 \begin_inset LatexCommand cmdname
172 The order of the parameters and for each parameter the name and
173 optional/required bit is now stored in InsetCommandParams.
175 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
177 * format incremented to 251: save show_label param for charstyles.
179 On revert, the show_label param is just removed. Nothing to convert.
181 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
183 * Format incremented to 250: allow optional arg to environments
185 No material format change. Now optargs for environments are allowed
186 to be specified in layout files and will be handled properly. When
187 converted back to older formats, they will be ignored in LaTeX
190 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
192 * format incremented to 249: Unicode
194 LyX documents are now always encoded in utf8. The value of
195 \inputencoding does now only determine the encoding of the created
197 Up to format 248 the value of \inputencoding did also determine the
198 encoding of the LyX file:
200 \inputencoding LyX file encoding
201 auto as determined by the document and character
204 everything else as determined by \inputencoding
206 The difference between auto and default is only the LaTeX output:
207 auto causes loading of the inputenc package, default does not.
209 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
211 * format incremented to 248: Basic booktabs support
213 The <features> tag has a new switch: booktabs="true|false".
214 An absent switch is equivalent to booktabs="false".
215 Horizontal lines are set with the booktabs package if this switch
218 The <row> tag of tabulars has the following new attributes:
219 topspace, bottomspace and interlinespace. All take a LyXLength
220 as value, or the special keyword "default".
222 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
224 * format incremented to 247. The Grand Font Interface Rewrite.
225 (1) Split font selection to rm, sf, tt:
226 \fontscheme -> \font_roman, \font_sans, \font_typewriter
228 \fontscheme \font_roman \font_sans \font_typewriter
229 default default default default
230 ae ae default default
231 times times default default
232 palatino palatino default default
233 helvet default helvet default
234 avant default avant default
235 newcent newcent default default
236 bookman bookman default default
237 pslatex times (or \usepackage{pslatex})
239 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
240 lmodern, charter, utopia, ccfonts, chancery, beraserif
241 (-> \usepackage{<name>})
242 \font_sans: cmss, lmss, cmbr
243 (-> \renewcommand{\sfdefault}{<name>})
244 berasans (-> \usepackage{<name>})
245 \font_typewriter: cmtt, lmtt, cmtl,
246 (-> \renewcommand{\sfdefault}{<name>})
247 courier, luximono, beramono
248 (-> \usepackage{<name>})
249 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
250 (3) New param \font_sc (true, false).
251 (4) New param \font_osf (true, false).
252 (5) New param \font_sf_scale (float)
253 (6) New param \font_tt_scale (float)
254 Support for the following fonts has been added:
255 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
256 courier, lmodern, luximono, utopia.
257 Support for the following font has been removed:
258 pslatex (it's superseded by mathptmx (times)).
260 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
262 * format incremented to 246. The framed.sty package is
263 now supported with note types framed and shaded.
265 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
267 * format incremented to 245. The \quotes_times parameter
270 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
272 * format incremented to 244. Rename '\InsetSpace \,'
273 to '\InsetSpace \thinspace{}', because the comma was
274 not parsed by lyxlex, and '\InsetSpace \space' to
275 '\InsetSpace \space{}' in favour of consistency.
277 2005-07-18 José Matos <jamatos@lyx.org>
279 * format incremented to 243.
281 * this change only affects the preamble, the paperpackage
282 option was removed and papersize is changed to default.
284 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
286 * format incremented to 242. There is no file format per
287 se, but the "frenchb" language has been removed from lib/language
288 and has to be translated to "french" by lyx2lyx.
290 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
292 * format incremented to 241.
294 All following changes apply only to text in ERT insets. The
295 rationale is that text in ERT is simply ASCII text, and nothing more.
297 * paragraph breaks are now a single newline in latex and not a
298 paragraph break anymore (bug 698).
299 * \newline is not allowed anymore, because it is redundant (see above)
300 * layouts other than Standard, paragraph parameters and font changes
301 are not allowed anymore. They never made sense and were ignored for
302 latex output, but now they can't be read or set anymore (bug 922).
305 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
307 * format incremented to 240.
309 \output_changes {true|false}
310 (should the change tracking marks be visible in the output or not?)
311 * lyx2lyx should just delete the param in 239.
313 2005-01-06 José Matos <jamatos@lyx.org>
315 * format incremented to 239.
316 * the paragraph parameters are displayed in their own line. This
317 change is consistent with the insets behaviour, and corresponds
318 to a more uniform treatment of the paragraphs since some of them
319 had already their own line.
321 An example of a single paragraph follows:
323 \begin_layout Standard
324 \paragraph_spacing single
330 2004-12-03 José Matos <jamatos@lyx.org>
332 * format incremented to 238.
333 * The compatibility code to read old latex accents from 0.12.x in
334 InsetLatexAccent::checkContents has been removed.
335 The following translations are done:
337 "\i \xy" -> "\i \x{y}"
338 "\i \x y" -> "\i \x{y}"
339 "\i \x\i" -> "\i \x{\i}"
340 "\i \x\j" -> "\i \x{\j}"
341 x is a latex accent command, y the base character. \, i and j are
343 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
344 so formats 215 - 237 can have both versions.
347 2004-10-10 José Matos <jamatos@lyx.org>
349 * format incremented to 237.
350 * In the header, the following statments use now booleans values,
356 2004-08-15 José Matos <jamatos@lyx.org>
358 * format incremented to 236.
365 * The options for \papersize are changed:
368 * All whitespaces are removed at the end of lines, when
369 not necessary. As an example we have all the lines in the header that
370 do not belong to the preamble.
372 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
374 * format incremented to 235.
375 * \paperpackage had an off-by-one error. Translation table:
377 234: a4 a4wide widemarginsa4
378 235: none a4 a4wide widemarginsa4
380 The "widemarginsa4" setting of 235 has no equivalent in 234.
382 2004-05-12 Angus Leeming <leeming@lyx.org>
384 * format incremented to 234.
385 * the citation engine is specified explicitly rather than being
386 deduced from 3 bools.
389 \use_numerical_citations 0 -> \cite_engine <style>
392 where <style> is one of "basic", "natbib_authoryear",
393 "natbib_numerical" or "jurabib".
395 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
397 * format incremented to 233.
398 * insetgraphics does not allow filenames without extension anymore.
399 The complete filename has to be given.
401 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
403 * format incremented to 232.
405 * Support for bibtopic (sectioned bibliographies).
406 - bufferparam \use_bibtopic [1|0]
407 - the bibtex inset has a second argument for bibtopic's
408 btPrint{Cited|NotCited|All} command:
410 \begin_inset LatexCommand \bibtex[<style>]{<database>}
412 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
413 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
414 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
415 \bibliographystyle{<style>}
416 \begin{btSect}{<database>}
421 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
423 * format incremented to 231.
425 * Support for sidewaysfigure/sidewaystable (rotating package).
426 insetfloat has now a param \sideways [true|false] (default is false).
427 The param should be erased on downwards conversion, if it was true,
428 the inset should be replaced by
429 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
431 \begin{sidewaystable} <content> \end{sidewaystable}
434 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
436 * format incremented to 230.
438 * Support for a second optional argument in insetcommand.
439 currently, citation uses this to support natbibs second
440 optional argument \cite[before][after]{key}.
441 I think there's nothing to convert upwards. Downwards, the
442 commands with 2 optional args need to be converted to ERT.
444 * Support for jurabib (param \use_jurabib [1|0], default is 0).
445 When converting downwards, \usepackage{jurabib} has to be added
446 to the preamble and, if babel is used, \usepackage{babel} before
447 (jurabib fails if babel is called afterwards). If the natbib commands
448 are used together with jurabib, they have to be converted to ERT too.
450 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
452 * format incremented to 229.
453 * Minipages cannot be read anymore. All minipage insets will
454 be converted to frameless box insets between 228->229.
456 2003-12-15 Angus Leeming <leeming@lyx.org>
458 * format incremented to 228.
459 * Change the output of all insets derived from InsetCollapsable
460 except for InsetERT (which has a similar output already), changing lines
461 "collapsed true" -> "status collapsed"
462 "collapsed false" -> "status open".
463 * Change the output of InsetERT, changing lines
464 "status Collapsed" -> "status collapsed"
465 "status Open" -> "status open".
466 "status Inlined" -> "status inlined".
468 2003-12-10 Angus Leeming <leeming@lyx.org>
470 * format NOT incremented.
471 * add a 'draft' option to InsetExternal.
473 2003-12-10 Angus Leeming <leeming@lyx.org>
475 * format incremented to 227.
476 * Change the output of InsetBox:
477 \begin_inset Boxed -> \begin_inset Box Boxed
478 \begin_inset Doublebox -> \begin_inset Box Doublebox
479 \begin_inset Frameless -> \begin_inset Box Frameless
480 \begin_inset ovalbox -> \begin_inset Box ovalbox
481 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
482 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
484 2003-12-10 Angus Leeming <leeming@lyx.org>
486 * format incremented to 226.
487 * Change the output of InsetNote:
488 \begin_inset Note -> \begin_inset Note Note
489 \begin_inset Comment -> \begin_inset Note Comment
490 \begin_inset Greyedout -> \begin_inset Note Greyedout
492 2003-11-28 André Pönitz
494 * Remove space_above/space_below from Paragraph.
495 This is now handled by InsetVSpace.
497 2003-10-07 Angus Leeming <leeming@lyx.org>
499 * Add transformations to InsetExternal
501 boundingBox 0 0 20 20 the dimensions of the B.B..
502 Output if the B.B. is not empty.
503 clip clip the image to the B.B.
505 extra LaTeX "draft" 'extra' data passed to the primary
506 command for this output format.
507 (Possible formats LaTeX, PDFLaTeX,
508 LinuxDoc, DocBook, Ascii.)
509 The string can contain spaces and so
511 rotateAngle 30 Rotation of the data.
512 Output for non-zero rotation only.
513 rotateOrigin bottomleft Rotation origin.
514 Output for non-zero rotation and
515 non-default origin (center) only.
517 width 2cm Output only if the image is resized.
521 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
523 * Added box inset. File format:
525 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
530 inner_pos "b" t/c/b/s
532 width "100col%" unit+width-string
533 special "none" none/height/depth
535 height "1in" unit+width-string
536 height_special "totalheight" none/height/depth
538 collapsed false true/false
540 \begin_layout Standard
547 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
548 the pre-existing Minipage inset. Parameters translate as follows:
549 position 0/1/2 -> t/c/b
550 inner_position 0/1/2/3 -> inner_pos c/t/b/s
555 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
557 * attribute valignment="center" is replaced by valignment="middle"
558 for tabular columns and cells
560 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
562 * Added branch inset. File format:
564 branch definition in the header:
570 \begin_inset Branch <branchname>
571 collapsed false true/false
573 \begin_layout Standard
580 2003-07-28 José Matos <jamatos@lyx.org>
582 * \the_end is replaced with \end_document
584 2003-07-28 José Matos <jamatos@lyx.org>
586 * \layout is replaced with \begin_layout
588 2003-07-28 José Matos <jamatos@fep.up.pt>
592 * All layouts finish now with \end_layout
594 2003-06-04 Angus Leeming <leeming@lyx.org>
598 * the storage of the external inset has been changed from
600 \begin_inset External XFig,"file.fig",""
606 \begin_inset External
609 display <display_type>
614 throwing away the final arg (here "", more generally "<string>") that holds
615 the parameters variable.
616 Variables are output if present (filename) or different from the default
617 values (display, lyxscale).
619 Moreover, the RasterImage template has been scrapped. All RasterImage
620 external insets are now converted to Graphics insets.
622 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
624 * Added new space insets:
625 \SpecialChar ~ is now \InsetSpace ~
626 ERT: "\ " could be converted to InsetSpace \<space>
627 ERT: "\," could be converted to InsetSpace \,
629 2003-04-24 André Pönitz <poenitz@gmx.net>
631 * Added eqref support:
632 \begin_inset LatexCommand \eqref{label}
634 2003-03-14 Dekel Tsur
636 * Format bumped to 223.
638 2003-03-12 John Levon <levon@movementarian.org>
640 * Added \\end_header to signify the end of the header in a
643 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
645 2003-02-10 John Levon <levon@movementarian.org>
649 Added \\tracking_changes 0|1 to the header.
651 Added \\author to the header. This can be present multiple
652 times, and is of the form :
654 \\author "Real Name" email@address.com
656 Added \\change_deleted, \\change_inserted. Each of these does not
657 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
660 \\change_inserted author time
662 where author is an integer ID reference into the author list in
663 the header, and time is time_t.
665 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
667 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
669 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
671 New graphics dialog. With the removal of buttons in the dialog, also
672 keywords in the graphics inset went. The following keywords do not
682 Only non-default values are saved to the lyx files. The defaults of the remaining
692 BoundingBox <from file>
695 rotateOrigin centerBaseline
697 subcaptionText <empty>
700 The remaining keywords have sufficient overlap with the old ones for a
701 smooth reading of the 1.2.x inset keywords in most common cases.
703 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
704 They don't exist anymore and we can't translate them into a scaling value, while
705 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
706 argument is ignored and lost.
708 Only few compatibility issues are left for lyx2lyx:
710 ------------------------------------------------------------------------------
711 old-token new-token remove
712 ------------------------------------------------------------------------------
713 size_kind original / size_type 0 scale 100 width <val>
717 size_kind width_height / size_type 1 - scale <val>
719 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
720 ------------------------------------------------------------------------------
721 [replace old-token by new-token, and remove any of subsequent tokens as listed]
723 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
724 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
726 replace "rotateAngle <val>" by "rotateAngle 0"
729 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
731 Added \lyxlock for locked math inset when written to .lyx file.
732 When "downgrading" .lyx files this should simple be deleted but it
733 does not hurt at all if it stays in. It does not have to be added
737 2002-08-02 Angus Leeming <leeming@lyx.org>
739 Added a boolean "preview" flag to InsetCommandParams.
740 Currently it is written only by InsetInclude, because only this
741 class can generate a preview of its contents.
743 The LyX file now contains:
745 \begin_inset Include \input{snapshot_t=40.tex}
750 Earlier versions of LyX just swallow this extra token silently.
752 2002-08-12 Angus Leeming <leeming@lyx.org>
754 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
755 renamed as "size_kind" and "lyxsize_kind" respectively.
757 \begin_inset Graphics FormatVersion 1
764 - lyxsize_kind original
765 + lyxsize_type original