1 LyX file-format changes
2 -----------------------
3 2007-04-24 José Matos <jamatos@lyx.org>
5 * format incremented to 264:
6 textclass cv is renamed simplecv
8 2007-02-22 José Matos <jamatos@lyx.org>
10 * format incremented to 263: changes in the language names (overdue):
12 portuges -> portuguese
14 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
16 * format incremented to 262: Allow ascii \inputencoding
18 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
20 * format incremented to 261: \output_changes is now considered
21 even if \tracking_changes is false. This allows to output existing
22 changes even if future changes are not tracked anymore.
25 \tracking_changes false
28 is therefore converted to
30 \tracking_changes false
33 on upgrade. Nothing is done on downgrade since the new behaviour is
34 not supported in older formats.
36 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
38 * format incremented to 260: Allow utf8x \inputencoding
40 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
42 * format incremented to 259:
43 Old: Spaces at start or end of font changes were output outside of
44 the font change, i.e. not 'xx\textbf{ yy }zz', but
46 New: Spaces are always output with the font set by the user.
50 * format incremented to 258: new \lyxline definition
52 \\newcommand{\\lyxline}[1]{
53 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
56 \\newcommand{\\lyxline}[1][1pt]{%
58 \\rule[.5ex]{\\linewidth}{#1}\\par}
59 The new definition is more robust, see bug 1988 and now really takes care about
60 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
62 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
64 * format incremented to 257: Caption styles have been replaced by
65 InsetCaption. This is at the same time also a layout file format
66 change to format 3. layout2layout removes caption layouts from old
68 Note that InsetCaption did exist before this format, but was never
69 used. Old files containing do nevertheless still work.
70 Of course users can still define a Caption style in layout files,
71 but the special treatment in LyX is gone (apart from the sensitive
74 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
76 * format incremented to 256: allow some new inputenc settings.
77 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
79 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
81 * format incremented to 255: new insets for \clearpage and
82 \cleardoublepage. They are written inline to the file, exactly like
85 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
87 * format incremented to 254: new header parameter \use_esint.
88 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
91 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
93 * format incremented to 253: new nomenclature and printnomenclature
94 insets. These are standard InsetCommand with the following parameters:
95 \nomenclature[prefix]{symbol}{description}
96 \printnomenclature[labelwidth]
98 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
100 * format incremented to 252: changed command inset syntax
104 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
115 \begin_inset LatexCommand cmdname
122 The order of the parameters and for each parameter the name and
123 optional/required bit is now stored in InsetCommandParams.
125 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
127 * format incremented to 251: save show_label param for charstyles.
129 On revert, the show_label param is just removed. Nothing to convert.
131 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
133 * Format incremented to 250: allow optional arg to environments
135 No material format change. Now optargs for environments are allowed
136 to be specified in layout files and will be handled properly. When
137 converted back to older formats, they will be ignored in LaTeX
140 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
142 * format incremented to 249: Unicode
144 LyX documents are now always encoded in utf8. The value of
145 \inputencoding does now only determine the encoding of the created
147 Up to format 248 the value of \inputencoding did also determine the
148 encoding of the LyX file:
150 \inputencoding LyX file encoding
151 auto as determined by the document and character
154 everything else as determined by \inputencoding
156 The difference between auto and default is only the LaTeX output:
157 auto causes loading of the inputenc package, default does not.
159 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
161 * format incremented to 248: Basic booktabs support
163 The <features> tag has a new switch: booktabs="true|false".
164 An absent switch is equivalent to booktabs="false".
165 Horizontal lines are set with the booktabs package if this switch
168 The <row> tag of tabulars has the following new attributes:
169 topspace, bottomspace and interlinespace. All take a LyXLength
170 as value, or the special keyword "default".
172 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
174 * format incremented to 247. The Grand Font Interface Rewrite.
175 (1) Split font selection to rm, sf, tt:
176 \fontscheme -> \font_roman, \font_sans, \font_typewriter
178 \fontscheme \font_roman \font_sans \font_typewriter
179 default default default default
180 ae ae default default
181 times times default default
182 palatino palatino default default
183 helvet default helvet default
184 avant default avant default
185 newcent newcent default default
186 bookman bookman default default
187 pslatex times (or \usepackage{pslatex})
189 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
190 lmodern, charter, utopia, ccfonts, chancery, beraserif
191 (-> \usepackage{<name>})
192 \font_sans: cmss, lmss, cmbr
193 (-> \renewcommand{\sfdefault}{<name>})
194 berasans (-> \usepackage{<name>})
195 \font_typewriter: cmtt, lmtt, cmtl,
196 (-> \renewcommand{\sfdefault}{<name>})
197 courier, luximono, beramono
198 (-> \usepackage{<name>})
199 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
200 (3) New param \font_sc (true, false).
201 (4) New param \font_osf (true, false).
202 (5) New param \font_sf_scale (float)
203 (6) New param \font_tt_scale (float)
204 Support for the following fonts has been added:
205 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
206 courier, lmodern, luximono, utopia.
207 Support for the following font has been removed:
208 pslatex (it's superseded by mathptmx (times)).
210 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
212 * format incremented to 246. The framed.sty package is
213 now supported with note types framed and shaded.
215 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
217 * format incremented to 245. The \quotes_times parameter
220 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
222 * format incremented to 244. Rename '\InsetSpace \,'
223 to '\InsetSpace \thinspace{}', because the comma was
224 not parsed by lyxlex, and '\InsetSpace \space' to
225 '\InsetSpace \space{}' in favour of consistency.
227 2005-07-18 José Matos <jamatos@lyx.org>
229 * format incremented to 243.
231 * this change only affects the preamble, the paperpackage
232 option was removed and papersize is changed to default.
234 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
236 * format incremented to 242. There is no file format per
237 se, but the "frenchb" language has been removed from lib/language
238 and has to be translated to "french" by lyx2lyx.
240 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
242 * format incremented to 241.
244 All following changes apply only to text in ERT insets. The
245 rationale is that text in ERT is simply ASCII text, and nothing more.
247 * paragraph breaks are now a single newline in latex and not a
248 paragraph break anymore (bug 698).
249 * \newline is not allowed anymore, because it is redundant (see above)
250 * layouts other than Standard, paragraph parameters and font changes
251 are not allowed anymore. They never made sense and were ignored for
252 latex output, but now they can't be read or set anymore (bug 922).
255 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
257 * format incremented to 240.
259 \output_changes {true|false}
260 (should the change tracking marks be visible in the output or not?)
261 * lyx2lyx should just delete the param in 239.
263 2005-01-06 José Matos <jamatos@lyx.org>
265 * format incremented to 239.
266 * the paragraph parameters are displayed in their own line. This
267 change is consistent with the insets behaviour, and corresponds
268 to a more uniform treatment of the paragraphs since some of them
269 had already their own line.
271 An example of a single paragraph follows:
273 \begin_layout Standard
274 \paragraph_spacing single
280 2004-12-03 José Matos <jamatos@lyx.org>
282 * format incremented to 238.
283 * The compatibility code to read old latex accents from 0.12.x in
284 InsetLatexAccent::checkContents has been removed.
285 The following translations are done:
287 "\i \xy" -> "\i \x{y}"
288 "\i \x y" -> "\i \x{y}"
289 "\i \x\i" -> "\i \x{\i}"
290 "\i \x\j" -> "\i \x{\j}"
291 x is a latex accent command, y the base character. \, i and j are
293 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
294 so formats 215 - 237 can have both versions.
297 2004-10-10 José Matos <jamatos@lyx.org>
299 * format incremented to 237.
300 * In the header, the following statments use now booleans values,
306 2004-08-15 José Matos <jamatos@lyx.org>
308 * format incremented to 236.
315 * The options for \papersize are changed:
318 * All whitespaces are removed at the end of lines, when
319 not necessary. As an example we have all the lines in the header that
320 do not belong to the preamble.
322 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
324 * format incremented to 235.
325 * \paperpackage had an off-by-one error. Translation table:
327 234: a4 a4wide widemarginsa4
328 235: none a4 a4wide widemarginsa4
330 The "widemarginsa4" setting of 235 has no equivalent in 234.
332 2004-05-12 Angus Leeming <leeming@lyx.org>
334 * format incremented to 234.
335 * the citation engine is specified explicitly rather than being
336 deduced from 3 bools.
339 \use_numerical_citations 0 -> \cite_engine <style>
342 where <style> is one of "basic", "natbib_authoryear",
343 "natbib_numerical" or "jurabib".
345 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
347 * format incremented to 233.
348 * insetgraphics does not allow filenames without extension anymore.
349 The complete filename has to be given.
351 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
353 * format incremented to 232.
355 * Support for bibtopic (sectioned bibliographies).
356 - bufferparam \use_bibtopic [1|0]
357 - the bibtex inset has a second argument for bibtopic's
358 btPrint{Cited|NotCited|All} command:
360 \begin_inset LatexCommand \bibtex[<style>]{<database>}
362 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
363 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
364 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
365 \bibliographystyle{<style>}
366 \begin{btSect}{<database>}
371 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
373 * format incremented to 231.
375 * Support for sidewaysfigure/sidewaystable (rotating package).
376 insetfloat has now a param \sideways [true|false] (default is false).
377 The param should be erased on downwards conversion, if it was true,
378 the inset should be replaced by
379 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
381 \begin{sidewaystable} <content> \end{sidewaystable}
384 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
386 * format incremented to 230.
388 * Support for a second optional argument in insetcommand.
389 currently, citation uses this to support natbibs second
390 optional argument \cite[before][after]{key}.
391 I think there's nothing to convert upwards. Downwards, the
392 commands with 2 optional args need to be converted to ERT.
394 * Support for jurabib (param \use_jurabib [1|0], default is 0).
395 When converting downwards, \usepackage{jurabib} has to be added
396 to the preamble and, if babel is used, \usepackage{babel} before
397 (jurabib fails if babel is called afterwards). If the natbib commands
398 are used together with jurabib, they have to be converted to ERT too.
400 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
402 * format incremented to 229.
403 * Minipages cannot be read anymore. All minipage insets will
404 be converted to frameless box insets between 228->229.
406 2003-12-15 Angus Leeming <leeming@lyx.org>
408 * format incremented to 228.
409 * Change the output of all insets derived from InsetCollapsable
410 except for InsetERT (which has a similar output already), changing lines
411 "collapsed true" -> "status collapsed"
412 "collapsed false" -> "status open".
413 * Change the output of InsetERT, changing lines
414 "status Collapsed" -> "status collapsed"
415 "status Open" -> "status open".
416 "status Inlined" -> "status inlined".
418 2003-12-10 Angus Leeming <leeming@lyx.org>
420 * format NOT incremented.
421 * add a 'draft' option to InsetExternal.
423 2003-12-10 Angus Leeming <leeming@lyx.org>
425 * format incremented to 227.
426 * Change the output of InsetBox:
427 \begin_inset Boxed -> \begin_inset Box Boxed
428 \begin_inset Doublebox -> \begin_inset Box Doublebox
429 \begin_inset Frameless -> \begin_inset Box Frameless
430 \begin_inset ovalbox -> \begin_inset Box ovalbox
431 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
432 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
434 2003-12-10 Angus Leeming <leeming@lyx.org>
436 * format incremented to 226.
437 * Change the output of InsetNote:
438 \begin_inset Note -> \begin_inset Note Note
439 \begin_inset Comment -> \begin_inset Note Comment
440 \begin_inset Greyedout -> \begin_inset Note Greyedout
442 2003-11-28 André Pönitz
444 * Remove space_above/space_below from Paragraph.
445 This is now handled by InsetVSpace.
447 2003-10-07 Angus Leeming <leeming@lyx.org>
449 * Add transformations to InsetExternal
451 boundingBox 0 0 20 20 the dimensions of the B.B..
452 Output if the B.B. is not empty.
453 clip clip the image to the B.B.
455 extra LaTeX "draft" 'extra' data passed to the primary
456 command for this output format.
457 (Possible formats LaTeX, PDFLaTeX,
458 LinuxDoc, DocBook, Ascii.)
459 The string can contain spaces and so
461 rotateAngle 30 Rotation of the data.
462 Output for non-zero rotation only.
463 rotateOrigin bottomleft Rotation origin.
464 Output for non-zero rotation and
465 non-default origin (center) only.
467 width 2cm Output only if the image is resized.
471 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
473 * Added box inset. File format:
475 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
480 inner_pos "b" t/c/b/s
482 width "100col%" unit+width-string
483 special "none" none/height/depth
485 height "1in" unit+width-string
486 height_special "totalheight" none/height/depth
488 collapsed false true/false
490 \begin_layout Standard
497 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
498 the pre-existing Minipage inset. Parameters translate as follows:
499 position 0/1/2 -> t/c/b
500 inner_position 0/1/2/3 -> inner_pos c/t/b/s
505 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
507 * attribute valignment="center" is replaced by valignment="middle"
508 for tabular columns and cells
510 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
512 * Added branch inset. File format:
514 branch definition in the header:
520 \begin_inset Branch <branchname>
521 collapsed false true/false
523 \begin_layout Standard
530 2003-07-28 José Matos <jamatos@lyx.org>
532 * \the_end is replaced with \end_document
534 2003-07-28 José Matos <jamatos@lyx.org>
536 * \layout is replaced with \begin_layout
538 2003-07-28 José Matos <jamatos@fep.up.pt>
542 * All layouts finish now with \end_layout
544 2003-06-04 Angus Leeming <leeming@lyx.org>
548 * the storage of the external inset has been changed from
550 \begin_inset External XFig,"file.fig",""
556 \begin_inset External
559 display <display_type>
564 throwing away the final arg (here "", more generally "<string>") that holds
565 the parameters variable.
566 Variables are output if present (filename) or different from the default
567 values (display, lyxscale).
569 Moreover, the RasterImage template has been scrapped. All RasterImage
570 external insets are now converted to Graphics insets.
572 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
574 * Added new space insets:
575 \SpecialChar ~ is now \InsetSpace ~
576 ERT: "\ " could be converted to InsetSpace \<space>
577 ERT: "\," could be converted to InsetSpace \,
579 2003-04-24 André Pönitz <poenitz@gmx.net>
581 * Added eqref support:
582 \begin_inset LatexCommand \eqref{label}
584 2003-03-14 Dekel Tsur
586 * Format bumped to 223.
588 2003-03-12 John Levon <levon@movementarian.org>
590 * Added \\end_header to signify the end of the header in a
593 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
595 2003-02-10 John Levon <levon@movementarian.org>
599 Added \\tracking_changes 0|1 to the header.
601 Added \\author to the header. This can be present multiple
602 times, and is of the form :
604 \\author "Real Name" email@address.com
606 Added \\change_deleted, \\change_inserted. Each of these does not
607 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
610 \\change_inserted author time
612 where author is an integer ID reference into the author list in
613 the header, and time is time_t.
615 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
617 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
619 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
621 New graphics dialog. With the removal of buttons in the dialog, also
622 keywords in the graphics inset went. The following keywords do not
632 Only non-default values are saved to the lyx files. The defaults of the remaining
642 BoundingBox <from file>
645 rotateOrigin centerBaseline
647 subcaptionText <empty>
650 The remaining keywords have sufficient overlap with the old ones for a
651 smooth reading of the 1.2.x inset keywords in most common cases.
653 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
654 They don't exist anymore and we can't translate them into a scaling value, while
655 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
656 argument is ignored and lost.
658 Only few compatibility issues are left for lyx2lyx:
660 ------------------------------------------------------------------------------
661 old-token new-token remove
662 ------------------------------------------------------------------------------
663 size_kind original / size_type 0 scale 100 width <val>
667 size_kind width_height / size_type 1 - scale <val>
669 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
670 ------------------------------------------------------------------------------
671 [replace old-token by new-token, and remove any of subsequent tokens as listed]
673 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
674 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
676 replace "rotateAngle <val>" by "rotateAngle 0"
679 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
681 Added \lyxlock for locked math inset when written to .lyx file.
682 When "downgrading" .lyx files this should simple be deleted but it
683 does not hurt at all if it stays in. It does not have to be added
687 2002-08-02 Angus Leeming <leeming@lyx.org>
689 Added a boolean "preview" flag to InsetCommandParams.
690 Currently it is written only by InsetInclude, because only this
691 class can generate a preview of its contents.
693 The LyX file now contains:
695 \begin_inset Include \input{snapshot_t=40.tex}
700 Earlier versions of LyX just swallow this extra token silently.
702 2002-08-12 Angus Leeming <leeming@lyx.org>
704 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
705 renamed as "size_kind" and "lyxsize_kind" respectively.
707 \begin_inset Graphics FormatVersion 1
714 - lyxsize_kind original
715 + lyxsize_type original