1 LyX file-format changes
2 -----------------------
4 2007-06-26 Uwe Stöhr <uwestoehr@web.de> and Dov Feldstern <dov@lyx.org>
6 * format incremented to 276: switching exsting language 'arabic' to
7 'arabic_arabtex'; this is to differentiate from the new arabic support
8 using the arabi package.
10 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
12 * format incremented to 275: add graphics params scaleBeforeRotation
15 2007-06-13 Dov Feldstern <dov@lyx.org>
16 * format incremented to 274: applying the conversion done in format 259
17 to the \lang property, which was forgotten back then... This is
18 slightly more complicated, because the default language has to be
19 determined on a per-paragraph basis.
21 2007-06-13 Bo Peng <ben.bob@gmail.com>
22 * format incremented to 273: add --Separator-- environment to
23 separate consecutive environments
25 2007-06-13 Bo Peng <bpeng@lyx.org>
26 * format incremented to 272: convert listings to ERT because
27 earlier versions of lyx can not handle unrecognizable
30 2007-05-15 José Matos <jamatos@lyx.org>
31 * format incremented to 271: extended textclasses accept the
32 normal font sizes: 10, 11 and 12pt.
34 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
35 * format incremented to 270: support beamer \alert, \structure
37 2007-05-08 Bo Peng <ben.bob@gmail.com>
38 * format incremented to 269: add listings support
39 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
40 - add inset listings, with options lstparams and inline, e.g.
42 lstparams "xleftmargin=50pt,language=Python"
44 - add \lstinputlisting Include type. e.g.
45 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
47 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
49 * format incremented to 268: add support for the CJK encodings
50 - all encodings supported by CJK.sty are now in lib/encodings
51 - lib/encoding has got two new flags:
53 "inputenc" for those languages that use the inputenc-package and
54 "CJK" for the CJK encodings
55 - "fixed"/"variable" to divide between multi- or single-byte encoding
56 - lib/languages allows now to set an empty language for babel
57 in this case babel isn't called.
59 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
61 * format incremented to 267: add plain utf8 encoding (for XeTeX).
63 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
65 * format incremented to 266:
66 Support for the Armenian language
68 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
70 * format incremented to 265: fix LyX's table border line handling
71 With the fix (see bug 1746) LyX now takes care if the user has entered
72 a "|" character in the argument field of tables. Therefore the "|"
73 character has to be removed when also a table border is set.
75 2007-04-24 José Matos <jamatos@lyx.org>
77 * format incremented to 264:
78 textclass cv is renamed simplecv
80 2007-02-22 José Matos <jamatos@lyx.org>
82 * format incremented to 263: changes in the language names (overdue):
84 portuges -> portuguese
86 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
88 * format incremented to 262: Allow ascii \inputencoding
90 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
92 * format incremented to 261: \output_changes is now considered
93 even if \tracking_changes is false. This allows to output existing
94 changes even if future changes are not tracked anymore.
97 \tracking_changes false
100 is therefore converted to
102 \tracking_changes false
103 \output_changes false
105 on upgrade. Nothing is done on downgrade since the new behaviour is
106 not supported in older formats.
108 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
110 * format incremented to 260: Allow utf8x \inputencoding
112 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
114 * format incremented to 259:
115 Old: Spaces at start or end of font changes were output outside of
116 the font change, i.e. not 'xx\textbf{ yy }zz', but
118 New: Spaces are always output with the font set by the user.
120 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
122 * format incremented to 258: new \lyxline definition
124 \\newcommand{\\lyxline}[1]{
125 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
128 \\newcommand{\\lyxline}[1][1pt]{%
130 \\rule[.5ex]{\\linewidth}{#1}\\par}
131 The new definition is more robust, see bug 1988 and now really takes care about
132 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
134 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
136 * format incremented to 257: Caption styles have been replaced by
137 InsetCaption. This is at the same time also a layout file format
138 change to format 3. layout2layout removes caption layouts from old
140 Note that InsetCaption did exist before this format, but was never
141 used. Old files containing do nevertheless still work.
142 Of course users can still define a Caption style in layout files,
143 but the special treatment in LyX is gone (apart from the sensitive
146 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
148 * format incremented to 256: allow some new inputenc settings.
149 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
151 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
153 * format incremented to 255: new insets for \clearpage and
154 \cleardoublepage. They are written inline to the file, exactly like
157 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
159 * format incremented to 254: new header parameter \use_esint.
160 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
163 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
165 * format incremented to 253: new nomenclature and printnomenclature
166 insets. These are standard InsetCommand with the following parameters:
167 \nomenclature[prefix]{symbol}{description}
168 \printnomenclature[labelwidth]
170 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
172 * format incremented to 252: changed command inset syntax
176 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
187 \begin_inset LatexCommand cmdname
194 The order of the parameters and for each parameter the name and
195 optional/required bit is now stored in InsetCommandParams.
197 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
199 * format incremented to 251: save show_label param for charstyles.
201 On revert, the show_label param is just removed. Nothing to convert.
203 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
205 * Format incremented to 250: allow optional arg to environments
207 No material format change. Now optargs for environments are allowed
208 to be specified in layout files and will be handled properly. When
209 converted back to older formats, they will be ignored in LaTeX
212 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
214 * format incremented to 249: Unicode
216 LyX documents are now always encoded in utf8. The value of
217 \inputencoding does now only determine the encoding of the created
219 Up to format 248 the value of \inputencoding did also determine the
220 encoding of the LyX file:
222 \inputencoding LyX file encoding
223 auto as determined by the document and character
226 everything else as determined by \inputencoding
228 The difference between auto and default is only the LaTeX output:
229 auto causes loading of the inputenc package, default does not.
231 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
233 * format incremented to 248: Basic booktabs support
235 The <features> tag has a new switch: booktabs="true|false".
236 An absent switch is equivalent to booktabs="false".
237 Horizontal lines are set with the booktabs package if this switch
240 The <row> tag of tabulars has the following new attributes:
241 topspace, bottomspace and interlinespace. All take a LyXLength
242 as value, or the special keyword "default".
244 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
246 * format incremented to 247. The Grand Font Interface Rewrite.
247 (1) Split font selection to rm, sf, tt:
248 \fontscheme -> \font_roman, \font_sans, \font_typewriter
250 \fontscheme \font_roman \font_sans \font_typewriter
251 default default default default
252 ae ae default default
253 times times default default
254 palatino palatino default default
255 helvet default helvet default
256 avant default avant default
257 newcent newcent default default
258 bookman bookman default default
259 pslatex times (or \usepackage{pslatex})
261 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
262 lmodern, charter, utopia, ccfonts, chancery, beraserif
263 (-> \usepackage{<name>})
264 \font_sans: cmss, lmss, cmbr
265 (-> \renewcommand{\sfdefault}{<name>})
266 berasans (-> \usepackage{<name>})
267 \font_typewriter: cmtt, lmtt, cmtl,
268 (-> \renewcommand{\sfdefault}{<name>})
269 courier, luximono, beramono
270 (-> \usepackage{<name>})
271 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
272 (3) New param \font_sc (true, false).
273 (4) New param \font_osf (true, false).
274 (5) New param \font_sf_scale (float)
275 (6) New param \font_tt_scale (float)
276 Support for the following fonts has been added:
277 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
278 courier, lmodern, luximono, utopia.
279 Support for the following font has been removed:
280 pslatex (it's superseded by mathptmx (times)).
282 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
284 * format incremented to 246. The framed.sty package is
285 now supported with note types framed and shaded.
287 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
289 * format incremented to 245. The \quotes_times parameter
292 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
294 * format incremented to 244. Rename '\InsetSpace \,'
295 to '\InsetSpace \thinspace{}', because the comma was
296 not parsed by lyxlex, and '\InsetSpace \space' to
297 '\InsetSpace \space{}' in favour of consistency.
299 2005-07-18 José Matos <jamatos@lyx.org>
301 * format incremented to 243.
303 * this change only affects the preamble, the paperpackage
304 option was removed and papersize is changed to default.
306 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
308 * format incremented to 242. There is no file format per
309 se, but the "frenchb" language has been removed from lib/language
310 and has to be translated to "french" by lyx2lyx.
312 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
314 * format incremented to 241.
316 All following changes apply only to text in ERT insets. The
317 rationale is that text in ERT is simply ASCII text, and nothing more.
319 * paragraph breaks are now a single newline in latex and not a
320 paragraph break anymore (bug 698).
321 * \newline is not allowed anymore, because it is redundant (see above)
322 * layouts other than Standard, paragraph parameters and font changes
323 are not allowed anymore. They never made sense and were ignored for
324 latex output, but now they can't be read or set anymore (bug 922).
327 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
329 * format incremented to 240.
331 \output_changes {true|false}
332 (should the change tracking marks be visible in the output or not?)
333 * lyx2lyx should just delete the param in 239.
335 2005-01-06 José Matos <jamatos@lyx.org>
337 * format incremented to 239.
338 * the paragraph parameters are displayed in their own line. This
339 change is consistent with the insets behaviour, and corresponds
340 to a more uniform treatment of the paragraphs since some of them
341 had already their own line.
343 An example of a single paragraph follows:
345 \begin_layout Standard
346 \paragraph_spacing single
352 2004-12-03 José Matos <jamatos@lyx.org>
354 * format incremented to 238.
355 * The compatibility code to read old latex accents from 0.12.x in
356 InsetLatexAccent::checkContents has been removed.
357 The following translations are done:
359 "\i \xy" -> "\i \x{y}"
360 "\i \x y" -> "\i \x{y}"
361 "\i \x\i" -> "\i \x{\i}"
362 "\i \x\j" -> "\i \x{\j}"
363 x is a latex accent command, y the base character. \, i and j are
365 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
366 so formats 215 - 237 can have both versions.
369 2004-10-10 José Matos <jamatos@lyx.org>
371 * format incremented to 237.
372 * In the header, the following statments use now booleans values,
378 2004-08-15 José Matos <jamatos@lyx.org>
380 * format incremented to 236.
387 * The options for \papersize are changed:
390 * All whitespaces are removed at the end of lines, when
391 not necessary. As an example we have all the lines in the header that
392 do not belong to the preamble.
394 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
396 * format incremented to 235.
397 * \paperpackage had an off-by-one error. Translation table:
399 234: a4 a4wide widemarginsa4
400 235: none a4 a4wide widemarginsa4
402 The "widemarginsa4" setting of 235 has no equivalent in 234.
404 2004-05-12 Angus Leeming <leeming@lyx.org>
406 * format incremented to 234.
407 * the citation engine is specified explicitly rather than being
408 deduced from 3 bools.
411 \use_numerical_citations 0 -> \cite_engine <style>
414 where <style> is one of "basic", "natbib_authoryear",
415 "natbib_numerical" or "jurabib".
417 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
419 * format incremented to 233.
420 * insetgraphics does not allow filenames without extension anymore.
421 The complete filename has to be given.
423 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
425 * format incremented to 232.
427 * Support for bibtopic (sectioned bibliographies).
428 - bufferparam \use_bibtopic [1|0]
429 - the bibtex inset has a second argument for bibtopic's
430 btPrint{Cited|NotCited|All} command:
432 \begin_inset LatexCommand \bibtex[<style>]{<database>}
434 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
435 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
436 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
437 \bibliographystyle{<style>}
438 \begin{btSect}{<database>}
443 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
445 * format incremented to 231.
447 * Support for sidewaysfigure/sidewaystable (rotating package).
448 insetfloat has now a param \sideways [true|false] (default is false).
449 The param should be erased on downwards conversion, if it was true,
450 the inset should be replaced by
451 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
453 \begin{sidewaystable} <content> \end{sidewaystable}
456 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
458 * format incremented to 230.
460 * Support for a second optional argument in insetcommand.
461 currently, citation uses this to support natbibs second
462 optional argument \cite[before][after]{key}.
463 I think there's nothing to convert upwards. Downwards, the
464 commands with 2 optional args need to be converted to ERT.
466 * Support for jurabib (param \use_jurabib [1|0], default is 0).
467 When converting downwards, \usepackage{jurabib} has to be added
468 to the preamble and, if babel is used, \usepackage{babel} before
469 (jurabib fails if babel is called afterwards). If the natbib commands
470 are used together with jurabib, they have to be converted to ERT too.
472 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
474 * format incremented to 229.
475 * Minipages cannot be read anymore. All minipage insets will
476 be converted to frameless box insets between 228->229.
478 2003-12-15 Angus Leeming <leeming@lyx.org>
480 * format incremented to 228.
481 * Change the output of all insets derived from InsetCollapsable
482 except for InsetERT (which has a similar output already), changing lines
483 "collapsed true" -> "status collapsed"
484 "collapsed false" -> "status open".
485 * Change the output of InsetERT, changing lines
486 "status Collapsed" -> "status collapsed"
487 "status Open" -> "status open".
488 "status Inlined" -> "status inlined".
490 2003-12-10 Angus Leeming <leeming@lyx.org>
492 * format NOT incremented.
493 * add a 'draft' option to InsetExternal.
495 2003-12-10 Angus Leeming <leeming@lyx.org>
497 * format incremented to 227.
498 * Change the output of InsetBox:
499 \begin_inset Boxed -> \begin_inset Box Boxed
500 \begin_inset Doublebox -> \begin_inset Box Doublebox
501 \begin_inset Frameless -> \begin_inset Box Frameless
502 \begin_inset ovalbox -> \begin_inset Box ovalbox
503 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
504 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
506 2003-12-10 Angus Leeming <leeming@lyx.org>
508 * format incremented to 226.
509 * Change the output of InsetNote:
510 \begin_inset Note -> \begin_inset Note Note
511 \begin_inset Comment -> \begin_inset Note Comment
512 \begin_inset Greyedout -> \begin_inset Note Greyedout
514 2003-11-28 André Pönitz
516 * Remove space_above/space_below from Paragraph.
517 This is now handled by InsetVSpace.
519 2003-10-07 Angus Leeming <leeming@lyx.org>
521 * Add transformations to InsetExternal
523 boundingBox 0 0 20 20 the dimensions of the B.B..
524 Output if the B.B. is not empty.
525 clip clip the image to the B.B.
527 extra LaTeX "draft" 'extra' data passed to the primary
528 command for this output format.
529 (Possible formats LaTeX, PDFLaTeX,
530 LinuxDoc, DocBook, Ascii.)
531 The string can contain spaces and so
533 rotateAngle 30 Rotation of the data.
534 Output for non-zero rotation only.
535 rotateOrigin bottomleft Rotation origin.
536 Output for non-zero rotation and
537 non-default origin (center) only.
539 width 2cm Output only if the image is resized.
543 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
545 * Added box inset. File format:
547 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
552 inner_pos "b" t/c/b/s
554 width "100col%" unit+width-string
555 special "none" none/height/depth
557 height "1in" unit+width-string
558 height_special "totalheight" none/height/depth
560 collapsed false true/false
562 \begin_layout Standard
569 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
570 the pre-existing Minipage inset. Parameters translate as follows:
571 position 0/1/2 -> t/c/b
572 inner_position 0/1/2/3 -> inner_pos c/t/b/s
577 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
579 * attribute valignment="center" is replaced by valignment="middle"
580 for tabular columns and cells
582 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
584 * Added branch inset. File format:
586 branch definition in the header:
592 \begin_inset Branch <branchname>
593 collapsed false true/false
595 \begin_layout Standard
602 2003-07-28 José Matos <jamatos@lyx.org>
604 * \the_end is replaced with \end_document
606 2003-07-28 José Matos <jamatos@lyx.org>
608 * \layout is replaced with \begin_layout
610 2003-07-28 José Matos <jamatos@fep.up.pt>
614 * All layouts finish now with \end_layout
616 2003-06-04 Angus Leeming <leeming@lyx.org>
620 * the storage of the external inset has been changed from
622 \begin_inset External XFig,"file.fig",""
628 \begin_inset External
631 display <display_type>
636 throwing away the final arg (here "", more generally "<string>") that holds
637 the parameters variable.
638 Variables are output if present (filename) or different from the default
639 values (display, lyxscale).
641 Moreover, the RasterImage template has been scrapped. All RasterImage
642 external insets are now converted to Graphics insets.
644 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
646 * Added new space insets:
647 \SpecialChar ~ is now \InsetSpace ~
648 ERT: "\ " could be converted to InsetSpace \<space>
649 ERT: "\," could be converted to InsetSpace \,
651 2003-04-24 André Pönitz <poenitz@gmx.net>
653 * Added eqref support:
654 \begin_inset LatexCommand \eqref{label}
656 2003-03-14 Dekel Tsur
658 * Format bumped to 223.
660 2003-03-12 John Levon <levon@movementarian.org>
662 * Added \\end_header to signify the end of the header in a
665 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
667 2003-02-10 John Levon <levon@movementarian.org>
671 Added \\tracking_changes 0|1 to the header.
673 Added \\author to the header. This can be present multiple
674 times, and is of the form :
676 \\author "Real Name" email@address.com
678 Added \\change_deleted, \\change_inserted. Each of these does not
679 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
682 \\change_inserted author time
684 where author is an integer ID reference into the author list in
685 the header, and time is time_t.
687 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
689 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
691 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
693 New graphics dialog. With the removal of buttons in the dialog, also
694 keywords in the graphics inset went. The following keywords do not
704 Only non-default values are saved to the lyx files. The defaults of the remaining
714 BoundingBox <from file>
717 rotateOrigin centerBaseline
719 subcaptionText <empty>
722 The remaining keywords have sufficient overlap with the old ones for a
723 smooth reading of the 1.2.x inset keywords in most common cases.
725 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
726 They don't exist anymore and we can't translate them into a scaling value, while
727 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
728 argument is ignored and lost.
730 Only few compatibility issues are left for lyx2lyx:
732 ------------------------------------------------------------------------------
733 old-token new-token remove
734 ------------------------------------------------------------------------------
735 size_kind original / size_type 0 scale 100 width <val>
739 size_kind width_height / size_type 1 - scale <val>
741 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
742 ------------------------------------------------------------------------------
743 [replace old-token by new-token, and remove any of subsequent tokens as listed]
745 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
746 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
748 replace "rotateAngle <val>" by "rotateAngle 0"
751 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
753 Added \lyxlock for locked math inset when written to .lyx file.
754 When "downgrading" .lyx files this should simple be deleted but it
755 does not hurt at all if it stays in. It does not have to be added
759 2002-08-02 Angus Leeming <leeming@lyx.org>
761 Added a boolean "preview" flag to InsetCommandParams.
762 Currently it is written only by InsetInclude, because only this
763 class can generate a preview of its contents.
765 The LyX file now contains:
767 \begin_inset Include \input{snapshot_t=40.tex}
772 Earlier versions of LyX just swallow this extra token silently.
774 2002-08-12 Angus Leeming <leeming@lyx.org>
776 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
777 renamed as "size_kind" and "lyxsize_kind" respectively.
779 \begin_inset Graphics FormatVersion 1
786 - lyxsize_kind original
787 + lyxsize_type original