1 LyX file-format changes
2 -----------------------§
6 * format incremented to 258: new \lyxline definition
8 \\newcommand{\\lyxline}[1]{
9 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
12 \\newcommand{\\lyxline}[1][1pt]{%
14 \\rule[.5ex]{\\linewidth}{#1}\\par}
15 The new definition is more robust, see bug 1988 and now really takes care about
16 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
18 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
20 * format incremented to 257: Caption styles have been replaced by
21 InsetCaption. This is at the same time also a layout file format
22 change to format 3. layout2layout removes caption layouts from old
24 Note that InsetCaption did exist before this format, but was never
25 used. Old files containing do nevertheless still work.
26 Of course users can still define a Caption style in layout files,
27 but the special treatment in LyX is gone (apart from the sensitive
30 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
32 * format incremented to 256: allow some new inputenc settings.
33 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
35 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
37 * format incremented to 255: new insets for \clearpage and
38 \cleardoublepage. They are written inline to the file, exactly like
41 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
43 * format incremented to 254: new header parameter \use_esint.
44 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
47 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
49 * format incremented to 253: new nomenclature and printnomenclature
50 insets. These are standard InsetCommand with the following parameters:
51 \nomenclature[prefix]{symbol}{description}
52 \printnomenclature[labelwidth]
54 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
56 * format incremented to 252: changed command inset syntax
60 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
71 \begin_inset LatexCommand cmdname
78 The order of the parameters and for each parameter the name and
79 optional/required bit is now stored in InsetCommandParams.
81 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
83 * format incremented to 251: save show_label param for charstyles.
85 On revert, the show_label param is just removed. Nothing to convert.
87 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
89 * Format incremented to 250: allow optional arg to environments
91 No material format change. Now optargs for environments are allowed
92 to be specified in layout files and will be handled properly. When
93 converted back to older formats, they will be ignored in LaTeX
96 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
98 * format incremented to 249: Unicode
100 LyX documents are now always encoded in utf8. The value of
101 \inputencoding does now only determine the encoding of the created
103 Up to format 248 the value of \inputencoding did also determine the
104 encoding of the LyX file:
106 \inputencoding LyX file encoding
107 auto as determined by the document and character
110 everything else as determined by \inputencoding
112 The difference between auto and default is only the LaTeX output:
113 auto causes loading of the inputenc package, default does not.
115 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
117 * format incremented to 248: Basic booktabs support
119 The <features> tag has a new switch: booktabs="true|false".
120 An absent switch is equivalent to booktabs="false".
121 Horizontal lines are set with the booktabs package if this switch
124 The <row> tag of tabulars has the following new attributes:
125 topspace, bottomspace and interlinespace. All take a LyXLength
126 as value, or the special keyword "default".
128 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
130 * format incremented to 247. The Grand Font Interface Rewrite.
131 (1) Split font selection to rm, sf, tt:
132 \fontscheme -> \font_roman, \font_sans, \font_typewriter
134 \fontscheme \font_roman \font_sans \font_typewriter
135 default default default default
136 ae ae default default
137 times times default default
138 palatino palatino default default
139 helvet default helvet default
140 avant default avant default
141 newcent newcent default default
142 bookman bookman default default
143 pslatex times (or \usepackage{pslatex})
145 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
146 lmodern, charter, utopia, ccfonts, chancery, beraserif
147 (-> \usepackage{<name>})
148 \font_sans: cmss, lmss, cmbr
149 (-> \renewcommand{\sfdefault}{<name>})
150 berasans (-> \usepackage{<name>})
151 \font_typewriter: cmtt, lmtt, cmtl,
152 (-> \renewcommand{\sfdefault}{<name>})
153 courier, luximono, beramono
154 (-> \usepackage{<name>})
155 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
156 (3) New param \font_sc (true, false).
157 (4) New param \font_osf (true, false).
158 (5) New param \font_sf_scale (float)
159 (6) New param \font_tt_scale (float)
160 Support for the following fonts has been added:
161 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
162 courier, lmodern, luximono, utopia.
163 Support for the following font has been removed:
164 pslatex (it's superseded by mathptmx (times)).
166 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
168 * format incremented to 246. The framed.sty package is
169 now supported with note types framed and shaded.
171 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
173 * format incremented to 245. The \quotes_times parameter
176 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
178 * format incremented to 244. Rename '\InsetSpace \,'
179 to '\InsetSpace \thinspace{}', because the comma was
180 not parsed by lyxlex, and '\InsetSpace \space' to
181 '\InsetSpace \space{}' in favour of consistency.
183 2005-07-18 José Matos <jamatos@lyx.org>
185 * format incremented to 243.
187 * this change only affects the preamble, the paperpackage
188 option was removed and papersize is changed to default.
190 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
192 * format incremented to 242. There is no file format per
193 se, but the "frenchb" language has been removed from lib/language
194 and has to be translated to "french" by lyx2lyx.
196 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
198 * format incremented to 241.
200 All following changes apply only to text in ERT insets. The
201 rationale is that text in ERT is simply ASCII text, and nothing more.
203 * paragraph breaks are now a single newline in latex and not a
204 paragraph break anymore (bug 698).
205 * \newline is not allowed anymore, because it is redundant (see above)
206 * layouts other than Standard, paragraph parameters and font changes
207 are not allowed anymore. They never made sense and were ignored for
208 latex output, but now they can't be read or set anymore (bug 922).
211 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
213 * format incremented to 240.
215 \output_changes {true|false}
216 (should the change tracking marks be visible in the output or not?)
217 * lyx2lyx should just delete the param in 239.
219 2005-01-06 José Matos <jamatos@lyx.org>
221 * format incremented to 239.
222 * the paragraph parameters are displayed in their own line. This
223 change is consistent with the insets behaviour, and corresponds
224 to a more uniform treatment of the paragraphs since some of them
225 had already their own line.
227 An example of a single paragraph follows:
229 \begin_layout Standard
230 \paragraph_spacing single
236 2004-12-03 José Matos <jamatos@lyx.org>
238 * format incremented to 238.
239 * The compatibility code to read old latex accents from 0.12.x in
240 InsetLatexAccent::checkContents has been removed.
241 The following translations are done:
243 "\i \xy" -> "\i \x{y}"
244 "\i \x y" -> "\i \x{y}"
245 "\i \x\i" -> "\i \x{\i}"
246 "\i \x\j" -> "\i \x{\j}"
247 x is a latex accent command, y the base character. \, i and j are
249 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
250 so formats 215 - 237 can have both versions.
253 2004-10-10 José Matos <jamatos@lyx.org>
255 * format incremented to 237.
256 * In the header, the following statments use now booleans values,
262 2004-08-15 José Matos <jamatos@lyx.org>
264 * format incremented to 236.
271 * The options for \papersize are changed:
274 * All whitespaces are removed at the end of lines, when
275 not necessary. As an example we have all the lines in the header that
276 do not belong to the preamble.
278 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
280 * format incremented to 235.
281 * \paperpackage had an off-by-one error. Translation table:
283 234: a4 a4wide widemarginsa4
284 235: none a4 a4wide widemarginsa4
286 The "widemarginsa4" setting of 235 has no equivalent in 234.
288 2004-05-12 Angus Leeming <leeming@lyx.org>
290 * format incremented to 234.
291 * the citation engine is specified explicitly rather than being
292 deduced from 3 bools.
295 \use_numerical_citations 0 -> \cite_engine <style>
298 where <style> is one of "basic", "natbib_authoryear",
299 "natbib_numerical" or "jurabib".
301 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
303 * format incremented to 233.
304 * insetgraphics does not allow filenames without extension anymore.
305 The complete filename has to be given.
307 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
309 * format incremented to 232.
311 * Support for bibtopic (sectioned bibliographies).
312 - bufferparam \use_bibtopic [1|0]
313 - the bibtex inset has a second argument for bibtopic's
314 btPrint{Cited|NotCited|All} command:
316 \begin_inset LatexCommand \bibtex[<style>]{<database>}
318 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
319 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
320 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
321 \bibliographystyle{<style>}
322 \begin{btSect}{<database>}
327 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
329 * format incremented to 231.
331 * Support for sidewaysfigure/sidewaystable (rotating package).
332 insetfloat has now a param \sideways [true|false] (default is false).
333 The param should be erased on downwards conversion, if it was true,
334 the inset should be replaced by
335 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
337 \begin{sidewaystable} <content> \end{sidewaystable}
340 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
342 * format incremented to 230.
344 * Support for a second optional argument in insetcommand.
345 currently, citation uses this to support natbibs second
346 optional argument \cite[before][after]{key}.
347 I think there's nothing to convert upwards. Downwards, the
348 commands with 2 optional args need to be converted to ERT.
350 * Support for jurabib (param \use_jurabib [1|0], default is 0).
351 When converting downwards, \usepackage{jurabib} has to be added
352 to the preamble and, if babel is used, \usepackage{babel} before
353 (jurabib fails if babel is called afterwards). If the natbib commands
354 are used together with jurabib, they have to be converted to ERT too.
356 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
358 * format incremented to 229.
359 * Minipages cannot be read anymore. All minipage insets will
360 be converted to frameless box insets between 228->229.
362 2003-12-15 Angus Leeming <leeming@lyx.org>
364 * format incremented to 228.
365 * Change the output of all insets derived from InsetCollapsable
366 except for InsetERT (which has a similar output already), changing lines
367 "collapsed true" -> "status collapsed"
368 "collapsed false" -> "status open".
369 * Change the output of InsetERT, changing lines
370 "status Collapsed" -> "status collapsed"
371 "status Open" -> "status open".
372 "status Inlined" -> "status inlined".
374 2003-12-10 Angus Leeming <leeming@lyx.org>
376 * format NOT incremented.
377 * add a 'draft' option to InsetExternal.
379 2003-12-10 Angus Leeming <leeming@lyx.org>
381 * format incremented to 227.
382 * Change the output of InsetBox:
383 \begin_inset Boxed -> \begin_inset Box Boxed
384 \begin_inset Doublebox -> \begin_inset Box Doublebox
385 \begin_inset Frameless -> \begin_inset Box Frameless
386 \begin_inset ovalbox -> \begin_inset Box ovalbox
387 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
388 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
390 2003-12-10 Angus Leeming <leeming@lyx.org>
392 * format incremented to 226.
393 * Change the output of InsetNote:
394 \begin_inset Note -> \begin_inset Note Note
395 \begin_inset Comment -> \begin_inset Note Comment
396 \begin_inset Greyedout -> \begin_inset Note Greyedout
398 2003-11-28 André Pönitz
400 * Remove space_above/space_below from Paragraph.
401 This is now handled by InsetVSpace.
403 2003-10-07 Angus Leeming <leeming@lyx.org>
405 * Add transformations to InsetExternal
407 boundingBox 0 0 20 20 the dimensions of the B.B..
408 Output if the B.B. is not empty.
409 clip clip the image to the B.B.
411 extra LaTeX "draft" 'extra' data passed to the primary
412 command for this output format.
413 (Possible formats LaTeX, PDFLaTeX,
414 LinuxDoc, DocBook, Ascii.)
415 The string can contain spaces and so
417 rotateAngle 30 Rotation of the data.
418 Output for non-zero rotation only.
419 rotateOrigin bottomleft Rotation origin.
420 Output for non-zero rotation and
421 non-default origin (center) only.
423 width 2cm Output only if the image is resized.
427 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
429 * Added box inset. File format:
431 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
436 inner_pos "b" t/c/b/s
438 width "100col%" unit+width-string
439 special "none" none/height/depth
441 height "1in" unit+width-string
442 height_special "totalheight" none/height/depth
444 collapsed false true/false
446 \begin_layout Standard
453 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
454 the pre-existing Minipage inset. Parameters translate as follows:
455 position 0/1/2 -> t/c/b
456 inner_position 0/1/2/3 -> inner_pos c/t/b/s
461 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
463 * attribute valignment="center" is replaced by valignment="middle"
464 for tabular columns and cells
466 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
468 * Added branch inset. File format:
470 branch definition in the header:
476 \begin_inset Branch <branchname>
477 collapsed false true/false
479 \begin_layout Standard
486 2003-07-28 José Matos <jamatos@lyx.org>
488 * \the_end is replaced with \end_document
490 2003-07-28 José Matos <jamatos@lyx.org>
492 * \layout is replaced with \begin_layout
494 2003-07-28 José Matos <jamatos@fep.up.pt>
498 * All layouts finish now with \end_layout
500 2003-06-04 Angus Leeming <leeming@lyx.org>
504 * the storage of the external inset has been changed from
506 \begin_inset External XFig,"file.fig",""
512 \begin_inset External
515 display <display_type>
520 throwing away the final arg (here "", more generally "<string>") that holds
521 the parameters variable.
522 Variables are output if present (filename) or different from the default
523 values (display, lyxscale).
525 Moreover, the RasterImage template has been scrapped. All RasterImage
526 external insets are now converted to Graphics insets.
528 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
530 * Added new space insets:
531 \SpecialChar ~ is now \InsetSpace ~
532 ERT: "\ " could be converted to InsetSpace \<space>
533 ERT: "\," could be converted to InsetSpace \,
535 2003-04-24 André Pönitz <poenitz@gmx.net>
537 * Added eqref support:
538 \begin_inset LatexCommand \eqref{label}
540 2003-03-14 Dekel Tsur
542 * Format bumped to 223.
544 2003-03-12 John Levon <levon@movementarian.org>
546 * Added \\end_header to signify the end of the header in a
549 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
551 2003-02-10 John Levon <levon@movementarian.org>
555 Added \\tracking_changes 0|1 to the header.
557 Added \\author to the header. This can be present multiple
558 times, and is of the form :
560 \\author "Real Name" email@address.com
562 Added \\change_deleted, \\change_inserted. Each of these does not
563 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
566 \\change_inserted author time
568 where author is an integer ID reference into the author list in
569 the header, and time is time_t.
571 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
573 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
575 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
577 New graphics dialog. With the removal of buttons in the dialog, also
578 keywords in the graphics inset went. The following keywords do not
588 Only non-default values are saved to the lyx files. The defaults of the remaining
598 BoundingBox <from file>
601 rotateOrigin centerBaseline
603 subcaptionText <empty>
606 The remaining keywords have sufficient overlap with the old ones for a
607 smooth reading of the 1.2.x inset keywords in most common cases.
609 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
610 They don't exist anymore and we can't translate them into a scaling value, while
611 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
612 argument is ignored and lost.
614 Only few compatibility issues are left for lyx2lyx:
616 ------------------------------------------------------------------------------
617 old-token new-token remove
618 ------------------------------------------------------------------------------
619 size_kind original / size_type 0 scale 100 width <val>
623 size_kind width_height / size_type 1 - scale <val>
625 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
626 ------------------------------------------------------------------------------
627 [replace old-token by new-token, and remove any of subsequent tokens as listed]
629 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
630 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
632 replace "rotateAngle <val>" by "rotateAngle 0"
635 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
637 Added \lyxlock for locked math inset when written to .lyx file.
638 When "downgrading" .lyx files this should simple be deleted but it
639 does not hurt at all if it stays in. It does not have to be added
643 2002-08-02 Angus Leeming <leeming@lyx.org>
645 Added a boolean "preview" flag to InsetCommandParams.
646 Currently it is written only by InsetInclude, because only this
647 class can generate a preview of its contents.
649 The LyX file now contains:
651 \begin_inset Include \input{snapshot_t=40.tex}
656 Earlier versions of LyX just swallow this extra token silently.
658 2002-08-12 Angus Leeming <leeming@lyx.org>
660 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
661 renamed as "size_kind" and "lyxsize_kind" respectively.
663 \begin_inset Graphics FormatVersion 1
670 - lyxsize_kind original
671 + lyxsize_type original