1 LyX file-format changes
2 -----------------------§
4 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
6 * format incremented to 254: new header parameter \use_esint.
7 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
10 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
12 * format incremented to 253: new nomenclature and printnomenclature
13 insets. These are standard InsetCommand with the following parameters:
14 \nomenclature[prefix]{symbol}{description}
15 \printnomenclature[labelwidth]
17 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
19 * format incremented to 252: changed command inset syntax
23 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
34 \begin_inset LatexCommand cmdname
41 The order of the parameters and for each parameter the name and
42 optional/required bit is now stored in InsetCommandParams.
44 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
46 * format incremented to 251: save show_label param for charstyles.
48 On revert, the show_label param is just removed. Nothing to convert.
50 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
52 * Format incremented to 250: allow optional arg to environments
54 No material format change. Now optargs for environments are allowed
55 to be specified in layout files and will be handled properly. When
56 converted back to older formats, they will be ignored in LaTeX
59 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
61 * format incremented to 249: Unicode
63 LyX documents are now always encoded in utf8. The value of
64 \inputencoding does now only determine the encoding of the created
66 Up to format 248 the value of \inputencoding did also determine the
67 encoding of the LyX file:
69 \inputencoding LyX file encoding
70 auto as determined by the document language
72 everything else as determined by \inputencoding
74 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
76 * format incremented to 248: Basic booktabs support
78 The <features> tag has a new switch: booktabs="true|false".
79 An absent switch is equivalent to booktabs="false".
80 Horizontal lines are set with the booktabs package if this switch
83 The <row> tag of tabulars has the following new attributes:
84 topspace, bottomspace and interlinespace. All take a LyXLength
85 as value, or the special keyword "default".
87 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
89 * format incremented to 247. The Grand Font Interface Rewrite.
90 (1) Split font selection to rm, sf, tt:
91 \fontscheme -> \font_roman, \font_sans, \font_typewriter
93 \fontscheme \font_roman \font_sans \font_typewriter
94 default default default default
96 times times default default
97 palatino palatino default default
98 helvet default helvet default
99 avant default avant default
100 newcent newcent default default
101 bookman bookman default default
102 pslatex times (or \usepackage{pslatex})
104 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
105 lmodern, charter, utopia, ccfonts, chancery, beraserif
106 (-> \usepackage{<name>})
107 \font_sans: cmss, lmss, cmbr
108 (-> \renewcommand{\sfdefault}{<name>})
109 berasans (-> \usepackage{<name>})
110 \font_typewriter: cmtt, lmtt, cmtl,
111 (-> \renewcommand{\sfdefault}{<name>})
112 courier, luximono, beramono
113 (-> \usepackage{<name>})
114 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
115 (3) New param \font_sc (true, false).
116 (4) New param \font_osf (true, false).
117 (5) New param \font_sf_scale (float)
118 (6) New param \font_tt_scale (float)
119 Support for the following fonts has been added:
120 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
121 courier, lmodern, luximono, utopia.
122 Support for the following font has been removed:
123 pslatex (it's superseded by mathptmx (times)).
125 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
127 * format incremented to 246. The framed.sty package is
128 now supported with note types framed and shaded.
130 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
132 * format incremented to 245. The \quotes_times parameter
135 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
137 * format incremented to 244. Rename '\InsetSpace \,'
138 to '\InsetSpace \thinspace{}', because the comma was
139 not parsed by lyxlex, and '\InsetSpace \space' to
140 '\InsetSpace \space{}' in favour of consistency.
142 2005-07-18 José Matos <jamatos@lyx.org>
144 * format incremented to 243.
146 * this change only affects the preamble, the paperpackage
147 option was removed and papersize is changed to default.
149 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
151 * format incremented to 242. There is no file format per
152 se, but the "frenchb" language has been removed from lib/language
153 and has to be translated to "french" by lyx2lyx.
155 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
157 * format incremented to 241.
159 All following changes apply only to text in ERT insets. The
160 rationale is that text in ERT is simply ASCII text, and nothing more.
162 * paragraph breaks are now a single newline in latex and not a
163 paragraph break anymore (bug 698).
164 * \newline is not allowed anymore, because it is redundant (see above)
165 * layouts other than Standard, paragraph parameters and font changes
166 are not allowed anymore. They never made sense and were ignored for
167 latex output, but now they can't be read or set anymore (bug 922).
170 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
172 * format incremented to 240.
174 \output_changes {true|false}
175 (should the change tracking marks be visible in the output or not?)
176 * lyx2lyx should just delete the param in 239.
178 2005-01-06 José Matos <jamatos@lyx.org>
180 * format incremented to 239.
181 * the paragraph parameters are displayed in their own line. This
182 change is consistent with the insets behaviour, and corresponds
183 to a more uniform treatment of the paragraphs since some of them
184 had already their own line.
186 An example of a single paragraph follows:
188 \begin_layout Standard
189 \paragraph_spacing single
195 2004-12-03 José Matos <jamatos@lyx.org>
197 * format incremented to 238.
198 * The compatibility code to read old latex accents from 0.12.x in
199 InsetLatexAccent::checkContents has been removed.
200 The following translations are done:
202 "\i \xy" -> "\i \x{y}"
203 "\i \x y" -> "\i \x{y}"
204 "\i \x\i" -> "\i \x{\i}"
205 "\i \x\j" -> "\i \x{\j}"
206 x is a latex accent command, y the base character. \, i and j are
208 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
209 so formats 215 - 237 can have both versions.
212 2004-10-10 José Matos <jamatos@lyx.org>
214 * format incremented to 237.
215 * In the header, the following statments use now booleans values,
221 2004-08-15 José Matos <jamatos@lyx.org>
223 * format incremented to 236.
230 * The options for \papersize are changed:
233 * All whitespaces are removed at the end of lines, when
234 not necessary. As an example we have all the lines in the header that
235 do not belong to the preamble.
237 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
239 * format incremented to 235.
240 * \paperpackage had an off-by-one error. Translation table:
242 234: a4 a4wide widemarginsa4
243 235: none a4 a4wide widemarginsa4
245 The "widemarginsa4" setting of 235 has no equivalent in 234.
247 2004-05-12 Angus Leeming <leeming@lyx.org>
249 * format incremented to 234.
250 * the citation engine is specified explicitly rather than being
251 deduced from 3 bools.
254 \use_numerical_citations 0 -> \cite_engine <style>
257 where <style> is one of "basic", "natbib_authoryear",
258 "natbib_numerical" or "jurabib".
260 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
262 * format incremented to 233.
263 * insetgraphics does not allow filenames without extension anymore.
264 The complete filename has to be given.
266 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
268 * format incremented to 232.
270 * Support for bibtopic (sectioned bibliographies).
271 - bufferparam \use_bibtopic [1|0]
272 - the bibtex inset has a second argument for bibtopic's
273 btPrint{Cited|NotCited|All} command:
275 \begin_inset LatexCommand \bibtex[<style>]{<database>}
277 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
278 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
279 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
280 \bibliographystyle{<style>}
281 \begin{btSect}{<database>}
286 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
288 * format incremented to 231.
290 * Support for sidewaysfigure/sidewaystable (rotating package).
291 insetfloat has now a param \sideways [true|false] (default is false).
292 The param should be erased on downwards conversion, if it was true,
293 the inset should be replaced by
294 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
296 \begin{sidewaystable} <content> \end{sidewaystable}
299 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
301 * format incremented to 230.
303 * Support for a second optional argument in insetcommand.
304 currently, citation uses this to support natbibs second
305 optional argument \cite[before][after]{key}.
306 I think there's nothing to convert upwards. Downwards, the
307 commands with 2 optional args need to be converted to ERT.
309 * Support for jurabib (param \use_jurabib [1|0], default is 0).
310 When converting downwards, \usepackage{jurabib} has to be added
311 to the preamble and, if babel is used, \usepackage{babel} before
312 (jurabib fails if babel is called afterwards). If the natbib commands
313 are used together with jurabib, they have to be converted to ERT too.
315 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
317 * format incremented to 229.
318 * Minipages cannot be read anymore. All minipage insets will
319 be converted to frameless box insets between 228->229.
321 2003-12-15 Angus Leeming <leeming@lyx.org>
323 * format incremented to 228.
324 * Change the output of all insets derived from InsetCollapsable
325 except for InsetERT (which has a similar output already), changing lines
326 "collapsed true" -> "status collapsed"
327 "collapsed false" -> "status open".
328 * Change the output of InsetERT, changing lines
329 "status Collapsed" -> "status collapsed"
330 "status Open" -> "status open".
331 "status Inlined" -> "status inlined".
333 2003-12-10 Angus Leeming <leeming@lyx.org>
335 * format NOT incremented.
336 * add a 'draft' option to InsetExternal.
338 2003-12-10 Angus Leeming <leeming@lyx.org>
340 * format incremented to 227.
341 * Change the output of InsetBox:
342 \begin_inset Boxed -> \begin_inset Box Boxed
343 \begin_inset Doublebox -> \begin_inset Box Doublebox
344 \begin_inset Frameless -> \begin_inset Box Frameless
345 \begin_inset ovalbox -> \begin_inset Box ovalbox
346 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
347 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
349 2003-12-10 Angus Leeming <leeming@lyx.org>
351 * format incremented to 226.
352 * Change the output of InsetNote:
353 \begin_inset Note -> \begin_inset Note Note
354 \begin_inset Comment -> \begin_inset Note Comment
355 \begin_inset Greyedout -> \begin_inset Note Greyedout
357 2003-11-28 André Pönitz
359 * Remove space_above/space_below from Paragraph.
360 This is now handled by InsetVSpace.
362 2003-10-07 Angus Leeming <leeming@lyx.org>
364 * Add transformations to InsetExternal
366 boundingBox 0 0 20 20 the dimensions of the B.B..
367 Output if the B.B. is not empty.
368 clip clip the image to the B.B.
370 extra LaTeX "draft" 'extra' data passed to the primary
371 command for this output format.
372 (Possible formats LaTeX, PDFLaTeX,
373 LinuxDoc, DocBook, Ascii.)
374 The string can contain spaces and so
376 rotateAngle 30 Rotation of the data.
377 Output for non-zero rotation only.
378 rotateOrigin bottomleft Rotation origin.
379 Output for non-zero rotation and
380 non-default origin (center) only.
382 width 2cm Output only if the image is resized.
386 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
388 * Added box inset. File format:
390 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
395 inner_pos "b" t/c/b/s
397 width "100col%" unit+width-string
398 special "none" none/height/depth
400 height "1in" unit+width-string
401 height_special "totalheight" none/height/depth
403 collapsed false true/false
405 \begin_layout Standard
412 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
413 the pre-existing Minipage inset. Parameters translate as follows:
414 position 0/1/2 -> t/c/b
415 inner_position 0/1/2/3 -> inner_pos c/t/b/s
420 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
422 * attribute valignment="center" is replaced by valignment="middle"
423 for tabular columns and cells
425 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
427 * Added branch inset. File format:
429 branch definition in the header:
435 \begin_inset Branch <branchname>
436 collapsed false true/false
438 \begin_layout Standard
445 2003-07-28 José Matos <jamatos@lyx.org>
447 * \the_end is replaced with \end_document
449 2003-07-28 José Matos <jamatos@lyx.org>
451 * \layout is replaced with \begin_layout
453 2003-07-28 José Matos <jamatos@fep.up.pt>
457 * All layouts finish now with \end_layout
459 2003-06-04 Angus Leeming <leeming@lyx.org>
463 * the storage of the external inset has been changed from
465 \begin_inset External XFig,"file.fig",""
471 \begin_inset External
474 display <display_type>
479 throwing away the final arg (here "", more generally "<string>") that holds
480 the parameters variable.
481 Variables are output if present (filename) or different from the default
482 values (display, lyxscale).
484 Moreover, the RasterImage template has been scrapped. All RasterImage
485 external insets are now converted to Graphics insets.
487 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
489 * Added new space insets:
490 \SpecialChar ~ is now \InsetSpace ~
491 ERT: "\ " could be converted to InsetSpace \<space>
492 ERT: "\," could be converted to InsetSpace \,
494 2003-04-24 André Pönitz <poenitz@gmx.net>
496 * Added eqref support:
497 \begin_inset LatexCommand \eqref{label}
499 2003-03-14 Dekel Tsur
501 * Format bumped to 223.
503 2003-03-12 John Levon <levon@movementarian.org>
505 * Added \\end_header to signify the end of the header in a
508 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
510 2003-02-10 John Levon <levon@movementarian.org>
514 Added \\tracking_changes 0|1 to the header.
516 Added \\author to the header. This can be present multiple
517 times, and is of the form :
519 \\author "Real Name" email@address.com
521 Added \\change_deleted, \\change_inserted. Each of these does not
522 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
525 \\change_inserted author time
527 where author is an integer ID reference into the author list in
528 the header, and time is time_t.
530 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
532 * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
534 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
536 New graphics dialog. With the removal of buttons in the dialog, also
537 keywords in the graphics inset went. The following keywords do not
547 Only non-default values are saved to the lyx files. The defaults of the remaining
557 BoundingBox <from file>
560 rotateOrigin centerBaseline
562 subcaptionText <empty>
565 The remaining keywords have sufficient overlap with the old ones for a
566 smooth reading of the 1.2.x inset keywords in most common cases.
568 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
569 They don't exist anymore and we can't translate them into a scaling value, while
570 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
571 argument is ignored and lost.
573 Only few compatibility issues are left for lyx2lyx:
575 ------------------------------------------------------------------------------
576 old-token new-token remove
577 ------------------------------------------------------------------------------
578 size_kind original / size_type 0 scale 100 width <val>
582 size_kind width_height / size_type 1 - scale <val>
584 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
585 ------------------------------------------------------------------------------
586 [replace old-token by new-token, and remove any of subsequent tokens as listed]
588 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
589 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
591 replace "rotateAngle <val>" by "rotateAngle 0"
594 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
596 Added \lyxlock for locked math inset when written to .lyx file.
597 When "downgrading" .lyx files this should simple be deleted but it
598 does not hurt at all if it stays in. It does not have to be added
602 2002-08-02 Angus Leeming <leeming@lyx.org>
604 Added a boolean "preview" flag to InsetCommandParams.
605 Currently it is written only by InsetInclude, because only this
606 class can generate a preview of its contents.
608 The LyX file now contains:
610 \begin_inset Include \input{snapshot_t=40.tex}
615 Earlier versions of LyX just swallow this extra token silently.
617 2002-08-12 Angus Leeming <leeming@lyx.org>
619 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
620 renamed as "size_kind" and "lyxsize_kind" respectively.
622 \begin_inset Graphics FormatVersion 1
629 - lyxsize_kind original
630 + lyxsize_type original