1 LyX file-format changes
2 -----------------------
4 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
6 * format incremented to 267: add plain utf8 encoding (for XeTeX).
8 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
10 * format incremented to 266:
11 Support for the Armenian language
13 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
15 * format incremented to 265: fix LyX's table border line handling
16 With the fix (see bug 1746) LyX now takes care if the user has entered
17 a "|" character in the argument field of tables. Therefore the "|"
18 character has to be removed when also a table border is set.
20 2007-04-24 José Matos <jamatos@lyx.org>
22 * format incremented to 264:
23 textclass cv is renamed simplecv
25 2007-02-22 José Matos <jamatos@lyx.org>
27 * format incremented to 263: changes in the language names (overdue):
29 portuges -> portuguese
31 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
33 * format incremented to 262: Allow ascii \inputencoding
35 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
37 * format incremented to 261: \output_changes is now considered
38 even if \tracking_changes is false. This allows to output existing
39 changes even if future changes are not tracked anymore.
42 \tracking_changes false
45 is therefore converted to
47 \tracking_changes false
50 on upgrade. Nothing is done on downgrade since the new behaviour is
51 not supported in older formats.
53 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
55 * format incremented to 260: Allow utf8x \inputencoding
57 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
59 * format incremented to 259:
60 Old: Spaces at start or end of font changes were output outside of
61 the font change, i.e. not 'xx\textbf{ yy }zz', but
63 New: Spaces are always output with the font set by the user.
65 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
67 * format incremented to 258: new \lyxline definition
69 \\newcommand{\\lyxline}[1]{
70 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
73 \\newcommand{\\lyxline}[1][1pt]{%
75 \\rule[.5ex]{\\linewidth}{#1}\\par}
76 The new definition is more robust, see bug 1988 and now really takes care about
77 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
79 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
81 * format incremented to 257: Caption styles have been replaced by
82 InsetCaption. This is at the same time also a layout file format
83 change to format 3. layout2layout removes caption layouts from old
85 Note that InsetCaption did exist before this format, but was never
86 used. Old files containing do nevertheless still work.
87 Of course users can still define a Caption style in layout files,
88 but the special treatment in LyX is gone (apart from the sensitive
91 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
93 * format incremented to 256: allow some new inputenc settings.
94 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
96 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
98 * format incremented to 255: new insets for \clearpage and
99 \cleardoublepage. They are written inline to the file, exactly like
102 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
104 * format incremented to 254: new header parameter \use_esint.
105 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
108 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
110 * format incremented to 253: new nomenclature and printnomenclature
111 insets. These are standard InsetCommand with the following parameters:
112 \nomenclature[prefix]{symbol}{description}
113 \printnomenclature[labelwidth]
115 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
117 * format incremented to 252: changed command inset syntax
121 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
132 \begin_inset LatexCommand cmdname
139 The order of the parameters and for each parameter the name and
140 optional/required bit is now stored in InsetCommandParams.
142 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
144 * format incremented to 251: save show_label param for charstyles.
146 On revert, the show_label param is just removed. Nothing to convert.
148 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
150 * Format incremented to 250: allow optional arg to environments
152 No material format change. Now optargs for environments are allowed
153 to be specified in layout files and will be handled properly. When
154 converted back to older formats, they will be ignored in LaTeX
157 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
159 * format incremented to 249: Unicode
161 LyX documents are now always encoded in utf8. The value of
162 \inputencoding does now only determine the encoding of the created
164 Up to format 248 the value of \inputencoding did also determine the
165 encoding of the LyX file:
167 \inputencoding LyX file encoding
168 auto as determined by the document and character
171 everything else as determined by \inputencoding
173 The difference between auto and default is only the LaTeX output:
174 auto causes loading of the inputenc package, default does not.
176 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
178 * format incremented to 248: Basic booktabs support
180 The <features> tag has a new switch: booktabs="true|false".
181 An absent switch is equivalent to booktabs="false".
182 Horizontal lines are set with the booktabs package if this switch
185 The <row> tag of tabulars has the following new attributes:
186 topspace, bottomspace and interlinespace. All take a LyXLength
187 as value, or the special keyword "default".
189 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
191 * format incremented to 247. The Grand Font Interface Rewrite.
192 (1) Split font selection to rm, sf, tt:
193 \fontscheme -> \font_roman, \font_sans, \font_typewriter
195 \fontscheme \font_roman \font_sans \font_typewriter
196 default default default default
197 ae ae default default
198 times times default default
199 palatino palatino default default
200 helvet default helvet default
201 avant default avant default
202 newcent newcent default default
203 bookman bookman default default
204 pslatex times (or \usepackage{pslatex})
206 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
207 lmodern, charter, utopia, ccfonts, chancery, beraserif
208 (-> \usepackage{<name>})
209 \font_sans: cmss, lmss, cmbr
210 (-> \renewcommand{\sfdefault}{<name>})
211 berasans (-> \usepackage{<name>})
212 \font_typewriter: cmtt, lmtt, cmtl,
213 (-> \renewcommand{\sfdefault}{<name>})
214 courier, luximono, beramono
215 (-> \usepackage{<name>})
216 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
217 (3) New param \font_sc (true, false).
218 (4) New param \font_osf (true, false).
219 (5) New param \font_sf_scale (float)
220 (6) New param \font_tt_scale (float)
221 Support for the following fonts has been added:
222 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
223 courier, lmodern, luximono, utopia.
224 Support for the following font has been removed:
225 pslatex (it's superseded by mathptmx (times)).
227 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
229 * format incremented to 246. The framed.sty package is
230 now supported with note types framed and shaded.
232 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
234 * format incremented to 245. The \quotes_times parameter
237 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
239 * format incremented to 244. Rename '\InsetSpace \,'
240 to '\InsetSpace \thinspace{}', because the comma was
241 not parsed by lyxlex, and '\InsetSpace \space' to
242 '\InsetSpace \space{}' in favour of consistency.
244 2005-07-18 José Matos <jamatos@lyx.org>
246 * format incremented to 243.
248 * this change only affects the preamble, the paperpackage
249 option was removed and papersize is changed to default.
251 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
253 * format incremented to 242. There is no file format per
254 se, but the "frenchb" language has been removed from lib/language
255 and has to be translated to "french" by lyx2lyx.
257 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
259 * format incremented to 241.
261 All following changes apply only to text in ERT insets. The
262 rationale is that text in ERT is simply ASCII text, and nothing more.
264 * paragraph breaks are now a single newline in latex and not a
265 paragraph break anymore (bug 698).
266 * \newline is not allowed anymore, because it is redundant (see above)
267 * layouts other than Standard, paragraph parameters and font changes
268 are not allowed anymore. They never made sense and were ignored for
269 latex output, but now they can't be read or set anymore (bug 922).
272 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
274 * format incremented to 240.
276 \output_changes {true|false}
277 (should the change tracking marks be visible in the output or not?)
278 * lyx2lyx should just delete the param in 239.
280 2005-01-06 José Matos <jamatos@lyx.org>
282 * format incremented to 239.
283 * the paragraph parameters are displayed in their own line. This
284 change is consistent with the insets behaviour, and corresponds
285 to a more uniform treatment of the paragraphs since some of them
286 had already their own line.
288 An example of a single paragraph follows:
290 \begin_layout Standard
291 \paragraph_spacing single
297 2004-12-03 José Matos <jamatos@lyx.org>
299 * format incremented to 238.
300 * The compatibility code to read old latex accents from 0.12.x in
301 InsetLatexAccent::checkContents has been removed.
302 The following translations are done:
304 "\i \xy" -> "\i \x{y}"
305 "\i \x y" -> "\i \x{y}"
306 "\i \x\i" -> "\i \x{\i}"
307 "\i \x\j" -> "\i \x{\j}"
308 x is a latex accent command, y the base character. \, i and j are
310 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
311 so formats 215 - 237 can have both versions.
314 2004-10-10 José Matos <jamatos@lyx.org>
316 * format incremented to 237.
317 * In the header, the following statments use now booleans values,
323 2004-08-15 José Matos <jamatos@lyx.org>
325 * format incremented to 236.
332 * The options for \papersize are changed:
335 * All whitespaces are removed at the end of lines, when
336 not necessary. As an example we have all the lines in the header that
337 do not belong to the preamble.
339 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
341 * format incremented to 235.
342 * \paperpackage had an off-by-one error. Translation table:
344 234: a4 a4wide widemarginsa4
345 235: none a4 a4wide widemarginsa4
347 The "widemarginsa4" setting of 235 has no equivalent in 234.
349 2004-05-12 Angus Leeming <leeming@lyx.org>
351 * format incremented to 234.
352 * the citation engine is specified explicitly rather than being
353 deduced from 3 bools.
356 \use_numerical_citations 0 -> \cite_engine <style>
359 where <style> is one of "basic", "natbib_authoryear",
360 "natbib_numerical" or "jurabib".
362 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
364 * format incremented to 233.
365 * insetgraphics does not allow filenames without extension anymore.
366 The complete filename has to be given.
368 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
370 * format incremented to 232.
372 * Support for bibtopic (sectioned bibliographies).
373 - bufferparam \use_bibtopic [1|0]
374 - the bibtex inset has a second argument for bibtopic's
375 btPrint{Cited|NotCited|All} command:
377 \begin_inset LatexCommand \bibtex[<style>]{<database>}
379 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
380 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
381 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
382 \bibliographystyle{<style>}
383 \begin{btSect}{<database>}
388 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
390 * format incremented to 231.
392 * Support for sidewaysfigure/sidewaystable (rotating package).
393 insetfloat has now a param \sideways [true|false] (default is false).
394 The param should be erased on downwards conversion, if it was true,
395 the inset should be replaced by
396 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
398 \begin{sidewaystable} <content> \end{sidewaystable}
401 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
403 * format incremented to 230.
405 * Support for a second optional argument in insetcommand.
406 currently, citation uses this to support natbibs second
407 optional argument \cite[before][after]{key}.
408 I think there's nothing to convert upwards. Downwards, the
409 commands with 2 optional args need to be converted to ERT.
411 * Support for jurabib (param \use_jurabib [1|0], default is 0).
412 When converting downwards, \usepackage{jurabib} has to be added
413 to the preamble and, if babel is used, \usepackage{babel} before
414 (jurabib fails if babel is called afterwards). If the natbib commands
415 are used together with jurabib, they have to be converted to ERT too.
417 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
419 * format incremented to 229.
420 * Minipages cannot be read anymore. All minipage insets will
421 be converted to frameless box insets between 228->229.
423 2003-12-15 Angus Leeming <leeming@lyx.org>
425 * format incremented to 228.
426 * Change the output of all insets derived from InsetCollapsable
427 except for InsetERT (which has a similar output already), changing lines
428 "collapsed true" -> "status collapsed"
429 "collapsed false" -> "status open".
430 * Change the output of InsetERT, changing lines
431 "status Collapsed" -> "status collapsed"
432 "status Open" -> "status open".
433 "status Inlined" -> "status inlined".
435 2003-12-10 Angus Leeming <leeming@lyx.org>
437 * format NOT incremented.
438 * add a 'draft' option to InsetExternal.
440 2003-12-10 Angus Leeming <leeming@lyx.org>
442 * format incremented to 227.
443 * Change the output of InsetBox:
444 \begin_inset Boxed -> \begin_inset Box Boxed
445 \begin_inset Doublebox -> \begin_inset Box Doublebox
446 \begin_inset Frameless -> \begin_inset Box Frameless
447 \begin_inset ovalbox -> \begin_inset Box ovalbox
448 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
449 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
451 2003-12-10 Angus Leeming <leeming@lyx.org>
453 * format incremented to 226.
454 * Change the output of InsetNote:
455 \begin_inset Note -> \begin_inset Note Note
456 \begin_inset Comment -> \begin_inset Note Comment
457 \begin_inset Greyedout -> \begin_inset Note Greyedout
459 2003-11-28 André Pönitz
461 * Remove space_above/space_below from Paragraph.
462 This is now handled by InsetVSpace.
464 2003-10-07 Angus Leeming <leeming@lyx.org>
466 * Add transformations to InsetExternal
468 boundingBox 0 0 20 20 the dimensions of the B.B..
469 Output if the B.B. is not empty.
470 clip clip the image to the B.B.
472 extra LaTeX "draft" 'extra' data passed to the primary
473 command for this output format.
474 (Possible formats LaTeX, PDFLaTeX,
475 LinuxDoc, DocBook, Ascii.)
476 The string can contain spaces and so
478 rotateAngle 30 Rotation of the data.
479 Output for non-zero rotation only.
480 rotateOrigin bottomleft Rotation origin.
481 Output for non-zero rotation and
482 non-default origin (center) only.
484 width 2cm Output only if the image is resized.
488 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
490 * Added box inset. File format:
492 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
497 inner_pos "b" t/c/b/s
499 width "100col%" unit+width-string
500 special "none" none/height/depth
502 height "1in" unit+width-string
503 height_special "totalheight" none/height/depth
505 collapsed false true/false
507 \begin_layout Standard
514 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
515 the pre-existing Minipage inset. Parameters translate as follows:
516 position 0/1/2 -> t/c/b
517 inner_position 0/1/2/3 -> inner_pos c/t/b/s
522 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
524 * attribute valignment="center" is replaced by valignment="middle"
525 for tabular columns and cells
527 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
529 * Added branch inset. File format:
531 branch definition in the header:
537 \begin_inset Branch <branchname>
538 collapsed false true/false
540 \begin_layout Standard
547 2003-07-28 José Matos <jamatos@lyx.org>
549 * \the_end is replaced with \end_document
551 2003-07-28 José Matos <jamatos@lyx.org>
553 * \layout is replaced with \begin_layout
555 2003-07-28 José Matos <jamatos@fep.up.pt>
559 * All layouts finish now with \end_layout
561 2003-06-04 Angus Leeming <leeming@lyx.org>
565 * the storage of the external inset has been changed from
567 \begin_inset External XFig,"file.fig",""
573 \begin_inset External
576 display <display_type>
581 throwing away the final arg (here "", more generally "<string>") that holds
582 the parameters variable.
583 Variables are output if present (filename) or different from the default
584 values (display, lyxscale).
586 Moreover, the RasterImage template has been scrapped. All RasterImage
587 external insets are now converted to Graphics insets.
589 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
591 * Added new space insets:
592 \SpecialChar ~ is now \InsetSpace ~
593 ERT: "\ " could be converted to InsetSpace \<space>
594 ERT: "\," could be converted to InsetSpace \,
596 2003-04-24 André Pönitz <poenitz@gmx.net>
598 * Added eqref support:
599 \begin_inset LatexCommand \eqref{label}
601 2003-03-14 Dekel Tsur
603 * Format bumped to 223.
605 2003-03-12 John Levon <levon@movementarian.org>
607 * Added \\end_header to signify the end of the header in a
610 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
612 2003-02-10 John Levon <levon@movementarian.org>
616 Added \\tracking_changes 0|1 to the header.
618 Added \\author to the header. This can be present multiple
619 times, and is of the form :
621 \\author "Real Name" email@address.com
623 Added \\change_deleted, \\change_inserted. Each of these does not
624 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
627 \\change_inserted author time
629 where author is an integer ID reference into the author list in
630 the header, and time is time_t.
632 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
634 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
636 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
638 New graphics dialog. With the removal of buttons in the dialog, also
639 keywords in the graphics inset went. The following keywords do not
649 Only non-default values are saved to the lyx files. The defaults of the remaining
659 BoundingBox <from file>
662 rotateOrigin centerBaseline
664 subcaptionText <empty>
667 The remaining keywords have sufficient overlap with the old ones for a
668 smooth reading of the 1.2.x inset keywords in most common cases.
670 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
671 They don't exist anymore and we can't translate them into a scaling value, while
672 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
673 argument is ignored and lost.
675 Only few compatibility issues are left for lyx2lyx:
677 ------------------------------------------------------------------------------
678 old-token new-token remove
679 ------------------------------------------------------------------------------
680 size_kind original / size_type 0 scale 100 width <val>
684 size_kind width_height / size_type 1 - scale <val>
686 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
687 ------------------------------------------------------------------------------
688 [replace old-token by new-token, and remove any of subsequent tokens as listed]
690 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
691 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
693 replace "rotateAngle <val>" by "rotateAngle 0"
696 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
698 Added \lyxlock for locked math inset when written to .lyx file.
699 When "downgrading" .lyx files this should simple be deleted but it
700 does not hurt at all if it stays in. It does not have to be added
704 2002-08-02 Angus Leeming <leeming@lyx.org>
706 Added a boolean "preview" flag to InsetCommandParams.
707 Currently it is written only by InsetInclude, because only this
708 class can generate a preview of its contents.
710 The LyX file now contains:
712 \begin_inset Include \input{snapshot_t=40.tex}
717 Earlier versions of LyX just swallow this extra token silently.
719 2002-08-12 Angus Leeming <leeming@lyx.org>
721 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
722 renamed as "size_kind" and "lyxsize_kind" respectively.
724 \begin_inset Graphics FormatVersion 1
731 - lyxsize_kind original
732 + lyxsize_type original