1 LyX file-format changes
2 -----------------------
4 2007-06-13 Dov Feldstern <dov@lyx.org>
5 * format incremented to 274: applying the conversion done in format 259
6 to the \lang property, which was forgotten back then... This is
7 slightly more complicated, because the default language has to be
8 determined on a per-paragraph basis.
10 2007-06-13 Bo Peng <ben.bob@gmail.com>
11 * format incremented to 273: add --Separator-- environment to
12 separate consecutive environments
14 2007-06-13 Bo Peng <bpeng@lyx.org>
15 * format incremented to 272: convert listings to ERT because
16 earlier versions of lyx can not handle unrecognizable
19 2007-05-15 José Matos <jamatos@lyx.org>
20 * format incremented to 271: extended textclasses accept the
21 normal font sizes: 10, 11 and 12pt.
23 2007-05-14 Martin Vermeer <martin.vermeer@tkk.fi>
24 * format incremented to 270: support beamer \alert, \structure
26 2007-05-08 Bo Peng <ben.bob@gmail.com>
27 * format incremented to 269: add listings support
28 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
29 - add inset listings, with options lstparams and inline, e.g.
31 lstparams "xleftmargin=50pt,language=Python"
33 - add \lstinputlisting Include type. e.g.
34 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
36 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
38 * format incremented to 268: add support for the CJK encodings
39 - all encodings supported by CJK.sty are now in lib/encodings
40 - lib/encoding has got two new flags:
42 "inputenc" for those languages that use the inputenc-package and
43 "CJK" for the CJK encodings
44 - "fixed"/"variable" to divide between multi- or single-byte encoding
45 - lib/languages allows now to set an empty language for babel
46 in this case babel isn't called.
48 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
50 * format incremented to 267: add plain utf8 encoding (for XeTeX).
52 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
54 * format incremented to 266:
55 Support for the Armenian language
57 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
59 * format incremented to 265: fix LyX's table border line handling
60 With the fix (see bug 1746) LyX now takes care if the user has entered
61 a "|" character in the argument field of tables. Therefore the "|"
62 character has to be removed when also a table border is set.
64 2007-04-24 José Matos <jamatos@lyx.org>
66 * format incremented to 264:
67 textclass cv is renamed simplecv
69 2007-02-22 José Matos <jamatos@lyx.org>
71 * format incremented to 263: changes in the language names (overdue):
73 portuges -> portuguese
75 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
77 * format incremented to 262: Allow ascii \inputencoding
79 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
81 * format incremented to 261: \output_changes is now considered
82 even if \tracking_changes is false. This allows to output existing
83 changes even if future changes are not tracked anymore.
86 \tracking_changes false
89 is therefore converted to
91 \tracking_changes false
94 on upgrade. Nothing is done on downgrade since the new behaviour is
95 not supported in older formats.
97 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
99 * format incremented to 260: Allow utf8x \inputencoding
101 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
103 * format incremented to 259:
104 Old: Spaces at start or end of font changes were output outside of
105 the font change, i.e. not 'xx\textbf{ yy }zz', but
107 New: Spaces are always output with the font set by the user.
109 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
111 * format incremented to 258: new \lyxline definition
113 \\newcommand{\\lyxline}[1]{
114 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
117 \\newcommand{\\lyxline}[1][1pt]{%
119 \\rule[.5ex]{\\linewidth}{#1}\\par}
120 The new definition is more robust, see bug 1988 and now really takes care about
121 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
123 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
125 * format incremented to 257: Caption styles have been replaced by
126 InsetCaption. This is at the same time also a layout file format
127 change to format 3. layout2layout removes caption layouts from old
129 Note that InsetCaption did exist before this format, but was never
130 used. Old files containing do nevertheless still work.
131 Of course users can still define a Caption style in layout files,
132 but the special treatment in LyX is gone (apart from the sensitive
135 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
137 * format incremented to 256: allow some new inputenc settings.
138 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
140 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
142 * format incremented to 255: new insets for \clearpage and
143 \cleardoublepage. They are written inline to the file, exactly like
146 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
148 * format incremented to 254: new header parameter \use_esint.
149 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
152 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
154 * format incremented to 253: new nomenclature and printnomenclature
155 insets. These are standard InsetCommand with the following parameters:
156 \nomenclature[prefix]{symbol}{description}
157 \printnomenclature[labelwidth]
159 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
161 * format incremented to 252: changed command inset syntax
165 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
176 \begin_inset LatexCommand cmdname
183 The order of the parameters and for each parameter the name and
184 optional/required bit is now stored in InsetCommandParams.
186 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
188 * format incremented to 251: save show_label param for charstyles.
190 On revert, the show_label param is just removed. Nothing to convert.
192 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
194 * Format incremented to 250: allow optional arg to environments
196 No material format change. Now optargs for environments are allowed
197 to be specified in layout files and will be handled properly. When
198 converted back to older formats, they will be ignored in LaTeX
201 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
203 * format incremented to 249: Unicode
205 LyX documents are now always encoded in utf8. The value of
206 \inputencoding does now only determine the encoding of the created
208 Up to format 248 the value of \inputencoding did also determine the
209 encoding of the LyX file:
211 \inputencoding LyX file encoding
212 auto as determined by the document and character
215 everything else as determined by \inputencoding
217 The difference between auto and default is only the LaTeX output:
218 auto causes loading of the inputenc package, default does not.
220 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
222 * format incremented to 248: Basic booktabs support
224 The <features> tag has a new switch: booktabs="true|false".
225 An absent switch is equivalent to booktabs="false".
226 Horizontal lines are set with the booktabs package if this switch
229 The <row> tag of tabulars has the following new attributes:
230 topspace, bottomspace and interlinespace. All take a LyXLength
231 as value, or the special keyword "default".
233 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
235 * format incremented to 247. The Grand Font Interface Rewrite.
236 (1) Split font selection to rm, sf, tt:
237 \fontscheme -> \font_roman, \font_sans, \font_typewriter
239 \fontscheme \font_roman \font_sans \font_typewriter
240 default default default default
241 ae ae default default
242 times times default default
243 palatino palatino default default
244 helvet default helvet default
245 avant default avant default
246 newcent newcent default default
247 bookman bookman default default
248 pslatex times (or \usepackage{pslatex})
250 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
251 lmodern, charter, utopia, ccfonts, chancery, beraserif
252 (-> \usepackage{<name>})
253 \font_sans: cmss, lmss, cmbr
254 (-> \renewcommand{\sfdefault}{<name>})
255 berasans (-> \usepackage{<name>})
256 \font_typewriter: cmtt, lmtt, cmtl,
257 (-> \renewcommand{\sfdefault}{<name>})
258 courier, luximono, beramono
259 (-> \usepackage{<name>})
260 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
261 (3) New param \font_sc (true, false).
262 (4) New param \font_osf (true, false).
263 (5) New param \font_sf_scale (float)
264 (6) New param \font_tt_scale (float)
265 Support for the following fonts has been added:
266 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
267 courier, lmodern, luximono, utopia.
268 Support for the following font has been removed:
269 pslatex (it's superseded by mathptmx (times)).
271 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
273 * format incremented to 246. The framed.sty package is
274 now supported with note types framed and shaded.
276 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
278 * format incremented to 245. The \quotes_times parameter
281 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
283 * format incremented to 244. Rename '\InsetSpace \,'
284 to '\InsetSpace \thinspace{}', because the comma was
285 not parsed by lyxlex, and '\InsetSpace \space' to
286 '\InsetSpace \space{}' in favour of consistency.
288 2005-07-18 José Matos <jamatos@lyx.org>
290 * format incremented to 243.
292 * this change only affects the preamble, the paperpackage
293 option was removed and papersize is changed to default.
295 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
297 * format incremented to 242. There is no file format per
298 se, but the "frenchb" language has been removed from lib/language
299 and has to be translated to "french" by lyx2lyx.
301 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
303 * format incremented to 241.
305 All following changes apply only to text in ERT insets. The
306 rationale is that text in ERT is simply ASCII text, and nothing more.
308 * paragraph breaks are now a single newline in latex and not a
309 paragraph break anymore (bug 698).
310 * \newline is not allowed anymore, because it is redundant (see above)
311 * layouts other than Standard, paragraph parameters and font changes
312 are not allowed anymore. They never made sense and were ignored for
313 latex output, but now they can't be read or set anymore (bug 922).
316 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
318 * format incremented to 240.
320 \output_changes {true|false}
321 (should the change tracking marks be visible in the output or not?)
322 * lyx2lyx should just delete the param in 239.
324 2005-01-06 José Matos <jamatos@lyx.org>
326 * format incremented to 239.
327 * the paragraph parameters are displayed in their own line. This
328 change is consistent with the insets behaviour, and corresponds
329 to a more uniform treatment of the paragraphs since some of them
330 had already their own line.
332 An example of a single paragraph follows:
334 \begin_layout Standard
335 \paragraph_spacing single
341 2004-12-03 José Matos <jamatos@lyx.org>
343 * format incremented to 238.
344 * The compatibility code to read old latex accents from 0.12.x in
345 InsetLatexAccent::checkContents has been removed.
346 The following translations are done:
348 "\i \xy" -> "\i \x{y}"
349 "\i \x y" -> "\i \x{y}"
350 "\i \x\i" -> "\i \x{\i}"
351 "\i \x\j" -> "\i \x{\j}"
352 x is a latex accent command, y the base character. \, i and j are
354 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
355 so formats 215 - 237 can have both versions.
358 2004-10-10 José Matos <jamatos@lyx.org>
360 * format incremented to 237.
361 * In the header, the following statments use now booleans values,
367 2004-08-15 José Matos <jamatos@lyx.org>
369 * format incremented to 236.
376 * The options for \papersize are changed:
379 * All whitespaces are removed at the end of lines, when
380 not necessary. As an example we have all the lines in the header that
381 do not belong to the preamble.
383 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
385 * format incremented to 235.
386 * \paperpackage had an off-by-one error. Translation table:
388 234: a4 a4wide widemarginsa4
389 235: none a4 a4wide widemarginsa4
391 The "widemarginsa4" setting of 235 has no equivalent in 234.
393 2004-05-12 Angus Leeming <leeming@lyx.org>
395 * format incremented to 234.
396 * the citation engine is specified explicitly rather than being
397 deduced from 3 bools.
400 \use_numerical_citations 0 -> \cite_engine <style>
403 where <style> is one of "basic", "natbib_authoryear",
404 "natbib_numerical" or "jurabib".
406 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
408 * format incremented to 233.
409 * insetgraphics does not allow filenames without extension anymore.
410 The complete filename has to be given.
412 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
414 * format incremented to 232.
416 * Support for bibtopic (sectioned bibliographies).
417 - bufferparam \use_bibtopic [1|0]
418 - the bibtex inset has a second argument for bibtopic's
419 btPrint{Cited|NotCited|All} command:
421 \begin_inset LatexCommand \bibtex[<style>]{<database>}
423 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
424 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
425 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
426 \bibliographystyle{<style>}
427 \begin{btSect}{<database>}
432 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
434 * format incremented to 231.
436 * Support for sidewaysfigure/sidewaystable (rotating package).
437 insetfloat has now a param \sideways [true|false] (default is false).
438 The param should be erased on downwards conversion, if it was true,
439 the inset should be replaced by
440 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
442 \begin{sidewaystable} <content> \end{sidewaystable}
445 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
447 * format incremented to 230.
449 * Support for a second optional argument in insetcommand.
450 currently, citation uses this to support natbibs second
451 optional argument \cite[before][after]{key}.
452 I think there's nothing to convert upwards. Downwards, the
453 commands with 2 optional args need to be converted to ERT.
455 * Support for jurabib (param \use_jurabib [1|0], default is 0).
456 When converting downwards, \usepackage{jurabib} has to be added
457 to the preamble and, if babel is used, \usepackage{babel} before
458 (jurabib fails if babel is called afterwards). If the natbib commands
459 are used together with jurabib, they have to be converted to ERT too.
461 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
463 * format incremented to 229.
464 * Minipages cannot be read anymore. All minipage insets will
465 be converted to frameless box insets between 228->229.
467 2003-12-15 Angus Leeming <leeming@lyx.org>
469 * format incremented to 228.
470 * Change the output of all insets derived from InsetCollapsable
471 except for InsetERT (which has a similar output already), changing lines
472 "collapsed true" -> "status collapsed"
473 "collapsed false" -> "status open".
474 * Change the output of InsetERT, changing lines
475 "status Collapsed" -> "status collapsed"
476 "status Open" -> "status open".
477 "status Inlined" -> "status inlined".
479 2003-12-10 Angus Leeming <leeming@lyx.org>
481 * format NOT incremented.
482 * add a 'draft' option to InsetExternal.
484 2003-12-10 Angus Leeming <leeming@lyx.org>
486 * format incremented to 227.
487 * Change the output of InsetBox:
488 \begin_inset Boxed -> \begin_inset Box Boxed
489 \begin_inset Doublebox -> \begin_inset Box Doublebox
490 \begin_inset Frameless -> \begin_inset Box Frameless
491 \begin_inset ovalbox -> \begin_inset Box ovalbox
492 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
493 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
495 2003-12-10 Angus Leeming <leeming@lyx.org>
497 * format incremented to 226.
498 * Change the output of InsetNote:
499 \begin_inset Note -> \begin_inset Note Note
500 \begin_inset Comment -> \begin_inset Note Comment
501 \begin_inset Greyedout -> \begin_inset Note Greyedout
503 2003-11-28 André Pönitz
505 * Remove space_above/space_below from Paragraph.
506 This is now handled by InsetVSpace.
508 2003-10-07 Angus Leeming <leeming@lyx.org>
510 * Add transformations to InsetExternal
512 boundingBox 0 0 20 20 the dimensions of the B.B..
513 Output if the B.B. is not empty.
514 clip clip the image to the B.B.
516 extra LaTeX "draft" 'extra' data passed to the primary
517 command for this output format.
518 (Possible formats LaTeX, PDFLaTeX,
519 LinuxDoc, DocBook, Ascii.)
520 The string can contain spaces and so
522 rotateAngle 30 Rotation of the data.
523 Output for non-zero rotation only.
524 rotateOrigin bottomleft Rotation origin.
525 Output for non-zero rotation and
526 non-default origin (center) only.
528 width 2cm Output only if the image is resized.
532 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
534 * Added box inset. File format:
536 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
541 inner_pos "b" t/c/b/s
543 width "100col%" unit+width-string
544 special "none" none/height/depth
546 height "1in" unit+width-string
547 height_special "totalheight" none/height/depth
549 collapsed false true/false
551 \begin_layout Standard
558 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
559 the pre-existing Minipage inset. Parameters translate as follows:
560 position 0/1/2 -> t/c/b
561 inner_position 0/1/2/3 -> inner_pos c/t/b/s
566 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
568 * attribute valignment="center" is replaced by valignment="middle"
569 for tabular columns and cells
571 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
573 * Added branch inset. File format:
575 branch definition in the header:
581 \begin_inset Branch <branchname>
582 collapsed false true/false
584 \begin_layout Standard
591 2003-07-28 José Matos <jamatos@lyx.org>
593 * \the_end is replaced with \end_document
595 2003-07-28 José Matos <jamatos@lyx.org>
597 * \layout is replaced with \begin_layout
599 2003-07-28 José Matos <jamatos@fep.up.pt>
603 * All layouts finish now with \end_layout
605 2003-06-04 Angus Leeming <leeming@lyx.org>
609 * the storage of the external inset has been changed from
611 \begin_inset External XFig,"file.fig",""
617 \begin_inset External
620 display <display_type>
625 throwing away the final arg (here "", more generally "<string>") that holds
626 the parameters variable.
627 Variables are output if present (filename) or different from the default
628 values (display, lyxscale).
630 Moreover, the RasterImage template has been scrapped. All RasterImage
631 external insets are now converted to Graphics insets.
633 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
635 * Added new space insets:
636 \SpecialChar ~ is now \InsetSpace ~
637 ERT: "\ " could be converted to InsetSpace \<space>
638 ERT: "\," could be converted to InsetSpace \,
640 2003-04-24 André Pönitz <poenitz@gmx.net>
642 * Added eqref support:
643 \begin_inset LatexCommand \eqref{label}
645 2003-03-14 Dekel Tsur
647 * Format bumped to 223.
649 2003-03-12 John Levon <levon@movementarian.org>
651 * Added \\end_header to signify the end of the header in a
654 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
656 2003-02-10 John Levon <levon@movementarian.org>
660 Added \\tracking_changes 0|1 to the header.
662 Added \\author to the header. This can be present multiple
663 times, and is of the form :
665 \\author "Real Name" email@address.com
667 Added \\change_deleted, \\change_inserted. Each of these does not
668 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
671 \\change_inserted author time
673 where author is an integer ID reference into the author list in
674 the header, and time is time_t.
676 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
678 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
680 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
682 New graphics dialog. With the removal of buttons in the dialog, also
683 keywords in the graphics inset went. The following keywords do not
693 Only non-default values are saved to the lyx files. The defaults of the remaining
703 BoundingBox <from file>
706 rotateOrigin centerBaseline
708 subcaptionText <empty>
711 The remaining keywords have sufficient overlap with the old ones for a
712 smooth reading of the 1.2.x inset keywords in most common cases.
714 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
715 They don't exist anymore and we can't translate them into a scaling value, while
716 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
717 argument is ignored and lost.
719 Only few compatibility issues are left for lyx2lyx:
721 ------------------------------------------------------------------------------
722 old-token new-token remove
723 ------------------------------------------------------------------------------
724 size_kind original / size_type 0 scale 100 width <val>
728 size_kind width_height / size_type 1 - scale <val>
730 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
731 ------------------------------------------------------------------------------
732 [replace old-token by new-token, and remove any of subsequent tokens as listed]
734 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
735 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
737 replace "rotateAngle <val>" by "rotateAngle 0"
740 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
742 Added \lyxlock for locked math inset when written to .lyx file.
743 When "downgrading" .lyx files this should simple be deleted but it
744 does not hurt at all if it stays in. It does not have to be added
748 2002-08-02 Angus Leeming <leeming@lyx.org>
750 Added a boolean "preview" flag to InsetCommandParams.
751 Currently it is written only by InsetInclude, because only this
752 class can generate a preview of its contents.
754 The LyX file now contains:
756 \begin_inset Include \input{snapshot_t=40.tex}
761 Earlier versions of LyX just swallow this extra token silently.
763 2002-08-12 Angus Leeming <leeming@lyx.org>
765 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
766 renamed as "size_kind" and "lyxsize_kind" respectively.
768 \begin_inset Graphics FormatVersion 1
775 - lyxsize_kind original
776 + lyxsize_type original