1 LyX file-format changes
2 -----------------------§
4 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 256: allow some new inputenc settings.
7 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
9 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
11 * format incremented to 255: new insets for \clearpage and
12 \cleardoublepage. They are written inline to the file, exactly like
15 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
17 * format incremented to 254: new header parameter \use_esint.
18 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
21 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
23 * format incremented to 253: new nomenclature and printnomenclature
24 insets. These are standard InsetCommand with the following parameters:
25 \nomenclature[prefix]{symbol}{description}
26 \printnomenclature[labelwidth]
28 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
30 * format incremented to 252: changed command inset syntax
34 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
45 \begin_inset LatexCommand cmdname
52 The order of the parameters and for each parameter the name and
53 optional/required bit is now stored in InsetCommandParams.
55 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
57 * format incremented to 251: save show_label param for charstyles.
59 On revert, the show_label param is just removed. Nothing to convert.
61 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
63 * Format incremented to 250: allow optional arg to environments
65 No material format change. Now optargs for environments are allowed
66 to be specified in layout files and will be handled properly. When
67 converted back to older formats, they will be ignored in LaTeX
70 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
72 * format incremented to 249: Unicode
74 LyX documents are now always encoded in utf8. The value of
75 \inputencoding does now only determine the encoding of the created
77 Up to format 248 the value of \inputencoding did also determine the
78 encoding of the LyX file:
80 \inputencoding LyX file encoding
81 auto as determined by the document and character
84 everything else as determined by \inputencoding
86 The difference between auto and default is only the LaTeX output:
87 auto causes loading of the inputenc package, default does not.
89 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
91 * format incremented to 248: Basic booktabs support
93 The <features> tag has a new switch: booktabs="true|false".
94 An absent switch is equivalent to booktabs="false".
95 Horizontal lines are set with the booktabs package if this switch
98 The <row> tag of tabulars has the following new attributes:
99 topspace, bottomspace and interlinespace. All take a LyXLength
100 as value, or the special keyword "default".
102 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
104 * format incremented to 247. The Grand Font Interface Rewrite.
105 (1) Split font selection to rm, sf, tt:
106 \fontscheme -> \font_roman, \font_sans, \font_typewriter
108 \fontscheme \font_roman \font_sans \font_typewriter
109 default default default default
110 ae ae default default
111 times times default default
112 palatino palatino default default
113 helvet default helvet default
114 avant default avant default
115 newcent newcent default default
116 bookman bookman default default
117 pslatex times (or \usepackage{pslatex})
119 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
120 lmodern, charter, utopia, ccfonts, chancery, beraserif
121 (-> \usepackage{<name>})
122 \font_sans: cmss, lmss, cmbr
123 (-> \renewcommand{\sfdefault}{<name>})
124 berasans (-> \usepackage{<name>})
125 \font_typewriter: cmtt, lmtt, cmtl,
126 (-> \renewcommand{\sfdefault}{<name>})
127 courier, luximono, beramono
128 (-> \usepackage{<name>})
129 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
130 (3) New param \font_sc (true, false).
131 (4) New param \font_osf (true, false).
132 (5) New param \font_sf_scale (float)
133 (6) New param \font_tt_scale (float)
134 Support for the following fonts has been added:
135 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
136 courier, lmodern, luximono, utopia.
137 Support for the following font has been removed:
138 pslatex (it's superseded by mathptmx (times)).
140 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
142 * format incremented to 246. The framed.sty package is
143 now supported with note types framed and shaded.
145 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
147 * format incremented to 245. The \quotes_times parameter
150 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
152 * format incremented to 244. Rename '\InsetSpace \,'
153 to '\InsetSpace \thinspace{}', because the comma was
154 not parsed by lyxlex, and '\InsetSpace \space' to
155 '\InsetSpace \space{}' in favour of consistency.
157 2005-07-18 José Matos <jamatos@lyx.org>
159 * format incremented to 243.
161 * this change only affects the preamble, the paperpackage
162 option was removed and papersize is changed to default.
164 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
166 * format incremented to 242. There is no file format per
167 se, but the "frenchb" language has been removed from lib/language
168 and has to be translated to "french" by lyx2lyx.
170 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
172 * format incremented to 241.
174 All following changes apply only to text in ERT insets. The
175 rationale is that text in ERT is simply ASCII text, and nothing more.
177 * paragraph breaks are now a single newline in latex and not a
178 paragraph break anymore (bug 698).
179 * \newline is not allowed anymore, because it is redundant (see above)
180 * layouts other than Standard, paragraph parameters and font changes
181 are not allowed anymore. They never made sense and were ignored for
182 latex output, but now they can't be read or set anymore (bug 922).
185 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
187 * format incremented to 240.
189 \output_changes {true|false}
190 (should the change tracking marks be visible in the output or not?)
191 * lyx2lyx should just delete the param in 239.
193 2005-01-06 José Matos <jamatos@lyx.org>
195 * format incremented to 239.
196 * the paragraph parameters are displayed in their own line. This
197 change is consistent with the insets behaviour, and corresponds
198 to a more uniform treatment of the paragraphs since some of them
199 had already their own line.
201 An example of a single paragraph follows:
203 \begin_layout Standard
204 \paragraph_spacing single
210 2004-12-03 José Matos <jamatos@lyx.org>
212 * format incremented to 238.
213 * The compatibility code to read old latex accents from 0.12.x in
214 InsetLatexAccent::checkContents has been removed.
215 The following translations are done:
217 "\i \xy" -> "\i \x{y}"
218 "\i \x y" -> "\i \x{y}"
219 "\i \x\i" -> "\i \x{\i}"
220 "\i \x\j" -> "\i \x{\j}"
221 x is a latex accent command, y the base character. \, i and j are
223 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
224 so formats 215 - 237 can have both versions.
227 2004-10-10 José Matos <jamatos@lyx.org>
229 * format incremented to 237.
230 * In the header, the following statments use now booleans values,
236 2004-08-15 José Matos <jamatos@lyx.org>
238 * format incremented to 236.
245 * The options for \papersize are changed:
248 * All whitespaces are removed at the end of lines, when
249 not necessary. As an example we have all the lines in the header that
250 do not belong to the preamble.
252 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
254 * format incremented to 235.
255 * \paperpackage had an off-by-one error. Translation table:
257 234: a4 a4wide widemarginsa4
258 235: none a4 a4wide widemarginsa4
260 The "widemarginsa4" setting of 235 has no equivalent in 234.
262 2004-05-12 Angus Leeming <leeming@lyx.org>
264 * format incremented to 234.
265 * the citation engine is specified explicitly rather than being
266 deduced from 3 bools.
269 \use_numerical_citations 0 -> \cite_engine <style>
272 where <style> is one of "basic", "natbib_authoryear",
273 "natbib_numerical" or "jurabib".
275 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
277 * format incremented to 233.
278 * insetgraphics does not allow filenames without extension anymore.
279 The complete filename has to be given.
281 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
283 * format incremented to 232.
285 * Support for bibtopic (sectioned bibliographies).
286 - bufferparam \use_bibtopic [1|0]
287 - the bibtex inset has a second argument for bibtopic's
288 btPrint{Cited|NotCited|All} command:
290 \begin_inset LatexCommand \bibtex[<style>]{<database>}
292 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
293 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
294 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
295 \bibliographystyle{<style>}
296 \begin{btSect}{<database>}
301 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
303 * format incremented to 231.
305 * Support for sidewaysfigure/sidewaystable (rotating package).
306 insetfloat has now a param \sideways [true|false] (default is false).
307 The param should be erased on downwards conversion, if it was true,
308 the inset should be replaced by
309 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
311 \begin{sidewaystable} <content> \end{sidewaystable}
314 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
316 * format incremented to 230.
318 * Support for a second optional argument in insetcommand.
319 currently, citation uses this to support natbibs second
320 optional argument \cite[before][after]{key}.
321 I think there's nothing to convert upwards. Downwards, the
322 commands with 2 optional args need to be converted to ERT.
324 * Support for jurabib (param \use_jurabib [1|0], default is 0).
325 When converting downwards, \usepackage{jurabib} has to be added
326 to the preamble and, if babel is used, \usepackage{babel} before
327 (jurabib fails if babel is called afterwards). If the natbib commands
328 are used together with jurabib, they have to be converted to ERT too.
330 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
332 * format incremented to 229.
333 * Minipages cannot be read anymore. All minipage insets will
334 be converted to frameless box insets between 228->229.
336 2003-12-15 Angus Leeming <leeming@lyx.org>
338 * format incremented to 228.
339 * Change the output of all insets derived from InsetCollapsable
340 except for InsetERT (which has a similar output already), changing lines
341 "collapsed true" -> "status collapsed"
342 "collapsed false" -> "status open".
343 * Change the output of InsetERT, changing lines
344 "status Collapsed" -> "status collapsed"
345 "status Open" -> "status open".
346 "status Inlined" -> "status inlined".
348 2003-12-10 Angus Leeming <leeming@lyx.org>
350 * format NOT incremented.
351 * add a 'draft' option to InsetExternal.
353 2003-12-10 Angus Leeming <leeming@lyx.org>
355 * format incremented to 227.
356 * Change the output of InsetBox:
357 \begin_inset Boxed -> \begin_inset Box Boxed
358 \begin_inset Doublebox -> \begin_inset Box Doublebox
359 \begin_inset Frameless -> \begin_inset Box Frameless
360 \begin_inset ovalbox -> \begin_inset Box ovalbox
361 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
362 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
364 2003-12-10 Angus Leeming <leeming@lyx.org>
366 * format incremented to 226.
367 * Change the output of InsetNote:
368 \begin_inset Note -> \begin_inset Note Note
369 \begin_inset Comment -> \begin_inset Note Comment
370 \begin_inset Greyedout -> \begin_inset Note Greyedout
372 2003-11-28 André Pönitz
374 * Remove space_above/space_below from Paragraph.
375 This is now handled by InsetVSpace.
377 2003-10-07 Angus Leeming <leeming@lyx.org>
379 * Add transformations to InsetExternal
381 boundingBox 0 0 20 20 the dimensions of the B.B..
382 Output if the B.B. is not empty.
383 clip clip the image to the B.B.
385 extra LaTeX "draft" 'extra' data passed to the primary
386 command for this output format.
387 (Possible formats LaTeX, PDFLaTeX,
388 LinuxDoc, DocBook, Ascii.)
389 The string can contain spaces and so
391 rotateAngle 30 Rotation of the data.
392 Output for non-zero rotation only.
393 rotateOrigin bottomleft Rotation origin.
394 Output for non-zero rotation and
395 non-default origin (center) only.
397 width 2cm Output only if the image is resized.
401 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
403 * Added box inset. File format:
405 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
410 inner_pos "b" t/c/b/s
412 width "100col%" unit+width-string
413 special "none" none/height/depth
415 height "1in" unit+width-string
416 height_special "totalheight" none/height/depth
418 collapsed false true/false
420 \begin_layout Standard
427 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
428 the pre-existing Minipage inset. Parameters translate as follows:
429 position 0/1/2 -> t/c/b
430 inner_position 0/1/2/3 -> inner_pos c/t/b/s
435 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
437 * attribute valignment="center" is replaced by valignment="middle"
438 for tabular columns and cells
440 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
442 * Added branch inset. File format:
444 branch definition in the header:
450 \begin_inset Branch <branchname>
451 collapsed false true/false
453 \begin_layout Standard
460 2003-07-28 José Matos <jamatos@lyx.org>
462 * \the_end is replaced with \end_document
464 2003-07-28 José Matos <jamatos@lyx.org>
466 * \layout is replaced with \begin_layout
468 2003-07-28 José Matos <jamatos@fep.up.pt>
472 * All layouts finish now with \end_layout
474 2003-06-04 Angus Leeming <leeming@lyx.org>
478 * the storage of the external inset has been changed from
480 \begin_inset External XFig,"file.fig",""
486 \begin_inset External
489 display <display_type>
494 throwing away the final arg (here "", more generally "<string>") that holds
495 the parameters variable.
496 Variables are output if present (filename) or different from the default
497 values (display, lyxscale).
499 Moreover, the RasterImage template has been scrapped. All RasterImage
500 external insets are now converted to Graphics insets.
502 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
504 * Added new space insets:
505 \SpecialChar ~ is now \InsetSpace ~
506 ERT: "\ " could be converted to InsetSpace \<space>
507 ERT: "\," could be converted to InsetSpace \,
509 2003-04-24 André Pönitz <poenitz@gmx.net>
511 * Added eqref support:
512 \begin_inset LatexCommand \eqref{label}
514 2003-03-14 Dekel Tsur
516 * Format bumped to 223.
518 2003-03-12 John Levon <levon@movementarian.org>
520 * Added \\end_header to signify the end of the header in a
523 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
525 2003-02-10 John Levon <levon@movementarian.org>
529 Added \\tracking_changes 0|1 to the header.
531 Added \\author to the header. This can be present multiple
532 times, and is of the form :
534 \\author "Real Name" email@address.com
536 Added \\change_deleted, \\change_inserted. Each of these does not
537 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
540 \\change_inserted author time
542 where author is an integer ID reference into the author list in
543 the header, and time is time_t.
545 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
547 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
549 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
551 New graphics dialog. With the removal of buttons in the dialog, also
552 keywords in the graphics inset went. The following keywords do not
562 Only non-default values are saved to the lyx files. The defaults of the remaining
572 BoundingBox <from file>
575 rotateOrigin centerBaseline
577 subcaptionText <empty>
580 The remaining keywords have sufficient overlap with the old ones for a
581 smooth reading of the 1.2.x inset keywords in most common cases.
583 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
584 They don't exist anymore and we can't translate them into a scaling value, while
585 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
586 argument is ignored and lost.
588 Only few compatibility issues are left for lyx2lyx:
590 ------------------------------------------------------------------------------
591 old-token new-token remove
592 ------------------------------------------------------------------------------
593 size_kind original / size_type 0 scale 100 width <val>
597 size_kind width_height / size_type 1 - scale <val>
599 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
600 ------------------------------------------------------------------------------
601 [replace old-token by new-token, and remove any of subsequent tokens as listed]
603 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
604 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
606 replace "rotateAngle <val>" by "rotateAngle 0"
609 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
611 Added \lyxlock for locked math inset when written to .lyx file.
612 When "downgrading" .lyx files this should simple be deleted but it
613 does not hurt at all if it stays in. It does not have to be added
617 2002-08-02 Angus Leeming <leeming@lyx.org>
619 Added a boolean "preview" flag to InsetCommandParams.
620 Currently it is written only by InsetInclude, because only this
621 class can generate a preview of its contents.
623 The LyX file now contains:
625 \begin_inset Include \input{snapshot_t=40.tex}
630 Earlier versions of LyX just swallow this extra token silently.
632 2002-08-12 Angus Leeming <leeming@lyx.org>
634 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
635 renamed as "size_kind" and "lyxsize_kind" respectively.
637 \begin_inset Graphics FormatVersion 1
644 - lyxsize_kind original
645 + lyxsize_type original