1 LyX file-format changes
2 -----------------------§
4 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 259:
7 Old: Spaces at start or end of font changes were output outside of
8 the font change, i.e. not 'xx\textbf{ yy }zz', but
10 New: Spaces are always output with the font set by the user.
14 * format incremented to 258: new \lyxline definition
16 \\newcommand{\\lyxline}[1]{
17 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
20 \\newcommand{\\lyxline}[1][1pt]{%
22 \\rule[.5ex]{\\linewidth}{#1}\\par}
23 The new definition is more robust, see bug 1988 and now really takes care about
24 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
26 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
28 * format incremented to 257: Caption styles have been replaced by
29 InsetCaption. This is at the same time also a layout file format
30 change to format 3. layout2layout removes caption layouts from old
32 Note that InsetCaption did exist before this format, but was never
33 used. Old files containing do nevertheless still work.
34 Of course users can still define a Caption style in layout files,
35 but the special treatment in LyX is gone (apart from the sensitive
38 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
40 * format incremented to 256: allow some new inputenc settings.
41 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
43 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
45 * format incremented to 255: new insets for \clearpage and
46 \cleardoublepage. They are written inline to the file, exactly like
49 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
51 * format incremented to 254: new header parameter \use_esint.
52 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
55 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
57 * format incremented to 253: new nomenclature and printnomenclature
58 insets. These are standard InsetCommand with the following parameters:
59 \nomenclature[prefix]{symbol}{description}
60 \printnomenclature[labelwidth]
62 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
64 * format incremented to 252: changed command inset syntax
68 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
79 \begin_inset LatexCommand cmdname
86 The order of the parameters and for each parameter the name and
87 optional/required bit is now stored in InsetCommandParams.
89 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
91 * format incremented to 251: save show_label param for charstyles.
93 On revert, the show_label param is just removed. Nothing to convert.
95 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
97 * Format incremented to 250: allow optional arg to environments
99 No material format change. Now optargs for environments are allowed
100 to be specified in layout files and will be handled properly. When
101 converted back to older formats, they will be ignored in LaTeX
104 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
106 * format incremented to 249: Unicode
108 LyX documents are now always encoded in utf8. The value of
109 \inputencoding does now only determine the encoding of the created
111 Up to format 248 the value of \inputencoding did also determine the
112 encoding of the LyX file:
114 \inputencoding LyX file encoding
115 auto as determined by the document and character
118 everything else as determined by \inputencoding
120 The difference between auto and default is only the LaTeX output:
121 auto causes loading of the inputenc package, default does not.
123 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
125 * format incremented to 248: Basic booktabs support
127 The <features> tag has a new switch: booktabs="true|false".
128 An absent switch is equivalent to booktabs="false".
129 Horizontal lines are set with the booktabs package if this switch
132 The <row> tag of tabulars has the following new attributes:
133 topspace, bottomspace and interlinespace. All take a LyXLength
134 as value, or the special keyword "default".
136 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
138 * format incremented to 247. The Grand Font Interface Rewrite.
139 (1) Split font selection to rm, sf, tt:
140 \fontscheme -> \font_roman, \font_sans, \font_typewriter
142 \fontscheme \font_roman \font_sans \font_typewriter
143 default default default default
144 ae ae default default
145 times times default default
146 palatino palatino default default
147 helvet default helvet default
148 avant default avant default
149 newcent newcent default default
150 bookman bookman default default
151 pslatex times (or \usepackage{pslatex})
153 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
154 lmodern, charter, utopia, ccfonts, chancery, beraserif
155 (-> \usepackage{<name>})
156 \font_sans: cmss, lmss, cmbr
157 (-> \renewcommand{\sfdefault}{<name>})
158 berasans (-> \usepackage{<name>})
159 \font_typewriter: cmtt, lmtt, cmtl,
160 (-> \renewcommand{\sfdefault}{<name>})
161 courier, luximono, beramono
162 (-> \usepackage{<name>})
163 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
164 (3) New param \font_sc (true, false).
165 (4) New param \font_osf (true, false).
166 (5) New param \font_sf_scale (float)
167 (6) New param \font_tt_scale (float)
168 Support for the following fonts has been added:
169 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
170 courier, lmodern, luximono, utopia.
171 Support for the following font has been removed:
172 pslatex (it's superseded by mathptmx (times)).
174 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
176 * format incremented to 246. The framed.sty package is
177 now supported with note types framed and shaded.
179 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
181 * format incremented to 245. The \quotes_times parameter
184 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
186 * format incremented to 244. Rename '\InsetSpace \,'
187 to '\InsetSpace \thinspace{}', because the comma was
188 not parsed by lyxlex, and '\InsetSpace \space' to
189 '\InsetSpace \space{}' in favour of consistency.
191 2005-07-18 José Matos <jamatos@lyx.org>
193 * format incremented to 243.
195 * this change only affects the preamble, the paperpackage
196 option was removed and papersize is changed to default.
198 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
200 * format incremented to 242. There is no file format per
201 se, but the "frenchb" language has been removed from lib/language
202 and has to be translated to "french" by lyx2lyx.
204 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
206 * format incremented to 241.
208 All following changes apply only to text in ERT insets. The
209 rationale is that text in ERT is simply ASCII text, and nothing more.
211 * paragraph breaks are now a single newline in latex and not a
212 paragraph break anymore (bug 698).
213 * \newline is not allowed anymore, because it is redundant (see above)
214 * layouts other than Standard, paragraph parameters and font changes
215 are not allowed anymore. They never made sense and were ignored for
216 latex output, but now they can't be read or set anymore (bug 922).
219 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
221 * format incremented to 240.
223 \output_changes {true|false}
224 (should the change tracking marks be visible in the output or not?)
225 * lyx2lyx should just delete the param in 239.
227 2005-01-06 José Matos <jamatos@lyx.org>
229 * format incremented to 239.
230 * the paragraph parameters are displayed in their own line. This
231 change is consistent with the insets behaviour, and corresponds
232 to a more uniform treatment of the paragraphs since some of them
233 had already their own line.
235 An example of a single paragraph follows:
237 \begin_layout Standard
238 \paragraph_spacing single
244 2004-12-03 José Matos <jamatos@lyx.org>
246 * format incremented to 238.
247 * The compatibility code to read old latex accents from 0.12.x in
248 InsetLatexAccent::checkContents has been removed.
249 The following translations are done:
251 "\i \xy" -> "\i \x{y}"
252 "\i \x y" -> "\i \x{y}"
253 "\i \x\i" -> "\i \x{\i}"
254 "\i \x\j" -> "\i \x{\j}"
255 x is a latex accent command, y the base character. \, i and j are
257 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
258 so formats 215 - 237 can have both versions.
261 2004-10-10 José Matos <jamatos@lyx.org>
263 * format incremented to 237.
264 * In the header, the following statments use now booleans values,
270 2004-08-15 José Matos <jamatos@lyx.org>
272 * format incremented to 236.
279 * The options for \papersize are changed:
282 * All whitespaces are removed at the end of lines, when
283 not necessary. As an example we have all the lines in the header that
284 do not belong to the preamble.
286 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
288 * format incremented to 235.
289 * \paperpackage had an off-by-one error. Translation table:
291 234: a4 a4wide widemarginsa4
292 235: none a4 a4wide widemarginsa4
294 The "widemarginsa4" setting of 235 has no equivalent in 234.
296 2004-05-12 Angus Leeming <leeming@lyx.org>
298 * format incremented to 234.
299 * the citation engine is specified explicitly rather than being
300 deduced from 3 bools.
303 \use_numerical_citations 0 -> \cite_engine <style>
306 where <style> is one of "basic", "natbib_authoryear",
307 "natbib_numerical" or "jurabib".
309 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
311 * format incremented to 233.
312 * insetgraphics does not allow filenames without extension anymore.
313 The complete filename has to be given.
315 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
317 * format incremented to 232.
319 * Support for bibtopic (sectioned bibliographies).
320 - bufferparam \use_bibtopic [1|0]
321 - the bibtex inset has a second argument for bibtopic's
322 btPrint{Cited|NotCited|All} command:
324 \begin_inset LatexCommand \bibtex[<style>]{<database>}
326 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
327 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
328 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
329 \bibliographystyle{<style>}
330 \begin{btSect}{<database>}
335 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
337 * format incremented to 231.
339 * Support for sidewaysfigure/sidewaystable (rotating package).
340 insetfloat has now a param \sideways [true|false] (default is false).
341 The param should be erased on downwards conversion, if it was true,
342 the inset should be replaced by
343 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
345 \begin{sidewaystable} <content> \end{sidewaystable}
348 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
350 * format incremented to 230.
352 * Support for a second optional argument in insetcommand.
353 currently, citation uses this to support natbibs second
354 optional argument \cite[before][after]{key}.
355 I think there's nothing to convert upwards. Downwards, the
356 commands with 2 optional args need to be converted to ERT.
358 * Support for jurabib (param \use_jurabib [1|0], default is 0).
359 When converting downwards, \usepackage{jurabib} has to be added
360 to the preamble and, if babel is used, \usepackage{babel} before
361 (jurabib fails if babel is called afterwards). If the natbib commands
362 are used together with jurabib, they have to be converted to ERT too.
364 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
366 * format incremented to 229.
367 * Minipages cannot be read anymore. All minipage insets will
368 be converted to frameless box insets between 228->229.
370 2003-12-15 Angus Leeming <leeming@lyx.org>
372 * format incremented to 228.
373 * Change the output of all insets derived from InsetCollapsable
374 except for InsetERT (which has a similar output already), changing lines
375 "collapsed true" -> "status collapsed"
376 "collapsed false" -> "status open".
377 * Change the output of InsetERT, changing lines
378 "status Collapsed" -> "status collapsed"
379 "status Open" -> "status open".
380 "status Inlined" -> "status inlined".
382 2003-12-10 Angus Leeming <leeming@lyx.org>
384 * format NOT incremented.
385 * add a 'draft' option to InsetExternal.
387 2003-12-10 Angus Leeming <leeming@lyx.org>
389 * format incremented to 227.
390 * Change the output of InsetBox:
391 \begin_inset Boxed -> \begin_inset Box Boxed
392 \begin_inset Doublebox -> \begin_inset Box Doublebox
393 \begin_inset Frameless -> \begin_inset Box Frameless
394 \begin_inset ovalbox -> \begin_inset Box ovalbox
395 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
396 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
398 2003-12-10 Angus Leeming <leeming@lyx.org>
400 * format incremented to 226.
401 * Change the output of InsetNote:
402 \begin_inset Note -> \begin_inset Note Note
403 \begin_inset Comment -> \begin_inset Note Comment
404 \begin_inset Greyedout -> \begin_inset Note Greyedout
406 2003-11-28 André Pönitz
408 * Remove space_above/space_below from Paragraph.
409 This is now handled by InsetVSpace.
411 2003-10-07 Angus Leeming <leeming@lyx.org>
413 * Add transformations to InsetExternal
415 boundingBox 0 0 20 20 the dimensions of the B.B..
416 Output if the B.B. is not empty.
417 clip clip the image to the B.B.
419 extra LaTeX "draft" 'extra' data passed to the primary
420 command for this output format.
421 (Possible formats LaTeX, PDFLaTeX,
422 LinuxDoc, DocBook, Ascii.)
423 The string can contain spaces and so
425 rotateAngle 30 Rotation of the data.
426 Output for non-zero rotation only.
427 rotateOrigin bottomleft Rotation origin.
428 Output for non-zero rotation and
429 non-default origin (center) only.
431 width 2cm Output only if the image is resized.
435 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
437 * Added box inset. File format:
439 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
444 inner_pos "b" t/c/b/s
446 width "100col%" unit+width-string
447 special "none" none/height/depth
449 height "1in" unit+width-string
450 height_special "totalheight" none/height/depth
452 collapsed false true/false
454 \begin_layout Standard
461 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
462 the pre-existing Minipage inset. Parameters translate as follows:
463 position 0/1/2 -> t/c/b
464 inner_position 0/1/2/3 -> inner_pos c/t/b/s
469 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
471 * attribute valignment="center" is replaced by valignment="middle"
472 for tabular columns and cells
474 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
476 * Added branch inset. File format:
478 branch definition in the header:
484 \begin_inset Branch <branchname>
485 collapsed false true/false
487 \begin_layout Standard
494 2003-07-28 José Matos <jamatos@lyx.org>
496 * \the_end is replaced with \end_document
498 2003-07-28 José Matos <jamatos@lyx.org>
500 * \layout is replaced with \begin_layout
502 2003-07-28 José Matos <jamatos@fep.up.pt>
506 * All layouts finish now with \end_layout
508 2003-06-04 Angus Leeming <leeming@lyx.org>
512 * the storage of the external inset has been changed from
514 \begin_inset External XFig,"file.fig",""
520 \begin_inset External
523 display <display_type>
528 throwing away the final arg (here "", more generally "<string>") that holds
529 the parameters variable.
530 Variables are output if present (filename) or different from the default
531 values (display, lyxscale).
533 Moreover, the RasterImage template has been scrapped. All RasterImage
534 external insets are now converted to Graphics insets.
536 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
538 * Added new space insets:
539 \SpecialChar ~ is now \InsetSpace ~
540 ERT: "\ " could be converted to InsetSpace \<space>
541 ERT: "\," could be converted to InsetSpace \,
543 2003-04-24 André Pönitz <poenitz@gmx.net>
545 * Added eqref support:
546 \begin_inset LatexCommand \eqref{label}
548 2003-03-14 Dekel Tsur
550 * Format bumped to 223.
552 2003-03-12 John Levon <levon@movementarian.org>
554 * Added \\end_header to signify the end of the header in a
557 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
559 2003-02-10 John Levon <levon@movementarian.org>
563 Added \\tracking_changes 0|1 to the header.
565 Added \\author to the header. This can be present multiple
566 times, and is of the form :
568 \\author "Real Name" email@address.com
570 Added \\change_deleted, \\change_inserted. Each of these does not
571 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
574 \\change_inserted author time
576 where author is an integer ID reference into the author list in
577 the header, and time is time_t.
579 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
581 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
583 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
585 New graphics dialog. With the removal of buttons in the dialog, also
586 keywords in the graphics inset went. The following keywords do not
596 Only non-default values are saved to the lyx files. The defaults of the remaining
606 BoundingBox <from file>
609 rotateOrigin centerBaseline
611 subcaptionText <empty>
614 The remaining keywords have sufficient overlap with the old ones for a
615 smooth reading of the 1.2.x inset keywords in most common cases.
617 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
618 They don't exist anymore and we can't translate them into a scaling value, while
619 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
620 argument is ignored and lost.
622 Only few compatibility issues are left for lyx2lyx:
624 ------------------------------------------------------------------------------
625 old-token new-token remove
626 ------------------------------------------------------------------------------
627 size_kind original / size_type 0 scale 100 width <val>
631 size_kind width_height / size_type 1 - scale <val>
633 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
634 ------------------------------------------------------------------------------
635 [replace old-token by new-token, and remove any of subsequent tokens as listed]
637 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
638 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
640 replace "rotateAngle <val>" by "rotateAngle 0"
643 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
645 Added \lyxlock for locked math inset when written to .lyx file.
646 When "downgrading" .lyx files this should simple be deleted but it
647 does not hurt at all if it stays in. It does not have to be added
651 2002-08-02 Angus Leeming <leeming@lyx.org>
653 Added a boolean "preview" flag to InsetCommandParams.
654 Currently it is written only by InsetInclude, because only this
655 class can generate a preview of its contents.
657 The LyX file now contains:
659 \begin_inset Include \input{snapshot_t=40.tex}
664 Earlier versions of LyX just swallow this extra token silently.
666 2002-08-12 Angus Leeming <leeming@lyx.org>
668 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
669 renamed as "size_kind" and "lyxsize_kind" respectively.
671 \begin_inset Graphics FormatVersion 1
678 - lyxsize_kind original
679 + lyxsize_type original