1 LyX file-format changes
2 -----------------------§
4 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 260: Allow utf8x \inputencoding
8 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
10 * format incremented to 259:
11 Old: Spaces at start or end of font changes were output outside of
12 the font change, i.e. not 'xx\textbf{ yy }zz', but
14 New: Spaces are always output with the font set by the user.
18 * format incremented to 258: new \lyxline definition
20 \\newcommand{\\lyxline}[1]{
21 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
24 \\newcommand{\\lyxline}[1][1pt]{%
26 \\rule[.5ex]{\\linewidth}{#1}\\par}
27 The new definition is more robust, see bug 1988 and now really takes care about
28 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
30 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
32 * format incremented to 257: Caption styles have been replaced by
33 InsetCaption. This is at the same time also a layout file format
34 change to format 3. layout2layout removes caption layouts from old
36 Note that InsetCaption did exist before this format, but was never
37 used. Old files containing do nevertheless still work.
38 Of course users can still define a Caption style in layout files,
39 but the special treatment in LyX is gone (apart from the sensitive
42 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
44 * format incremented to 256: allow some new inputenc settings.
45 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
47 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
49 * format incremented to 255: new insets for \clearpage and
50 \cleardoublepage. They are written inline to the file, exactly like
53 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
55 * format incremented to 254: new header parameter \use_esint.
56 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
59 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
61 * format incremented to 253: new nomenclature and printnomenclature
62 insets. These are standard InsetCommand with the following parameters:
63 \nomenclature[prefix]{symbol}{description}
64 \printnomenclature[labelwidth]
66 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
68 * format incremented to 252: changed command inset syntax
72 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
83 \begin_inset LatexCommand cmdname
90 The order of the parameters and for each parameter the name and
91 optional/required bit is now stored in InsetCommandParams.
93 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
95 * format incremented to 251: save show_label param for charstyles.
97 On revert, the show_label param is just removed. Nothing to convert.
99 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
101 * Format incremented to 250: allow optional arg to environments
103 No material format change. Now optargs for environments are allowed
104 to be specified in layout files and will be handled properly. When
105 converted back to older formats, they will be ignored in LaTeX
108 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
110 * format incremented to 249: Unicode
112 LyX documents are now always encoded in utf8. The value of
113 \inputencoding does now only determine the encoding of the created
115 Up to format 248 the value of \inputencoding did also determine the
116 encoding of the LyX file:
118 \inputencoding LyX file encoding
119 auto as determined by the document and character
122 everything else as determined by \inputencoding
124 The difference between auto and default is only the LaTeX output:
125 auto causes loading of the inputenc package, default does not.
127 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
129 * format incremented to 248: Basic booktabs support
131 The <features> tag has a new switch: booktabs="true|false".
132 An absent switch is equivalent to booktabs="false".
133 Horizontal lines are set with the booktabs package if this switch
136 The <row> tag of tabulars has the following new attributes:
137 topspace, bottomspace and interlinespace. All take a LyXLength
138 as value, or the special keyword "default".
140 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
142 * format incremented to 247. The Grand Font Interface Rewrite.
143 (1) Split font selection to rm, sf, tt:
144 \fontscheme -> \font_roman, \font_sans, \font_typewriter
146 \fontscheme \font_roman \font_sans \font_typewriter
147 default default default default
148 ae ae default default
149 times times default default
150 palatino palatino default default
151 helvet default helvet default
152 avant default avant default
153 newcent newcent default default
154 bookman bookman default default
155 pslatex times (or \usepackage{pslatex})
157 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
158 lmodern, charter, utopia, ccfonts, chancery, beraserif
159 (-> \usepackage{<name>})
160 \font_sans: cmss, lmss, cmbr
161 (-> \renewcommand{\sfdefault}{<name>})
162 berasans (-> \usepackage{<name>})
163 \font_typewriter: cmtt, lmtt, cmtl,
164 (-> \renewcommand{\sfdefault}{<name>})
165 courier, luximono, beramono
166 (-> \usepackage{<name>})
167 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
168 (3) New param \font_sc (true, false).
169 (4) New param \font_osf (true, false).
170 (5) New param \font_sf_scale (float)
171 (6) New param \font_tt_scale (float)
172 Support for the following fonts has been added:
173 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
174 courier, lmodern, luximono, utopia.
175 Support for the following font has been removed:
176 pslatex (it's superseded by mathptmx (times)).
178 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
180 * format incremented to 246. The framed.sty package is
181 now supported with note types framed and shaded.
183 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
185 * format incremented to 245. The \quotes_times parameter
188 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
190 * format incremented to 244. Rename '\InsetSpace \,'
191 to '\InsetSpace \thinspace{}', because the comma was
192 not parsed by lyxlex, and '\InsetSpace \space' to
193 '\InsetSpace \space{}' in favour of consistency.
195 2005-07-18 José Matos <jamatos@lyx.org>
197 * format incremented to 243.
199 * this change only affects the preamble, the paperpackage
200 option was removed and papersize is changed to default.
202 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
204 * format incremented to 242. There is no file format per
205 se, but the "frenchb" language has been removed from lib/language
206 and has to be translated to "french" by lyx2lyx.
208 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
210 * format incremented to 241.
212 All following changes apply only to text in ERT insets. The
213 rationale is that text in ERT is simply ASCII text, and nothing more.
215 * paragraph breaks are now a single newline in latex and not a
216 paragraph break anymore (bug 698).
217 * \newline is not allowed anymore, because it is redundant (see above)
218 * layouts other than Standard, paragraph parameters and font changes
219 are not allowed anymore. They never made sense and were ignored for
220 latex output, but now they can't be read or set anymore (bug 922).
223 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
225 * format incremented to 240.
227 \output_changes {true|false}
228 (should the change tracking marks be visible in the output or not?)
229 * lyx2lyx should just delete the param in 239.
231 2005-01-06 José Matos <jamatos@lyx.org>
233 * format incremented to 239.
234 * the paragraph parameters are displayed in their own line. This
235 change is consistent with the insets behaviour, and corresponds
236 to a more uniform treatment of the paragraphs since some of them
237 had already their own line.
239 An example of a single paragraph follows:
241 \begin_layout Standard
242 \paragraph_spacing single
248 2004-12-03 José Matos <jamatos@lyx.org>
250 * format incremented to 238.
251 * The compatibility code to read old latex accents from 0.12.x in
252 InsetLatexAccent::checkContents has been removed.
253 The following translations are done:
255 "\i \xy" -> "\i \x{y}"
256 "\i \x y" -> "\i \x{y}"
257 "\i \x\i" -> "\i \x{\i}"
258 "\i \x\j" -> "\i \x{\j}"
259 x is a latex accent command, y the base character. \, i and j are
261 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
262 so formats 215 - 237 can have both versions.
265 2004-10-10 José Matos <jamatos@lyx.org>
267 * format incremented to 237.
268 * In the header, the following statments use now booleans values,
274 2004-08-15 José Matos <jamatos@lyx.org>
276 * format incremented to 236.
283 * The options for \papersize are changed:
286 * All whitespaces are removed at the end of lines, when
287 not necessary. As an example we have all the lines in the header that
288 do not belong to the preamble.
290 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
292 * format incremented to 235.
293 * \paperpackage had an off-by-one error. Translation table:
295 234: a4 a4wide widemarginsa4
296 235: none a4 a4wide widemarginsa4
298 The "widemarginsa4" setting of 235 has no equivalent in 234.
300 2004-05-12 Angus Leeming <leeming@lyx.org>
302 * format incremented to 234.
303 * the citation engine is specified explicitly rather than being
304 deduced from 3 bools.
307 \use_numerical_citations 0 -> \cite_engine <style>
310 where <style> is one of "basic", "natbib_authoryear",
311 "natbib_numerical" or "jurabib".
313 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
315 * format incremented to 233.
316 * insetgraphics does not allow filenames without extension anymore.
317 The complete filename has to be given.
319 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
321 * format incremented to 232.
323 * Support for bibtopic (sectioned bibliographies).
324 - bufferparam \use_bibtopic [1|0]
325 - the bibtex inset has a second argument for bibtopic's
326 btPrint{Cited|NotCited|All} command:
328 \begin_inset LatexCommand \bibtex[<style>]{<database>}
330 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
331 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
332 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
333 \bibliographystyle{<style>}
334 \begin{btSect}{<database>}
339 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
341 * format incremented to 231.
343 * Support for sidewaysfigure/sidewaystable (rotating package).
344 insetfloat has now a param \sideways [true|false] (default is false).
345 The param should be erased on downwards conversion, if it was true,
346 the inset should be replaced by
347 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
349 \begin{sidewaystable} <content> \end{sidewaystable}
352 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
354 * format incremented to 230.
356 * Support for a second optional argument in insetcommand.
357 currently, citation uses this to support natbibs second
358 optional argument \cite[before][after]{key}.
359 I think there's nothing to convert upwards. Downwards, the
360 commands with 2 optional args need to be converted to ERT.
362 * Support for jurabib (param \use_jurabib [1|0], default is 0).
363 When converting downwards, \usepackage{jurabib} has to be added
364 to the preamble and, if babel is used, \usepackage{babel} before
365 (jurabib fails if babel is called afterwards). If the natbib commands
366 are used together with jurabib, they have to be converted to ERT too.
368 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
370 * format incremented to 229.
371 * Minipages cannot be read anymore. All minipage insets will
372 be converted to frameless box insets between 228->229.
374 2003-12-15 Angus Leeming <leeming@lyx.org>
376 * format incremented to 228.
377 * Change the output of all insets derived from InsetCollapsable
378 except for InsetERT (which has a similar output already), changing lines
379 "collapsed true" -> "status collapsed"
380 "collapsed false" -> "status open".
381 * Change the output of InsetERT, changing lines
382 "status Collapsed" -> "status collapsed"
383 "status Open" -> "status open".
384 "status Inlined" -> "status inlined".
386 2003-12-10 Angus Leeming <leeming@lyx.org>
388 * format NOT incremented.
389 * add a 'draft' option to InsetExternal.
391 2003-12-10 Angus Leeming <leeming@lyx.org>
393 * format incremented to 227.
394 * Change the output of InsetBox:
395 \begin_inset Boxed -> \begin_inset Box Boxed
396 \begin_inset Doublebox -> \begin_inset Box Doublebox
397 \begin_inset Frameless -> \begin_inset Box Frameless
398 \begin_inset ovalbox -> \begin_inset Box ovalbox
399 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
400 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
402 2003-12-10 Angus Leeming <leeming@lyx.org>
404 * format incremented to 226.
405 * Change the output of InsetNote:
406 \begin_inset Note -> \begin_inset Note Note
407 \begin_inset Comment -> \begin_inset Note Comment
408 \begin_inset Greyedout -> \begin_inset Note Greyedout
410 2003-11-28 André Pönitz
412 * Remove space_above/space_below from Paragraph.
413 This is now handled by InsetVSpace.
415 2003-10-07 Angus Leeming <leeming@lyx.org>
417 * Add transformations to InsetExternal
419 boundingBox 0 0 20 20 the dimensions of the B.B..
420 Output if the B.B. is not empty.
421 clip clip the image to the B.B.
423 extra LaTeX "draft" 'extra' data passed to the primary
424 command for this output format.
425 (Possible formats LaTeX, PDFLaTeX,
426 LinuxDoc, DocBook, Ascii.)
427 The string can contain spaces and so
429 rotateAngle 30 Rotation of the data.
430 Output for non-zero rotation only.
431 rotateOrigin bottomleft Rotation origin.
432 Output for non-zero rotation and
433 non-default origin (center) only.
435 width 2cm Output only if the image is resized.
439 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
441 * Added box inset. File format:
443 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
448 inner_pos "b" t/c/b/s
450 width "100col%" unit+width-string
451 special "none" none/height/depth
453 height "1in" unit+width-string
454 height_special "totalheight" none/height/depth
456 collapsed false true/false
458 \begin_layout Standard
465 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
466 the pre-existing Minipage inset. Parameters translate as follows:
467 position 0/1/2 -> t/c/b
468 inner_position 0/1/2/3 -> inner_pos c/t/b/s
473 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
475 * attribute valignment="center" is replaced by valignment="middle"
476 for tabular columns and cells
478 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
480 * Added branch inset. File format:
482 branch definition in the header:
488 \begin_inset Branch <branchname>
489 collapsed false true/false
491 \begin_layout Standard
498 2003-07-28 José Matos <jamatos@lyx.org>
500 * \the_end is replaced with \end_document
502 2003-07-28 José Matos <jamatos@lyx.org>
504 * \layout is replaced with \begin_layout
506 2003-07-28 José Matos <jamatos@fep.up.pt>
510 * All layouts finish now with \end_layout
512 2003-06-04 Angus Leeming <leeming@lyx.org>
516 * the storage of the external inset has been changed from
518 \begin_inset External XFig,"file.fig",""
524 \begin_inset External
527 display <display_type>
532 throwing away the final arg (here "", more generally "<string>") that holds
533 the parameters variable.
534 Variables are output if present (filename) or different from the default
535 values (display, lyxscale).
537 Moreover, the RasterImage template has been scrapped. All RasterImage
538 external insets are now converted to Graphics insets.
540 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
542 * Added new space insets:
543 \SpecialChar ~ is now \InsetSpace ~
544 ERT: "\ " could be converted to InsetSpace \<space>
545 ERT: "\," could be converted to InsetSpace \,
547 2003-04-24 André Pönitz <poenitz@gmx.net>
549 * Added eqref support:
550 \begin_inset LatexCommand \eqref{label}
552 2003-03-14 Dekel Tsur
554 * Format bumped to 223.
556 2003-03-12 John Levon <levon@movementarian.org>
558 * Added \\end_header to signify the end of the header in a
561 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
563 2003-02-10 John Levon <levon@movementarian.org>
567 Added \\tracking_changes 0|1 to the header.
569 Added \\author to the header. This can be present multiple
570 times, and is of the form :
572 \\author "Real Name" email@address.com
574 Added \\change_deleted, \\change_inserted. Each of these does not
575 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
578 \\change_inserted author time
580 where author is an integer ID reference into the author list in
581 the header, and time is time_t.
583 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
585 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
587 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
589 New graphics dialog. With the removal of buttons in the dialog, also
590 keywords in the graphics inset went. The following keywords do not
600 Only non-default values are saved to the lyx files. The defaults of the remaining
610 BoundingBox <from file>
613 rotateOrigin centerBaseline
615 subcaptionText <empty>
618 The remaining keywords have sufficient overlap with the old ones for a
619 smooth reading of the 1.2.x inset keywords in most common cases.
621 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
622 They don't exist anymore and we can't translate them into a scaling value, while
623 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
624 argument is ignored and lost.
626 Only few compatibility issues are left for lyx2lyx:
628 ------------------------------------------------------------------------------
629 old-token new-token remove
630 ------------------------------------------------------------------------------
631 size_kind original / size_type 0 scale 100 width <val>
635 size_kind width_height / size_type 1 - scale <val>
637 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
638 ------------------------------------------------------------------------------
639 [replace old-token by new-token, and remove any of subsequent tokens as listed]
641 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
642 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
644 replace "rotateAngle <val>" by "rotateAngle 0"
647 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
649 Added \lyxlock for locked math inset when written to .lyx file.
650 When "downgrading" .lyx files this should simple be deleted but it
651 does not hurt at all if it stays in. It does not have to be added
655 2002-08-02 Angus Leeming <leeming@lyx.org>
657 Added a boolean "preview" flag to InsetCommandParams.
658 Currently it is written only by InsetInclude, because only this
659 class can generate a preview of its contents.
661 The LyX file now contains:
663 \begin_inset Include \input{snapshot_t=40.tex}
668 Earlier versions of LyX just swallow this extra token silently.
670 2002-08-12 Angus Leeming <leeming@lyx.org>
672 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
673 renamed as "size_kind" and "lyxsize_kind" respectively.
675 \begin_inset Graphics FormatVersion 1
682 - lyxsize_kind original
683 + lyxsize_type original