1 LyX file-format changes
2 -----------------------
4 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
6 * format incremented to 266:
7 Support for the Armenian language
9 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
11 * format incremented to 265: fix LyX's table border line handling
12 With the fix (see bug 1746) LyX now takes care if the user has entered
13 a "|" character in the argument field of tables. Therefore the "|"
14 character has to be removed when also a table border is set.
16 2007-04-24 José Matos <jamatos@lyx.org>
18 * format incremented to 264:
19 textclass cv is renamed simplecv
21 2007-02-22 José Matos <jamatos@lyx.org>
23 * format incremented to 263: changes in the language names (overdue):
25 portuges -> portuguese
27 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
29 * format incremented to 262: Allow ascii \inputencoding
31 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
33 * format incremented to 261: \output_changes is now considered
34 even if \tracking_changes is false. This allows to output existing
35 changes even if future changes are not tracked anymore.
38 \tracking_changes false
41 is therefore converted to
43 \tracking_changes false
46 on upgrade. Nothing is done on downgrade since the new behaviour is
47 not supported in older formats.
49 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
51 * format incremented to 260: Allow utf8x \inputencoding
53 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
55 * format incremented to 259:
56 Old: Spaces at start or end of font changes were output outside of
57 the font change, i.e. not 'xx\textbf{ yy }zz', but
59 New: Spaces are always output with the font set by the user.
61 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
63 * format incremented to 258: new \lyxline definition
65 \\newcommand{\\lyxline}[1]{
66 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
69 \\newcommand{\\lyxline}[1][1pt]{%
71 \\rule[.5ex]{\\linewidth}{#1}\\par}
72 The new definition is more robust, see bug 1988 and now really takes care about
73 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
75 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
77 * format incremented to 257: Caption styles have been replaced by
78 InsetCaption. This is at the same time also a layout file format
79 change to format 3. layout2layout removes caption layouts from old
81 Note that InsetCaption did exist before this format, but was never
82 used. Old files containing do nevertheless still work.
83 Of course users can still define a Caption style in layout files,
84 but the special treatment in LyX is gone (apart from the sensitive
87 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
89 * format incremented to 256: allow some new inputenc settings.
90 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
92 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
94 * format incremented to 255: new insets for \clearpage and
95 \cleardoublepage. They are written inline to the file, exactly like
98 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
100 * format incremented to 254: new header parameter \use_esint.
101 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
104 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
106 * format incremented to 253: new nomenclature and printnomenclature
107 insets. These are standard InsetCommand with the following parameters:
108 \nomenclature[prefix]{symbol}{description}
109 \printnomenclature[labelwidth]
111 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
113 * format incremented to 252: changed command inset syntax
117 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
128 \begin_inset LatexCommand cmdname
135 The order of the parameters and for each parameter the name and
136 optional/required bit is now stored in InsetCommandParams.
138 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
140 * format incremented to 251: save show_label param for charstyles.
142 On revert, the show_label param is just removed. Nothing to convert.
144 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
146 * Format incremented to 250: allow optional arg to environments
148 No material format change. Now optargs for environments are allowed
149 to be specified in layout files and will be handled properly. When
150 converted back to older formats, they will be ignored in LaTeX
153 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
155 * format incremented to 249: Unicode
157 LyX documents are now always encoded in utf8. The value of
158 \inputencoding does now only determine the encoding of the created
160 Up to format 248 the value of \inputencoding did also determine the
161 encoding of the LyX file:
163 \inputencoding LyX file encoding
164 auto as determined by the document and character
167 everything else as determined by \inputencoding
169 The difference between auto and default is only the LaTeX output:
170 auto causes loading of the inputenc package, default does not.
172 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
174 * format incremented to 248: Basic booktabs support
176 The <features> tag has a new switch: booktabs="true|false".
177 An absent switch is equivalent to booktabs="false".
178 Horizontal lines are set with the booktabs package if this switch
181 The <row> tag of tabulars has the following new attributes:
182 topspace, bottomspace and interlinespace. All take a LyXLength
183 as value, or the special keyword "default".
185 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
187 * format incremented to 247. The Grand Font Interface Rewrite.
188 (1) Split font selection to rm, sf, tt:
189 \fontscheme -> \font_roman, \font_sans, \font_typewriter
191 \fontscheme \font_roman \font_sans \font_typewriter
192 default default default default
193 ae ae default default
194 times times default default
195 palatino palatino default default
196 helvet default helvet default
197 avant default avant default
198 newcent newcent default default
199 bookman bookman default default
200 pslatex times (or \usepackage{pslatex})
202 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
203 lmodern, charter, utopia, ccfonts, chancery, beraserif
204 (-> \usepackage{<name>})
205 \font_sans: cmss, lmss, cmbr
206 (-> \renewcommand{\sfdefault}{<name>})
207 berasans (-> \usepackage{<name>})
208 \font_typewriter: cmtt, lmtt, cmtl,
209 (-> \renewcommand{\sfdefault}{<name>})
210 courier, luximono, beramono
211 (-> \usepackage{<name>})
212 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
213 (3) New param \font_sc (true, false).
214 (4) New param \font_osf (true, false).
215 (5) New param \font_sf_scale (float)
216 (6) New param \font_tt_scale (float)
217 Support for the following fonts has been added:
218 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
219 courier, lmodern, luximono, utopia.
220 Support for the following font has been removed:
221 pslatex (it's superseded by mathptmx (times)).
223 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
225 * format incremented to 246. The framed.sty package is
226 now supported with note types framed and shaded.
228 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
230 * format incremented to 245. The \quotes_times parameter
233 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
235 * format incremented to 244. Rename '\InsetSpace \,'
236 to '\InsetSpace \thinspace{}', because the comma was
237 not parsed by lyxlex, and '\InsetSpace \space' to
238 '\InsetSpace \space{}' in favour of consistency.
240 2005-07-18 José Matos <jamatos@lyx.org>
242 * format incremented to 243.
244 * this change only affects the preamble, the paperpackage
245 option was removed and papersize is changed to default.
247 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
249 * format incremented to 242. There is no file format per
250 se, but the "frenchb" language has been removed from lib/language
251 and has to be translated to "french" by lyx2lyx.
253 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
255 * format incremented to 241.
257 All following changes apply only to text in ERT insets. The
258 rationale is that text in ERT is simply ASCII text, and nothing more.
260 * paragraph breaks are now a single newline in latex and not a
261 paragraph break anymore (bug 698).
262 * \newline is not allowed anymore, because it is redundant (see above)
263 * layouts other than Standard, paragraph parameters and font changes
264 are not allowed anymore. They never made sense and were ignored for
265 latex output, but now they can't be read or set anymore (bug 922).
268 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
270 * format incremented to 240.
272 \output_changes {true|false}
273 (should the change tracking marks be visible in the output or not?)
274 * lyx2lyx should just delete the param in 239.
276 2005-01-06 José Matos <jamatos@lyx.org>
278 * format incremented to 239.
279 * the paragraph parameters are displayed in their own line. This
280 change is consistent with the insets behaviour, and corresponds
281 to a more uniform treatment of the paragraphs since some of them
282 had already their own line.
284 An example of a single paragraph follows:
286 \begin_layout Standard
287 \paragraph_spacing single
293 2004-12-03 José Matos <jamatos@lyx.org>
295 * format incremented to 238.
296 * The compatibility code to read old latex accents from 0.12.x in
297 InsetLatexAccent::checkContents has been removed.
298 The following translations are done:
300 "\i \xy" -> "\i \x{y}"
301 "\i \x y" -> "\i \x{y}"
302 "\i \x\i" -> "\i \x{\i}"
303 "\i \x\j" -> "\i \x{\j}"
304 x is a latex accent command, y the base character. \, i and j are
306 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
307 so formats 215 - 237 can have both versions.
310 2004-10-10 José Matos <jamatos@lyx.org>
312 * format incremented to 237.
313 * In the header, the following statments use now booleans values,
319 2004-08-15 José Matos <jamatos@lyx.org>
321 * format incremented to 236.
328 * The options for \papersize are changed:
331 * All whitespaces are removed at the end of lines, when
332 not necessary. As an example we have all the lines in the header that
333 do not belong to the preamble.
335 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
337 * format incremented to 235.
338 * \paperpackage had an off-by-one error. Translation table:
340 234: a4 a4wide widemarginsa4
341 235: none a4 a4wide widemarginsa4
343 The "widemarginsa4" setting of 235 has no equivalent in 234.
345 2004-05-12 Angus Leeming <leeming@lyx.org>
347 * format incremented to 234.
348 * the citation engine is specified explicitly rather than being
349 deduced from 3 bools.
352 \use_numerical_citations 0 -> \cite_engine <style>
355 where <style> is one of "basic", "natbib_authoryear",
356 "natbib_numerical" or "jurabib".
358 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
360 * format incremented to 233.
361 * insetgraphics does not allow filenames without extension anymore.
362 The complete filename has to be given.
364 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
366 * format incremented to 232.
368 * Support for bibtopic (sectioned bibliographies).
369 - bufferparam \use_bibtopic [1|0]
370 - the bibtex inset has a second argument for bibtopic's
371 btPrint{Cited|NotCited|All} command:
373 \begin_inset LatexCommand \bibtex[<style>]{<database>}
375 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
376 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
377 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
378 \bibliographystyle{<style>}
379 \begin{btSect}{<database>}
384 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
386 * format incremented to 231.
388 * Support for sidewaysfigure/sidewaystable (rotating package).
389 insetfloat has now a param \sideways [true|false] (default is false).
390 The param should be erased on downwards conversion, if it was true,
391 the inset should be replaced by
392 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
394 \begin{sidewaystable} <content> \end{sidewaystable}
397 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
399 * format incremented to 230.
401 * Support for a second optional argument in insetcommand.
402 currently, citation uses this to support natbibs second
403 optional argument \cite[before][after]{key}.
404 I think there's nothing to convert upwards. Downwards, the
405 commands with 2 optional args need to be converted to ERT.
407 * Support for jurabib (param \use_jurabib [1|0], default is 0).
408 When converting downwards, \usepackage{jurabib} has to be added
409 to the preamble and, if babel is used, \usepackage{babel} before
410 (jurabib fails if babel is called afterwards). If the natbib commands
411 are used together with jurabib, they have to be converted to ERT too.
413 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
415 * format incremented to 229.
416 * Minipages cannot be read anymore. All minipage insets will
417 be converted to frameless box insets between 228->229.
419 2003-12-15 Angus Leeming <leeming@lyx.org>
421 * format incremented to 228.
422 * Change the output of all insets derived from InsetCollapsable
423 except for InsetERT (which has a similar output already), changing lines
424 "collapsed true" -> "status collapsed"
425 "collapsed false" -> "status open".
426 * Change the output of InsetERT, changing lines
427 "status Collapsed" -> "status collapsed"
428 "status Open" -> "status open".
429 "status Inlined" -> "status inlined".
431 2003-12-10 Angus Leeming <leeming@lyx.org>
433 * format NOT incremented.
434 * add a 'draft' option to InsetExternal.
436 2003-12-10 Angus Leeming <leeming@lyx.org>
438 * format incremented to 227.
439 * Change the output of InsetBox:
440 \begin_inset Boxed -> \begin_inset Box Boxed
441 \begin_inset Doublebox -> \begin_inset Box Doublebox
442 \begin_inset Frameless -> \begin_inset Box Frameless
443 \begin_inset ovalbox -> \begin_inset Box ovalbox
444 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
445 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
447 2003-12-10 Angus Leeming <leeming@lyx.org>
449 * format incremented to 226.
450 * Change the output of InsetNote:
451 \begin_inset Note -> \begin_inset Note Note
452 \begin_inset Comment -> \begin_inset Note Comment
453 \begin_inset Greyedout -> \begin_inset Note Greyedout
455 2003-11-28 André Pönitz
457 * Remove space_above/space_below from Paragraph.
458 This is now handled by InsetVSpace.
460 2003-10-07 Angus Leeming <leeming@lyx.org>
462 * Add transformations to InsetExternal
464 boundingBox 0 0 20 20 the dimensions of the B.B..
465 Output if the B.B. is not empty.
466 clip clip the image to the B.B.
468 extra LaTeX "draft" 'extra' data passed to the primary
469 command for this output format.
470 (Possible formats LaTeX, PDFLaTeX,
471 LinuxDoc, DocBook, Ascii.)
472 The string can contain spaces and so
474 rotateAngle 30 Rotation of the data.
475 Output for non-zero rotation only.
476 rotateOrigin bottomleft Rotation origin.
477 Output for non-zero rotation and
478 non-default origin (center) only.
480 width 2cm Output only if the image is resized.
484 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
486 * Added box inset. File format:
488 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
493 inner_pos "b" t/c/b/s
495 width "100col%" unit+width-string
496 special "none" none/height/depth
498 height "1in" unit+width-string
499 height_special "totalheight" none/height/depth
501 collapsed false true/false
503 \begin_layout Standard
510 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
511 the pre-existing Minipage inset. Parameters translate as follows:
512 position 0/1/2 -> t/c/b
513 inner_position 0/1/2/3 -> inner_pos c/t/b/s
518 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
520 * attribute valignment="center" is replaced by valignment="middle"
521 for tabular columns and cells
523 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
525 * Added branch inset. File format:
527 branch definition in the header:
533 \begin_inset Branch <branchname>
534 collapsed false true/false
536 \begin_layout Standard
543 2003-07-28 José Matos <jamatos@lyx.org>
545 * \the_end is replaced with \end_document
547 2003-07-28 José Matos <jamatos@lyx.org>
549 * \layout is replaced with \begin_layout
551 2003-07-28 José Matos <jamatos@fep.up.pt>
555 * All layouts finish now with \end_layout
557 2003-06-04 Angus Leeming <leeming@lyx.org>
561 * the storage of the external inset has been changed from
563 \begin_inset External XFig,"file.fig",""
569 \begin_inset External
572 display <display_type>
577 throwing away the final arg (here "", more generally "<string>") that holds
578 the parameters variable.
579 Variables are output if present (filename) or different from the default
580 values (display, lyxscale).
582 Moreover, the RasterImage template has been scrapped. All RasterImage
583 external insets are now converted to Graphics insets.
585 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
587 * Added new space insets:
588 \SpecialChar ~ is now \InsetSpace ~
589 ERT: "\ " could be converted to InsetSpace \<space>
590 ERT: "\," could be converted to InsetSpace \,
592 2003-04-24 André Pönitz <poenitz@gmx.net>
594 * Added eqref support:
595 \begin_inset LatexCommand \eqref{label}
597 2003-03-14 Dekel Tsur
599 * Format bumped to 223.
601 2003-03-12 John Levon <levon@movementarian.org>
603 * Added \\end_header to signify the end of the header in a
606 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
608 2003-02-10 John Levon <levon@movementarian.org>
612 Added \\tracking_changes 0|1 to the header.
614 Added \\author to the header. This can be present multiple
615 times, and is of the form :
617 \\author "Real Name" email@address.com
619 Added \\change_deleted, \\change_inserted. Each of these does not
620 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
623 \\change_inserted author time
625 where author is an integer ID reference into the author list in
626 the header, and time is time_t.
628 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
630 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
632 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
634 New graphics dialog. With the removal of buttons in the dialog, also
635 keywords in the graphics inset went. The following keywords do not
645 Only non-default values are saved to the lyx files. The defaults of the remaining
655 BoundingBox <from file>
658 rotateOrigin centerBaseline
660 subcaptionText <empty>
663 The remaining keywords have sufficient overlap with the old ones for a
664 smooth reading of the 1.2.x inset keywords in most common cases.
666 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
667 They don't exist anymore and we can't translate them into a scaling value, while
668 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
669 argument is ignored and lost.
671 Only few compatibility issues are left for lyx2lyx:
673 ------------------------------------------------------------------------------
674 old-token new-token remove
675 ------------------------------------------------------------------------------
676 size_kind original / size_type 0 scale 100 width <val>
680 size_kind width_height / size_type 1 - scale <val>
682 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
683 ------------------------------------------------------------------------------
684 [replace old-token by new-token, and remove any of subsequent tokens as listed]
686 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
687 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
689 replace "rotateAngle <val>" by "rotateAngle 0"
692 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
694 Added \lyxlock for locked math inset when written to .lyx file.
695 When "downgrading" .lyx files this should simple be deleted but it
696 does not hurt at all if it stays in. It does not have to be added
700 2002-08-02 Angus Leeming <leeming@lyx.org>
702 Added a boolean "preview" flag to InsetCommandParams.
703 Currently it is written only by InsetInclude, because only this
704 class can generate a preview of its contents.
706 The LyX file now contains:
708 \begin_inset Include \input{snapshot_t=40.tex}
713 Earlier versions of LyX just swallow this extra token silently.
715 2002-08-12 Angus Leeming <leeming@lyx.org>
717 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
718 renamed as "size_kind" and "lyxsize_kind" respectively.
720 \begin_inset Graphics FormatVersion 1
727 - lyxsize_kind original
728 + lyxsize_type original