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 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
20 * format incremented to 256: allow some new inputenc settings.
21 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
23 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
25 * format incremented to 255: new insets for \clearpage and
26 \cleardoublepage. They are written inline to the file, exactly like
29 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
31 * format incremented to 254: new header parameter \use_esint.
32 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
35 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
37 * format incremented to 253: new nomenclature and printnomenclature
38 insets. These are standard InsetCommand with the following parameters:
39 \nomenclature[prefix]{symbol}{description}
40 \printnomenclature[labelwidth]
42 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
44 * format incremented to 252: changed command inset syntax
48 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
59 \begin_inset LatexCommand cmdname
66 The order of the parameters and for each parameter the name and
67 optional/required bit is now stored in InsetCommandParams.
69 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
71 * format incremented to 251: save show_label param for charstyles.
73 On revert, the show_label param is just removed. Nothing to convert.
75 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
77 * Format incremented to 250: allow optional arg to environments
79 No material format change. Now optargs for environments are allowed
80 to be specified in layout files and will be handled properly. When
81 converted back to older formats, they will be ignored in LaTeX
84 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
86 * format incremented to 249: Unicode
88 LyX documents are now always encoded in utf8. The value of
89 \inputencoding does now only determine the encoding of the created
91 Up to format 248 the value of \inputencoding did also determine the
92 encoding of the LyX file:
94 \inputencoding LyX file encoding
95 auto as determined by the document and character
98 everything else as determined by \inputencoding
100 The difference between auto and default is only the LaTeX output:
101 auto causes loading of the inputenc package, default does not.
103 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
105 * format incremented to 248: Basic booktabs support
107 The <features> tag has a new switch: booktabs="true|false".
108 An absent switch is equivalent to booktabs="false".
109 Horizontal lines are set with the booktabs package if this switch
112 The <row> tag of tabulars has the following new attributes:
113 topspace, bottomspace and interlinespace. All take a LyXLength
114 as value, or the special keyword "default".
116 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
118 * format incremented to 247. The Grand Font Interface Rewrite.
119 (1) Split font selection to rm, sf, tt:
120 \fontscheme -> \font_roman, \font_sans, \font_typewriter
122 \fontscheme \font_roman \font_sans \font_typewriter
123 default default default default
124 ae ae default default
125 times times default default
126 palatino palatino default default
127 helvet default helvet default
128 avant default avant default
129 newcent newcent default default
130 bookman bookman default default
131 pslatex times (or \usepackage{pslatex})
133 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
134 lmodern, charter, utopia, ccfonts, chancery, beraserif
135 (-> \usepackage{<name>})
136 \font_sans: cmss, lmss, cmbr
137 (-> \renewcommand{\sfdefault}{<name>})
138 berasans (-> \usepackage{<name>})
139 \font_typewriter: cmtt, lmtt, cmtl,
140 (-> \renewcommand{\sfdefault}{<name>})
141 courier, luximono, beramono
142 (-> \usepackage{<name>})
143 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
144 (3) New param \font_sc (true, false).
145 (4) New param \font_osf (true, false).
146 (5) New param \font_sf_scale (float)
147 (6) New param \font_tt_scale (float)
148 Support for the following fonts has been added:
149 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
150 courier, lmodern, luximono, utopia.
151 Support for the following font has been removed:
152 pslatex (it's superseded by mathptmx (times)).
154 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
156 * format incremented to 246. The framed.sty package is
157 now supported with note types framed and shaded.
159 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
161 * format incremented to 245. The \quotes_times parameter
164 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
166 * format incremented to 244. Rename '\InsetSpace \,'
167 to '\InsetSpace \thinspace{}', because the comma was
168 not parsed by lyxlex, and '\InsetSpace \space' to
169 '\InsetSpace \space{}' in favour of consistency.
171 2005-07-18 José Matos <jamatos@lyx.org>
173 * format incremented to 243.
175 * this change only affects the preamble, the paperpackage
176 option was removed and papersize is changed to default.
178 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
180 * format incremented to 242. There is no file format per
181 se, but the "frenchb" language has been removed from lib/language
182 and has to be translated to "french" by lyx2lyx.
184 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
186 * format incremented to 241.
188 All following changes apply only to text in ERT insets. The
189 rationale is that text in ERT is simply ASCII text, and nothing more.
191 * paragraph breaks are now a single newline in latex and not a
192 paragraph break anymore (bug 698).
193 * \newline is not allowed anymore, because it is redundant (see above)
194 * layouts other than Standard, paragraph parameters and font changes
195 are not allowed anymore. They never made sense and were ignored for
196 latex output, but now they can't be read or set anymore (bug 922).
199 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
201 * format incremented to 240.
203 \output_changes {true|false}
204 (should the change tracking marks be visible in the output or not?)
205 * lyx2lyx should just delete the param in 239.
207 2005-01-06 José Matos <jamatos@lyx.org>
209 * format incremented to 239.
210 * the paragraph parameters are displayed in their own line. This
211 change is consistent with the insets behaviour, and corresponds
212 to a more uniform treatment of the paragraphs since some of them
213 had already their own line.
215 An example of a single paragraph follows:
217 \begin_layout Standard
218 \paragraph_spacing single
224 2004-12-03 José Matos <jamatos@lyx.org>
226 * format incremented to 238.
227 * The compatibility code to read old latex accents from 0.12.x in
228 InsetLatexAccent::checkContents has been removed.
229 The following translations are done:
231 "\i \xy" -> "\i \x{y}"
232 "\i \x y" -> "\i \x{y}"
233 "\i \x\i" -> "\i \x{\i}"
234 "\i \x\j" -> "\i \x{\j}"
235 x is a latex accent command, y the base character. \, i and j are
237 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
238 so formats 215 - 237 can have both versions.
241 2004-10-10 José Matos <jamatos@lyx.org>
243 * format incremented to 237.
244 * In the header, the following statments use now booleans values,
250 2004-08-15 José Matos <jamatos@lyx.org>
252 * format incremented to 236.
259 * The options for \papersize are changed:
262 * All whitespaces are removed at the end of lines, when
263 not necessary. As an example we have all the lines in the header that
264 do not belong to the preamble.
266 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
268 * format incremented to 235.
269 * \paperpackage had an off-by-one error. Translation table:
271 234: a4 a4wide widemarginsa4
272 235: none a4 a4wide widemarginsa4
274 The "widemarginsa4" setting of 235 has no equivalent in 234.
276 2004-05-12 Angus Leeming <leeming@lyx.org>
278 * format incremented to 234.
279 * the citation engine is specified explicitly rather than being
280 deduced from 3 bools.
283 \use_numerical_citations 0 -> \cite_engine <style>
286 where <style> is one of "basic", "natbib_authoryear",
287 "natbib_numerical" or "jurabib".
289 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
291 * format incremented to 233.
292 * insetgraphics does not allow filenames without extension anymore.
293 The complete filename has to be given.
295 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
297 * format incremented to 232.
299 * Support for bibtopic (sectioned bibliographies).
300 - bufferparam \use_bibtopic [1|0]
301 - the bibtex inset has a second argument for bibtopic's
302 btPrint{Cited|NotCited|All} command:
304 \begin_inset LatexCommand \bibtex[<style>]{<database>}
306 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
307 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
308 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
309 \bibliographystyle{<style>}
310 \begin{btSect}{<database>}
315 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
317 * format incremented to 231.
319 * Support for sidewaysfigure/sidewaystable (rotating package).
320 insetfloat has now a param \sideways [true|false] (default is false).
321 The param should be erased on downwards conversion, if it was true,
322 the inset should be replaced by
323 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
325 \begin{sidewaystable} <content> \end{sidewaystable}
328 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
330 * format incremented to 230.
332 * Support for a second optional argument in insetcommand.
333 currently, citation uses this to support natbibs second
334 optional argument \cite[before][after]{key}.
335 I think there's nothing to convert upwards. Downwards, the
336 commands with 2 optional args need to be converted to ERT.
338 * Support for jurabib (param \use_jurabib [1|0], default is 0).
339 When converting downwards, \usepackage{jurabib} has to be added
340 to the preamble and, if babel is used, \usepackage{babel} before
341 (jurabib fails if babel is called afterwards). If the natbib commands
342 are used together with jurabib, they have to be converted to ERT too.
344 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
346 * format incremented to 229.
347 * Minipages cannot be read anymore. All minipage insets will
348 be converted to frameless box insets between 228->229.
350 2003-12-15 Angus Leeming <leeming@lyx.org>
352 * format incremented to 228.
353 * Change the output of all insets derived from InsetCollapsable
354 except for InsetERT (which has a similar output already), changing lines
355 "collapsed true" -> "status collapsed"
356 "collapsed false" -> "status open".
357 * Change the output of InsetERT, changing lines
358 "status Collapsed" -> "status collapsed"
359 "status Open" -> "status open".
360 "status Inlined" -> "status inlined".
362 2003-12-10 Angus Leeming <leeming@lyx.org>
364 * format NOT incremented.
365 * add a 'draft' option to InsetExternal.
367 2003-12-10 Angus Leeming <leeming@lyx.org>
369 * format incremented to 227.
370 * Change the output of InsetBox:
371 \begin_inset Boxed -> \begin_inset Box Boxed
372 \begin_inset Doublebox -> \begin_inset Box Doublebox
373 \begin_inset Frameless -> \begin_inset Box Frameless
374 \begin_inset ovalbox -> \begin_inset Box ovalbox
375 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
376 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
378 2003-12-10 Angus Leeming <leeming@lyx.org>
380 * format incremented to 226.
381 * Change the output of InsetNote:
382 \begin_inset Note -> \begin_inset Note Note
383 \begin_inset Comment -> \begin_inset Note Comment
384 \begin_inset Greyedout -> \begin_inset Note Greyedout
386 2003-11-28 André Pönitz
388 * Remove space_above/space_below from Paragraph.
389 This is now handled by InsetVSpace.
391 2003-10-07 Angus Leeming <leeming@lyx.org>
393 * Add transformations to InsetExternal
395 boundingBox 0 0 20 20 the dimensions of the B.B..
396 Output if the B.B. is not empty.
397 clip clip the image to the B.B.
399 extra LaTeX "draft" 'extra' data passed to the primary
400 command for this output format.
401 (Possible formats LaTeX, PDFLaTeX,
402 LinuxDoc, DocBook, Ascii.)
403 The string can contain spaces and so
405 rotateAngle 30 Rotation of the data.
406 Output for non-zero rotation only.
407 rotateOrigin bottomleft Rotation origin.
408 Output for non-zero rotation and
409 non-default origin (center) only.
411 width 2cm Output only if the image is resized.
415 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
417 * Added box inset. File format:
419 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
424 inner_pos "b" t/c/b/s
426 width "100col%" unit+width-string
427 special "none" none/height/depth
429 height "1in" unit+width-string
430 height_special "totalheight" none/height/depth
432 collapsed false true/false
434 \begin_layout Standard
441 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
442 the pre-existing Minipage inset. Parameters translate as follows:
443 position 0/1/2 -> t/c/b
444 inner_position 0/1/2/3 -> inner_pos c/t/b/s
449 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
451 * attribute valignment="center" is replaced by valignment="middle"
452 for tabular columns and cells
454 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
456 * Added branch inset. File format:
458 branch definition in the header:
464 \begin_inset Branch <branchname>
465 collapsed false true/false
467 \begin_layout Standard
474 2003-07-28 José Matos <jamatos@lyx.org>
476 * \the_end is replaced with \end_document
478 2003-07-28 José Matos <jamatos@lyx.org>
480 * \layout is replaced with \begin_layout
482 2003-07-28 José Matos <jamatos@fep.up.pt>
486 * All layouts finish now with \end_layout
488 2003-06-04 Angus Leeming <leeming@lyx.org>
492 * the storage of the external inset has been changed from
494 \begin_inset External XFig,"file.fig",""
500 \begin_inset External
503 display <display_type>
508 throwing away the final arg (here "", more generally "<string>") that holds
509 the parameters variable.
510 Variables are output if present (filename) or different from the default
511 values (display, lyxscale).
513 Moreover, the RasterImage template has been scrapped. All RasterImage
514 external insets are now converted to Graphics insets.
516 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
518 * Added new space insets:
519 \SpecialChar ~ is now \InsetSpace ~
520 ERT: "\ " could be converted to InsetSpace \<space>
521 ERT: "\," could be converted to InsetSpace \,
523 2003-04-24 André Pönitz <poenitz@gmx.net>
525 * Added eqref support:
526 \begin_inset LatexCommand \eqref{label}
528 2003-03-14 Dekel Tsur
530 * Format bumped to 223.
532 2003-03-12 John Levon <levon@movementarian.org>
534 * Added \\end_header to signify the end of the header in a
537 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
539 2003-02-10 John Levon <levon@movementarian.org>
543 Added \\tracking_changes 0|1 to the header.
545 Added \\author to the header. This can be present multiple
546 times, and is of the form :
548 \\author "Real Name" email@address.com
550 Added \\change_deleted, \\change_inserted. Each of these does not
551 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
554 \\change_inserted author time
556 where author is an integer ID reference into the author list in
557 the header, and time is time_t.
559 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
561 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
563 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
565 New graphics dialog. With the removal of buttons in the dialog, also
566 keywords in the graphics inset went. The following keywords do not
576 Only non-default values are saved to the lyx files. The defaults of the remaining
586 BoundingBox <from file>
589 rotateOrigin centerBaseline
591 subcaptionText <empty>
594 The remaining keywords have sufficient overlap with the old ones for a
595 smooth reading of the 1.2.x inset keywords in most common cases.
597 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
598 They don't exist anymore and we can't translate them into a scaling value, while
599 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
600 argument is ignored and lost.
602 Only few compatibility issues are left for lyx2lyx:
604 ------------------------------------------------------------------------------
605 old-token new-token remove
606 ------------------------------------------------------------------------------
607 size_kind original / size_type 0 scale 100 width <val>
611 size_kind width_height / size_type 1 - scale <val>
613 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
614 ------------------------------------------------------------------------------
615 [replace old-token by new-token, and remove any of subsequent tokens as listed]
617 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
618 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
620 replace "rotateAngle <val>" by "rotateAngle 0"
623 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
625 Added \lyxlock for locked math inset when written to .lyx file.
626 When "downgrading" .lyx files this should simple be deleted but it
627 does not hurt at all if it stays in. It does not have to be added
631 2002-08-02 Angus Leeming <leeming@lyx.org>
633 Added a boolean "preview" flag to InsetCommandParams.
634 Currently it is written only by InsetInclude, because only this
635 class can generate a preview of its contents.
637 The LyX file now contains:
639 \begin_inset Include \input{snapshot_t=40.tex}
644 Earlier versions of LyX just swallow this extra token silently.
646 2002-08-12 Angus Leeming <leeming@lyx.org>
648 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
649 renamed as "size_kind" and "lyxsize_kind" respectively.
651 \begin_inset Graphics FormatVersion 1
658 - lyxsize_kind original
659 + lyxsize_type original