1 LyX file-format changes
2 -----------------------
6 * format incremented to 278: Close begin_deeper with a
7 corresponding end_deeper (the only case where it matters is
8 at the end of the body).
12 * format incremented to 277: lyx is able to create invalid
13 table where a multicolumn does not have a first cell
14 (required by the table file format)
16 2007-07-20 Dov Feldstern <dov@lyx.org>
18 * format *not* incremented; fixed format 249 conversion, so that it now
19 correctly deals with encodings in footnotes (part of bug 3613)
21 2007-06-26 Uwe Stöhr <uwestoehr@web.de> and Dov Feldstern <dov@lyx.org>
23 * format incremented to 276: switching exsting language 'arabic' to
24 'arabic_arabtex'; this is to differentiate from the new arabic support
25 using the arabi package.
27 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
29 * format incremented to 275: add graphics params scaleBeforeRotation
32 2007-06-13 Dov Feldstern <dov@lyx.org>
33 * format incremented to 274: applying the conversion done in format 259
34 to the \lang property, which was forgotten back then... This is
35 slightly more complicated, because the default language has to be
36 determined on a per-paragraph basis.
38 2007-06-13 Bo Peng <ben.bob@gmail.com>
39 * format incremented to 273: add --Separator-- environment to
40 separate consecutive environments
42 2007-06-13 Bo Peng <bpeng@lyx.org>
43 * format incremented to 272: convert listings to ERT because
44 earlier versions of lyx can not handle unrecognizable
47 2007-05-15 José Matos <jamatos@lyx.org>
48 * format incremented to 271: extended textclasses accept the
49 normal font sizes: 10, 11 and 12pt.
51 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
52 * format incremented to 270: support beamer \alert, \structure
54 2007-05-08 Bo Peng <ben.bob@gmail.com>
55 * format incremented to 269: add listings support
56 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
57 - add inset listings, with options lstparams and inline, e.g.
59 lstparams "xleftmargin=50pt,language=Python"
61 - add \lstinputlisting Include type. e.g.
62 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
64 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
66 * format incremented to 268: add support for the CJK encodings
67 - all encodings supported by CJK.sty are now in lib/encodings
68 - lib/encoding has got two new flags:
70 "inputenc" for those languages that use the inputenc-package and
71 "CJK" for the CJK encodings
72 - "fixed"/"variable" to divide between multi- or single-byte encoding
73 - lib/languages allows now to set an empty language for babel
74 in this case babel isn't called.
76 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
78 * format incremented to 267: add plain utf8 encoding (for XeTeX).
80 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
82 * format incremented to 266:
83 Support for the Armenian language
85 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
87 * format incremented to 265: fix LyX's table border line handling
88 With the fix (see bug 1746) LyX now takes care if the user has entered
89 a "|" character in the argument field of tables. Therefore the "|"
90 character has to be removed when also a table border is set.
92 2007-04-24 José Matos <jamatos@lyx.org>
94 * format incremented to 264:
95 textclass cv is renamed simplecv
97 2007-02-22 José Matos <jamatos@lyx.org>
99 * format incremented to 263: changes in the language names (overdue):
101 portuges -> portuguese
103 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
105 * format incremented to 262: Allow ascii \inputencoding
107 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
109 * format incremented to 261: \output_changes is now considered
110 even if \tracking_changes is false. This allows to output existing
111 changes even if future changes are not tracked anymore.
114 \tracking_changes false
117 is therefore converted to
119 \tracking_changes false
120 \output_changes false
122 on upgrade. Nothing is done on downgrade since the new behaviour is
123 not supported in older formats.
125 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
127 * format incremented to 260: Allow utf8x \inputencoding
129 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
131 * format incremented to 259:
132 Old: Spaces at start or end of font changes were output outside of
133 the font change, i.e. not 'xx\textbf{ yy }zz', but
135 New: Spaces are always output with the font set by the user.
137 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
139 * format incremented to 258: new \lyxline definition
141 \\newcommand{\\lyxline}[1]{
142 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
145 \\newcommand{\\lyxline}[1][1pt]{%
147 \\rule[.5ex]{\\linewidth}{#1}\\par}
148 The new definition is more robust, see bug 1988 and now really takes care about
149 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
151 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
153 * format incremented to 257: Caption styles have been replaced by
154 InsetCaption. This is at the same time also a layout file format
155 change to format 3. layout2layout removes caption layouts from old
157 Note that InsetCaption did exist before this format, but was never
158 used. Old files containing do nevertheless still work.
159 Of course users can still define a Caption style in layout files,
160 but the special treatment in LyX is gone (apart from the sensitive
163 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
165 * format incremented to 256: allow some new inputenc settings.
166 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
168 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
170 * format incremented to 255: new insets for \clearpage and
171 \cleardoublepage. They are written inline to the file, exactly like
174 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
176 * format incremented to 254: new header parameter \use_esint.
177 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
180 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
182 * format incremented to 253: new nomenclature and printnomenclature
183 insets. These are standard InsetCommand with the following parameters:
184 \nomenclature[prefix]{symbol}{description}
185 \printnomenclature[labelwidth]
187 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
189 * format incremented to 252: changed command inset syntax
193 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
204 \begin_inset LatexCommand cmdname
211 The order of the parameters and for each parameter the name and
212 optional/required bit is now stored in InsetCommandParams.
214 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
216 * format incremented to 251: save show_label param for charstyles.
218 On revert, the show_label param is just removed. Nothing to convert.
220 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
222 * Format incremented to 250: allow optional arg to environments
224 No material format change. Now optargs for environments are allowed
225 to be specified in layout files and will be handled properly. When
226 converted back to older formats, they will be ignored in LaTeX
229 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
231 * format incremented to 249: Unicode
233 LyX documents are now always encoded in utf8. The value of
234 \inputencoding does now only determine the encoding of the created
236 Up to format 248 the value of \inputencoding did also determine the
237 encoding of the LyX file:
239 \inputencoding LyX file encoding
240 auto as determined by the document and character
243 everything else as determined by \inputencoding
245 The difference between auto and default is only the LaTeX output:
246 auto causes loading of the inputenc package, default does not.
248 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
250 * format incremented to 248: Basic booktabs support
252 The <features> tag has a new switch: booktabs="true|false".
253 An absent switch is equivalent to booktabs="false".
254 Horizontal lines are set with the booktabs package if this switch
257 The <row> tag of tabulars has the following new attributes:
258 topspace, bottomspace and interlinespace. All take a LyXLength
259 as value, or the special keyword "default".
261 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
263 * format incremented to 247. The Grand Font Interface Rewrite.
264 (1) Split font selection to rm, sf, tt:
265 \fontscheme -> \font_roman, \font_sans, \font_typewriter
267 \fontscheme \font_roman \font_sans \font_typewriter
268 default default default default
269 ae ae default default
270 times times default default
271 palatino palatino default default
272 helvet default helvet default
273 avant default avant default
274 newcent newcent default default
275 bookman bookman default default
276 pslatex times (or \usepackage{pslatex})
278 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
279 lmodern, charter, utopia, ccfonts, chancery, beraserif
280 (-> \usepackage{<name>})
281 \font_sans: cmss, lmss, cmbr
282 (-> \renewcommand{\sfdefault}{<name>})
283 berasans (-> \usepackage{<name>})
284 \font_typewriter: cmtt, lmtt, cmtl,
285 (-> \renewcommand{\sfdefault}{<name>})
286 courier, luximono, beramono
287 (-> \usepackage{<name>})
288 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
289 (3) New param \font_sc (true, false).
290 (4) New param \font_osf (true, false).
291 (5) New param \font_sf_scale (float)
292 (6) New param \font_tt_scale (float)
293 Support for the following fonts has been added:
294 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
295 courier, lmodern, luximono, utopia.
296 Support for the following font has been removed:
297 pslatex (it's superseded by mathptmx (times)).
299 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
301 * format incremented to 246. The framed.sty package is
302 now supported with note types framed and shaded.
304 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
306 * format incremented to 245. The \quotes_times parameter
309 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
311 * format incremented to 244. Rename '\InsetSpace \,'
312 to '\InsetSpace \thinspace{}', because the comma was
313 not parsed by lyxlex, and '\InsetSpace \space' to
314 '\InsetSpace \space{}' in favour of consistency.
316 2005-07-18 José Matos <jamatos@lyx.org>
318 * format incremented to 243.
320 * this change only affects the preamble, the paperpackage
321 option was removed and papersize is changed to default.
323 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
325 * format incremented to 242. There is no file format per
326 se, but the "frenchb" language has been removed from lib/language
327 and has to be translated to "french" by lyx2lyx.
329 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
331 * format incremented to 241.
333 All following changes apply only to text in ERT insets. The
334 rationale is that text in ERT is simply ASCII text, and nothing more.
336 * paragraph breaks are now a single newline in latex and not a
337 paragraph break anymore (bug 698).
338 * \newline is not allowed anymore, because it is redundant (see above)
339 * layouts other than Standard, paragraph parameters and font changes
340 are not allowed anymore. They never made sense and were ignored for
341 latex output, but now they can't be read or set anymore (bug 922).
344 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
346 * format incremented to 240.
348 \output_changes {true|false}
349 (should the change tracking marks be visible in the output or not?)
350 * lyx2lyx should just delete the param in 239.
352 2005-01-06 José Matos <jamatos@lyx.org>
354 * format incremented to 239.
355 * the paragraph parameters are displayed in their own line. This
356 change is consistent with the insets behaviour, and corresponds
357 to a more uniform treatment of the paragraphs since some of them
358 had already their own line.
360 An example of a single paragraph follows:
362 \begin_layout Standard
363 \paragraph_spacing single
369 2004-12-03 José Matos <jamatos@lyx.org>
371 * format incremented to 238.
372 * The compatibility code to read old latex accents from 0.12.x in
373 InsetLatexAccent::checkContents has been removed.
374 The following translations are done:
376 "\i \xy" -> "\i \x{y}"
377 "\i \x y" -> "\i \x{y}"
378 "\i \x\i" -> "\i \x{\i}"
379 "\i \x\j" -> "\i \x{\j}"
380 x is a latex accent command, y the base character. \, i and j are
382 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
383 so formats 215 - 237 can have both versions.
386 2004-10-10 José Matos <jamatos@lyx.org>
388 * format incremented to 237.
389 * In the header, the following statments use now booleans values,
395 2004-08-15 José Matos <jamatos@lyx.org>
397 * format incremented to 236.
404 * The options for \papersize are changed:
407 * All whitespaces are removed at the end of lines, when
408 not necessary. As an example we have all the lines in the header that
409 do not belong to the preamble.
411 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
413 * format incremented to 235.
414 * \paperpackage had an off-by-one error. Translation table:
416 234: a4 a4wide widemarginsa4
417 235: none a4 a4wide widemarginsa4
419 The "widemarginsa4" setting of 235 has no equivalent in 234.
421 2004-05-12 Angus Leeming <leeming@lyx.org>
423 * format incremented to 234.
424 * the citation engine is specified explicitly rather than being
425 deduced from 3 bools.
428 \use_numerical_citations 0 -> \cite_engine <style>
431 where <style> is one of "basic", "natbib_authoryear",
432 "natbib_numerical" or "jurabib".
434 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
436 * format incremented to 233.
437 * insetgraphics does not allow filenames without extension anymore.
438 The complete filename has to be given.
440 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
442 * format incremented to 232.
444 * Support for bibtopic (sectioned bibliographies).
445 - bufferparam \use_bibtopic [1|0]
446 - the bibtex inset has a second argument for bibtopic's
447 btPrint{Cited|NotCited|All} command:
449 \begin_inset LatexCommand \bibtex[<style>]{<database>}
451 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
452 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
453 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
454 \bibliographystyle{<style>}
455 \begin{btSect}{<database>}
460 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
462 * format incremented to 231.
464 * Support for sidewaysfigure/sidewaystable (rotating package).
465 insetfloat has now a param \sideways [true|false] (default is false).
466 The param should be erased on downwards conversion, if it was true,
467 the inset should be replaced by
468 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
470 \begin{sidewaystable} <content> \end{sidewaystable}
473 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
475 * format incremented to 230.
477 * Support for a second optional argument in insetcommand.
478 currently, citation uses this to support natbibs second
479 optional argument \cite[before][after]{key}.
480 I think there's nothing to convert upwards. Downwards, the
481 commands with 2 optional args need to be converted to ERT.
483 * Support for jurabib (param \use_jurabib [1|0], default is 0).
484 When converting downwards, \usepackage{jurabib} has to be added
485 to the preamble and, if babel is used, \usepackage{babel} before
486 (jurabib fails if babel is called afterwards). If the natbib commands
487 are used together with jurabib, they have to be converted to ERT too.
489 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
491 * format incremented to 229.
492 * Minipages cannot be read anymore. All minipage insets will
493 be converted to frameless box insets between 228->229.
495 2003-12-15 Angus Leeming <leeming@lyx.org>
497 * format incremented to 228.
498 * Change the output of all insets derived from InsetCollapsable
499 except for InsetERT (which has a similar output already), changing lines
500 "collapsed true" -> "status collapsed"
501 "collapsed false" -> "status open".
502 * Change the output of InsetERT, changing lines
503 "status Collapsed" -> "status collapsed"
504 "status Open" -> "status open".
505 "status Inlined" -> "status inlined".
507 2003-12-10 Angus Leeming <leeming@lyx.org>
509 * format NOT incremented.
510 * add a 'draft' option to InsetExternal.
512 2003-12-10 Angus Leeming <leeming@lyx.org>
514 * format incremented to 227.
515 * Change the output of InsetBox:
516 \begin_inset Boxed -> \begin_inset Box Boxed
517 \begin_inset Doublebox -> \begin_inset Box Doublebox
518 \begin_inset Frameless -> \begin_inset Box Frameless
519 \begin_inset ovalbox -> \begin_inset Box ovalbox
520 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
521 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
523 2003-12-10 Angus Leeming <leeming@lyx.org>
525 * format incremented to 226.
526 * Change the output of InsetNote:
527 \begin_inset Note -> \begin_inset Note Note
528 \begin_inset Comment -> \begin_inset Note Comment
529 \begin_inset Greyedout -> \begin_inset Note Greyedout
531 2003-11-28 André Pönitz
533 * Remove space_above/space_below from Paragraph.
534 This is now handled by InsetVSpace.
536 2003-10-07 Angus Leeming <leeming@lyx.org>
538 * Add transformations to InsetExternal
540 boundingBox 0 0 20 20 the dimensions of the B.B..
541 Output if the B.B. is not empty.
542 clip clip the image to the B.B.
544 extra LaTeX "draft" 'extra' data passed to the primary
545 command for this output format.
546 (Possible formats LaTeX, PDFLaTeX,
547 LinuxDoc, DocBook, Ascii.)
548 The string can contain spaces and so
550 rotateAngle 30 Rotation of the data.
551 Output for non-zero rotation only.
552 rotateOrigin bottomleft Rotation origin.
553 Output for non-zero rotation and
554 non-default origin (center) only.
556 width 2cm Output only if the image is resized.
560 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
562 * Added box inset. File format:
564 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
569 inner_pos "b" t/c/b/s
571 width "100col%" unit+width-string
572 special "none" none/height/depth
574 height "1in" unit+width-string
575 height_special "totalheight" none/height/depth
577 collapsed false true/false
579 \begin_layout Standard
586 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
587 the pre-existing Minipage inset. Parameters translate as follows:
588 position 0/1/2 -> t/c/b
589 inner_position 0/1/2/3 -> inner_pos c/t/b/s
594 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
596 * attribute valignment="center" is replaced by valignment="middle"
597 for tabular columns and cells
599 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
601 * Added branch inset. File format:
603 branch definition in the header:
609 \begin_inset Branch <branchname>
610 collapsed false true/false
612 \begin_layout Standard
619 2003-07-28 José Matos <jamatos@lyx.org>
621 * \the_end is replaced with \end_document
623 2003-07-28 José Matos <jamatos@lyx.org>
625 * \layout is replaced with \begin_layout
627 2003-07-28 José Matos <jamatos@fep.up.pt>
631 * All layouts finish now with \end_layout
633 2003-06-04 Angus Leeming <leeming@lyx.org>
637 * the storage of the external inset has been changed from
639 \begin_inset External XFig,"file.fig",""
645 \begin_inset External
648 display <display_type>
653 throwing away the final arg (here "", more generally "<string>") that holds
654 the parameters variable.
655 Variables are output if present (filename) or different from the default
656 values (display, lyxscale).
658 Moreover, the RasterImage template has been scrapped. All RasterImage
659 external insets are now converted to Graphics insets.
661 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
663 * Added new space insets:
664 \SpecialChar ~ is now \InsetSpace ~
665 ERT: "\ " could be converted to InsetSpace \<space>
666 ERT: "\," could be converted to InsetSpace \,
668 2003-04-24 André Pönitz <poenitz@gmx.net>
670 * Added eqref support:
671 \begin_inset LatexCommand \eqref{label}
673 2003-03-14 Dekel Tsur
675 * Format bumped to 223.
677 2003-03-12 John Levon <levon@movementarian.org>
679 * Added \\end_header to signify the end of the header in a
682 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
684 2003-02-10 John Levon <levon@movementarian.org>
688 Added \\tracking_changes 0|1 to the header.
690 Added \\author to the header. This can be present multiple
691 times, and is of the form :
693 \\author "Real Name" email@address.com
695 Added \\change_deleted, \\change_inserted. Each of these does not
696 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
699 \\change_inserted author time
701 where author is an integer ID reference into the author list in
702 the header, and time is time_t.
704 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
706 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
708 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
710 New graphics dialog. With the removal of buttons in the dialog, also
711 keywords in the graphics inset went. The following keywords do not
721 Only non-default values are saved to the lyx files. The defaults of the remaining
731 BoundingBox <from file>
734 rotateOrigin centerBaseline
736 subcaptionText <empty>
739 The remaining keywords have sufficient overlap with the old ones for a
740 smooth reading of the 1.2.x inset keywords in most common cases.
742 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
743 They don't exist anymore and we can't translate them into a scaling value, while
744 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
745 argument is ignored and lost.
747 Only few compatibility issues are left for lyx2lyx:
749 ------------------------------------------------------------------------------
750 old-token new-token remove
751 ------------------------------------------------------------------------------
752 size_kind original / size_type 0 scale 100 width <val>
756 size_kind width_height / size_type 1 - scale <val>
758 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
759 ------------------------------------------------------------------------------
760 [replace old-token by new-token, and remove any of subsequent tokens as listed]
762 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
763 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
765 replace "rotateAngle <val>" by "rotateAngle 0"
768 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
770 Added \lyxlock for locked math inset when written to .lyx file.
771 When "downgrading" .lyx files this should simple be deleted but it
772 does not hurt at all if it stays in. It does not have to be added
776 2002-08-02 Angus Leeming <leeming@lyx.org>
778 Added a boolean "preview" flag to InsetCommandParams.
779 Currently it is written only by InsetInclude, because only this
780 class can generate a preview of its contents.
782 The LyX file now contains:
784 \begin_inset Include \input{snapshot_t=40.tex}
789 Earlier versions of LyX just swallow this extra token silently.
791 2002-08-12 Angus Leeming <leeming@lyx.org>
793 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
794 renamed as "size_kind" and "lyxsize_kind" respectively.
796 \begin_inset Graphics FormatVersion 1
803 - lyxsize_kind original
804 + lyxsize_type original