1 LyX file-format changes
2 -----------------------
4 2007-05-08 Bo Peng <ben.bob@gmail.com>
5 * format incremented to 269: add listings support
6 - add preamble flag \listings_params, e.g. \listings_params "language=Python,float"
7 - add inset listings, with options lstparams and inline, e.g.
9 lstparams "xleftmargin=50pt,language=Python"
11 - add \lstinputlisting Include type. e.g.
12 \begin_inset Include \lstinputlisting{newfile1.lyx}[firstline=10,lastline=15]
14 2007-05-06 Uwe Stöhr <uwestoehr@web.de>
16 * format incremented to 268: add support for the CJK encodings
17 - all encodings supported by CJK.sty are now in lib/encodings
18 - lib/encoding has got two new flags:
20 "inputenc" for those languages that use the inputenc-package and
21 "CJK" for the CJK encodings
22 - "fixed"/"variable" to divide between multi- or single-byte encoding
23 - lib/languages allows now to set an empty language for babel
24 in this case babel isn't called.
26 2007-05-04 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
28 * format incremented to 267: add plain utf8 encoding (for XeTeX).
30 2007-04-29 Uwe Stöhr <uwestoehr@web.de>
32 * format incremented to 266:
33 Support for the Armenian language
35 2007-04-26 Uwe Stöhr <uwestoehr@web.de>
37 * format incremented to 265: fix LyX's table border line handling
38 With the fix (see bug 1746) LyX now takes care if the user has entered
39 a "|" character in the argument field of tables. Therefore the "|"
40 character has to be removed when also a table border is set.
42 2007-04-24 José Matos <jamatos@lyx.org>
44 * format incremented to 264:
45 textclass cv is renamed simplecv
47 2007-02-22 José Matos <jamatos@lyx.org>
49 * format incremented to 263: changes in the language names (overdue):
51 portuges -> portuguese
53 2007-02-16 Georg Baum <Georg.Baum@post.rwth-aachen.de>
55 * format incremented to 262: Allow ascii \inputencoding
57 2007-02-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
59 * format incremented to 261: \output_changes is now considered
60 even if \tracking_changes is false. This allows to output existing
61 changes even if future changes are not tracked anymore.
64 \tracking_changes false
67 is therefore converted to
69 \tracking_changes false
72 on upgrade. Nothing is done on downgrade since the new behaviour is
73 not supported in older formats.
75 2007-02-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
77 * format incremented to 260: Allow utf8x \inputencoding
79 2007-02-12 Georg Baum <Georg.Baum@post.rwth-aachen.de>
81 * format incremented to 259:
82 Old: Spaces at start or end of font changes were output outside of
83 the font change, i.e. not 'xx\textbf{ yy }zz', but
85 New: Spaces are always output with the font set by the user.
87 2007-01-31 Uwe Stöhr <uwestoehr@web.de>
89 * format incremented to 258: new \lyxline definition
91 \\newcommand{\\lyxline}[1]{
92 {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}}
95 \\newcommand{\\lyxline}[1][1pt]{%
97 \\rule[.5ex]{\\linewidth}{#1}\\par}
98 The new definition is more robust, see bug 1988 and now really takes care about
99 the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
101 2007-01-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
103 * format incremented to 257: Caption styles have been replaced by
104 InsetCaption. This is at the same time also a layout file format
105 change to format 3. layout2layout removes caption layouts from old
107 Note that InsetCaption did exist before this format, but was never
108 used. Old files containing do nevertheless still work.
109 Of course users can still define a Caption style in layout files,
110 but the special treatment in LyX is gone (apart from the sensitive
113 2006-12-22 Georg Baum <Georg.Baum@post.rwth-aachen.de>
115 * format incremented to 256: allow some new inputenc settings.
116 For the complete list, see lib/lyx2lyx/lyx_1_5.py.
118 2006-11-25 Georg Baum <Georg.Baum@post.rwth-aachen.de>
120 * format incremented to 255: new insets for \clearpage and
121 \cleardoublepage. They are written inline to the file, exactly like
124 2006-11-13 Georg Baum <Georg.Baum@post.rwth-aachen.de>
126 * format incremented to 254: new header parameter \use_esint.
127 It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
130 2006-10-18 Georg Baum <Georg.Baum@post.rwth-aachen.de>
132 * format incremented to 253: new nomenclature and printnomenclature
133 insets. These are standard InsetCommand with the following parameters:
134 \nomenclature[prefix]{symbol}{description}
135 \printnomenclature[labelwidth]
137 2006-10-15 Georg Baum <Georg.Baum@post.rwth-aachen.de>
139 * format incremented to 252: changed command inset syntax
143 \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
154 \begin_inset LatexCommand cmdname
161 The order of the parameters and for each parameter the name and
162 optional/required bit is now stored in InsetCommandParams.
164 2006-10-03 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
166 * format incremented to 251: save show_label param for charstyles.
168 On revert, the show_label param is just removed. Nothing to convert.
170 2006-10-12 Martin Vermeer <martin.vermeer@hut.fi>
172 * Format incremented to 250: allow optional arg to environments
174 No material format change. Now optargs for environments are allowed
175 to be specified in layout files and will be handled properly. When
176 converted back to older formats, they will be ignored in LaTeX
179 2006-08-14 Georg Baum <Georg.Baum@post.rwth-aachen.de>
181 * format incremented to 249: Unicode
183 LyX documents are now always encoded in utf8. The value of
184 \inputencoding does now only determine the encoding of the created
186 Up to format 248 the value of \inputencoding did also determine the
187 encoding of the LyX file:
189 \inputencoding LyX file encoding
190 auto as determined by the document and character
193 everything else as determined by \inputencoding
195 The difference between auto and default is only the LaTeX output:
196 auto causes loading of the inputenc package, default does not.
198 2006-07-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
200 * format incremented to 248: Basic booktabs support
202 The <features> tag has a new switch: booktabs="true|false".
203 An absent switch is equivalent to booktabs="false".
204 Horizontal lines are set with the booktabs package if this switch
207 The <row> tag of tabulars has the following new attributes:
208 topspace, bottomspace and interlinespace. All take a LyXLength
209 as value, or the special keyword "default".
211 2006-06-10 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
213 * format incremented to 247. The Grand Font Interface Rewrite.
214 (1) Split font selection to rm, sf, tt:
215 \fontscheme -> \font_roman, \font_sans, \font_typewriter
217 \fontscheme \font_roman \font_sans \font_typewriter
218 default default default default
219 ae ae default default
220 times times default default
221 palatino palatino default default
222 helvet default helvet default
223 avant default avant default
224 newcent newcent default default
225 bookman bookman default default
226 pslatex times (or \usepackage{pslatex})
228 \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}),
229 lmodern, charter, utopia, ccfonts, chancery, beraserif
230 (-> \usepackage{<name>})
231 \font_sans: cmss, lmss, cmbr
232 (-> \renewcommand{\sfdefault}{<name>})
233 berasans (-> \usepackage{<name>})
234 \font_typewriter: cmtt, lmtt, cmtl,
235 (-> \renewcommand{\sfdefault}{<name>})
236 courier, luximono, beramono
237 (-> \usepackage{<name>})
238 (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
239 (3) New param \font_sc (true, false).
240 (4) New param \font_osf (true, false).
241 (5) New param \font_sf_scale (float)
242 (6) New param \font_tt_scale (float)
243 Support for the following fonts has been added:
244 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
245 courier, lmodern, luximono, utopia.
246 Support for the following font has been removed:
247 pslatex (it's superseded by mathptmx (times)).
249 2006-06-03 Martin Vermeer <martin.vermeer@hut.fi>
251 * format incremented to 246. The framed.sty package is
252 now supported with note types framed and shaded.
254 2005-10-12 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
256 * format incremented to 245. The \quotes_times parameter
259 2005-09-24 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
261 * format incremented to 244. Rename '\InsetSpace \,'
262 to '\InsetSpace \thinspace{}', because the comma was
263 not parsed by lyxlex, and '\InsetSpace \space' to
264 '\InsetSpace \space{}' in favour of consistency.
266 2005-07-18 José Matos <jamatos@lyx.org>
268 * format incremented to 243.
270 * this change only affects the preamble, the paperpackage
271 option was removed and papersize is changed to default.
273 2005-06-21 Jean-Marc Lasgouttes <lasgouttes@lyx.org>
275 * format incremented to 242. There is no file format per
276 se, but the "frenchb" language has been removed from lib/language
277 and has to be translated to "french" by lyx2lyx.
279 2005-02-03 Georg Baum <Georg.Baum@post.rwth-aachen.de>
281 * format incremented to 241.
283 All following changes apply only to text in ERT insets. The
284 rationale is that text in ERT is simply ASCII text, and nothing more.
286 * paragraph breaks are now a single newline in latex and not a
287 paragraph break anymore (bug 698).
288 * \newline is not allowed anymore, because it is redundant (see above)
289 * layouts other than Standard, paragraph parameters and font changes
290 are not allowed anymore. They never made sense and were ignored for
291 latex output, but now they can't be read or set anymore (bug 922).
294 2005-01-23 Jürgen Spitzmüller <j.spitzmüller@gmx.de>
296 * format incremented to 240.
298 \output_changes {true|false}
299 (should the change tracking marks be visible in the output or not?)
300 * lyx2lyx should just delete the param in 239.
302 2005-01-06 José Matos <jamatos@lyx.org>
304 * format incremented to 239.
305 * the paragraph parameters are displayed in their own line. This
306 change is consistent with the insets behaviour, and corresponds
307 to a more uniform treatment of the paragraphs since some of them
308 had already their own line.
310 An example of a single paragraph follows:
312 \begin_layout Standard
313 \paragraph_spacing single
319 2004-12-03 José Matos <jamatos@lyx.org>
321 * format incremented to 238.
322 * The compatibility code to read old latex accents from 0.12.x in
323 InsetLatexAccent::checkContents has been removed.
324 The following translations are done:
326 "\i \xy" -> "\i \x{y}"
327 "\i \x y" -> "\i \x{y}"
328 "\i \x\i" -> "\i \x{\i}"
329 "\i \x\j" -> "\i \x{\j}"
330 x is a latex accent command, y the base character. \, i and j are
332 lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
333 so formats 215 - 237 can have both versions.
336 2004-10-10 José Matos <jamatos@lyx.org>
338 * format incremented to 237.
339 * In the header, the following statments use now booleans values,
345 2004-08-15 José Matos <jamatos@lyx.org>
347 * format incremented to 236.
354 * The options for \papersize are changed:
357 * All whitespaces are removed at the end of lines, when
358 not necessary. As an example we have all the lines in the header that
359 do not belong to the preamble.
361 2004-07-01 Georg Baum <Georg.Baum@post.rwth-aachen.de>
363 * format incremented to 235.
364 * \paperpackage had an off-by-one error. Translation table:
366 234: a4 a4wide widemarginsa4
367 235: none a4 a4wide widemarginsa4
369 The "widemarginsa4" setting of 235 has no equivalent in 234.
371 2004-05-12 Angus Leeming <leeming@lyx.org>
373 * format incremented to 234.
374 * the citation engine is specified explicitly rather than being
375 deduced from 3 bools.
378 \use_numerical_citations 0 -> \cite_engine <style>
381 where <style> is one of "basic", "natbib_authoryear",
382 "natbib_numerical" or "jurabib".
384 2004-04-29 Georg Baum <Georg.Baum@post.rwth-aachen.de>
386 * format incremented to 233.
387 * insetgraphics does not allow filenames without extension anymore.
388 The complete filename has to be given.
390 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
392 * format incremented to 232.
394 * Support for bibtopic (sectioned bibliographies).
395 - bufferparam \use_bibtopic [1|0]
396 - the bibtex inset has a second argument for bibtopic's
397 btPrint{Cited|NotCited|All} command:
399 \begin_inset LatexCommand \bibtex[<style>]{<database>}
401 \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
402 Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
403 has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
404 \bibliographystyle{<style>}
405 \begin{btSect}{<database>}
410 2004-03-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
412 * format incremented to 231.
414 * Support for sidewaysfigure/sidewaystable (rotating package).
415 insetfloat has now a param \sideways [true|false] (default is false).
416 The param should be erased on downwards conversion, if it was true,
417 the inset should be replaced by
418 \begin{sidewaysfigure} <content> \end{sidewaysfigure}
420 \begin{sidewaystable} <content> \end{sidewaystable}
423 2004-02-23 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
425 * format incremented to 230.
427 * Support for a second optional argument in insetcommand.
428 currently, citation uses this to support natbibs second
429 optional argument \cite[before][after]{key}.
430 I think there's nothing to convert upwards. Downwards, the
431 commands with 2 optional args need to be converted to ERT.
433 * Support for jurabib (param \use_jurabib [1|0], default is 0).
434 When converting downwards, \usepackage{jurabib} has to be added
435 to the preamble and, if babel is used, \usepackage{babel} before
436 (jurabib fails if babel is called afterwards). If the natbib commands
437 are used together with jurabib, they have to be converted to ERT too.
439 2003-12-29 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
441 * format incremented to 229.
442 * Minipages cannot be read anymore. All minipage insets will
443 be converted to frameless box insets between 228->229.
445 2003-12-15 Angus Leeming <leeming@lyx.org>
447 * format incremented to 228.
448 * Change the output of all insets derived from InsetCollapsable
449 except for InsetERT (which has a similar output already), changing lines
450 "collapsed true" -> "status collapsed"
451 "collapsed false" -> "status open".
452 * Change the output of InsetERT, changing lines
453 "status Collapsed" -> "status collapsed"
454 "status Open" -> "status open".
455 "status Inlined" -> "status inlined".
457 2003-12-10 Angus Leeming <leeming@lyx.org>
459 * format NOT incremented.
460 * add a 'draft' option to InsetExternal.
462 2003-12-10 Angus Leeming <leeming@lyx.org>
464 * format incremented to 227.
465 * Change the output of InsetBox:
466 \begin_inset Boxed -> \begin_inset Box Boxed
467 \begin_inset Doublebox -> \begin_inset Box Doublebox
468 \begin_inset Frameless -> \begin_inset Box Frameless
469 \begin_inset ovalbox -> \begin_inset Box ovalbox
470 \begin_inset Ovalbox -> \begin_inset Box Ovalbox
471 \begin_inset Shadowbox -> \begin_inset Box Shadowbox
473 2003-12-10 Angus Leeming <leeming@lyx.org>
475 * format incremented to 226.
476 * Change the output of InsetNote:
477 \begin_inset Note -> \begin_inset Note Note
478 \begin_inset Comment -> \begin_inset Note Comment
479 \begin_inset Greyedout -> \begin_inset Note Greyedout
481 2003-11-28 André Pönitz
483 * Remove space_above/space_below from Paragraph.
484 This is now handled by InsetVSpace.
486 2003-10-07 Angus Leeming <leeming@lyx.org>
488 * Add transformations to InsetExternal
490 boundingBox 0 0 20 20 the dimensions of the B.B..
491 Output if the B.B. is not empty.
492 clip clip the image to the B.B.
494 extra LaTeX "draft" 'extra' data passed to the primary
495 command for this output format.
496 (Possible formats LaTeX, PDFLaTeX,
497 LinuxDoc, DocBook, Ascii.)
498 The string can contain spaces and so
500 rotateAngle 30 Rotation of the data.
501 Output for non-zero rotation only.
502 rotateOrigin bottomleft Rotation origin.
503 Output for non-zero rotation and
504 non-default origin (center) only.
506 width 2cm Output only if the image is resized.
510 2003-10-07 Martin Vermeer <martin.vermeer@hut.fi>
512 * Added box inset. File format:
514 \begin_inset Ovalbox Boxed/Frameless/ovalbox/Ovalbox
519 inner_pos "b" t/c/b/s
521 width "100col%" unit+width-string
522 special "none" none/height/depth
524 height "1in" unit+width-string
525 height_special "totalheight" none/height/depth
527 collapsed false true/false
529 \begin_layout Standard
536 This box (Frameless, has_inner_box=1, use_parbox=0) replaces
537 the pre-existing Minipage inset. Parameters translate as follows:
538 position 0/1/2 -> t/c/b
539 inner_position 0/1/2/3 -> inner_pos c/t/b/s
544 2003-08-19 Michael Schmitt <michael.schmitt@teststep.org>
546 * attribute valignment="center" is replaced by valignment="middle"
547 for tabular columns and cells
549 2003-08-17 Martin Vermeer <martin.vermeer@hut.fi>
551 * Added branch inset. File format:
553 branch definition in the header:
559 \begin_inset Branch <branchname>
560 collapsed false true/false
562 \begin_layout Standard
569 2003-07-28 José Matos <jamatos@lyx.org>
571 * \the_end is replaced with \end_document
573 2003-07-28 José Matos <jamatos@lyx.org>
575 * \layout is replaced with \begin_layout
577 2003-07-28 José Matos <jamatos@fep.up.pt>
581 * All layouts finish now with \end_layout
583 2003-06-04 Angus Leeming <leeming@lyx.org>
587 * the storage of the external inset has been changed from
589 \begin_inset External XFig,"file.fig",""
595 \begin_inset External
598 display <display_type>
603 throwing away the final arg (here "", more generally "<string>") that holds
604 the parameters variable.
605 Variables are output if present (filename) or different from the default
606 values (display, lyxscale).
608 Moreover, the RasterImage template has been scrapped. All RasterImage
609 external insets are now converted to Graphics insets.
611 2003-05-20 Jürgen Spitzmüller <j.spitzmueller@gmx.de>
613 * Added new space insets:
614 \SpecialChar ~ is now \InsetSpace ~
615 ERT: "\ " could be converted to InsetSpace \<space>
616 ERT: "\," could be converted to InsetSpace \,
618 2003-04-24 André Pönitz <poenitz@gmx.net>
620 * Added eqref support:
621 \begin_inset LatexCommand \eqref{label}
623 2003-03-14 Dekel Tsur
625 * Format bumped to 223.
627 2003-03-12 John Levon <levon@movementarian.org>
629 * Added \\end_header to signify the end of the header in a
632 * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
634 2003-02-10 John Levon <levon@movementarian.org>
638 Added \\tracking_changes 0|1 to the header.
640 Added \\author to the header. This can be present multiple
641 times, and is of the form :
643 \\author "Real Name" email@address.com
645 Added \\change_deleted, \\change_inserted. Each of these does not
646 span a paragraph, and is delimited by "\\change_unchanged\n". Both are
649 \\change_inserted author time
651 where author is an integer ID reference into the author list in
652 the header, and time is time_t.
654 2002-10-24 Rob Lahaye <lahaye@snu.ac.kr>
656 * InsetGraphicsParams.h (scale): is now a float, not an unsigned int.
658 2002-08-22 Rob Lahaye <lahaye@snu.ac.kr>
660 New graphics dialog. With the removal of buttons in the dialog, also
661 keywords in the graphics inset went. The following keywords do not
671 Only non-default values are saved to the lyx files. The defaults of the remaining
681 BoundingBox <from file>
684 rotateOrigin centerBaseline
686 subcaptionText <empty>
689 The remaining keywords have sufficient overlap with the old ones for a
690 smooth reading of the 1.2.x inset keywords in most common cases.
692 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
693 They don't exist anymore and we can't translate them into a scaling value, while
694 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
695 argument is ignored and lost.
697 Only few compatibility issues are left for lyx2lyx:
699 ------------------------------------------------------------------------------
700 old-token new-token remove
701 ------------------------------------------------------------------------------
702 size_kind original / size_type 0 scale 100 width <val>
706 size_kind width_height / size_type 1 - scale <val>
708 lyxsize_kind original / lyxsize_type 0 lyxscale 100 lyxscale <val>
709 ------------------------------------------------------------------------------
710 [replace old-token by new-token, and remove any of subsequent tokens as listed]
712 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
713 if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
715 replace "rotateAngle <val>" by "rotateAngle 0"
718 2002-08-12 Andre' Poenitz <poenitz@gmx.de>
720 Added \lyxlock for locked math inset when written to .lyx file.
721 When "downgrading" .lyx files this should simple be deleted but it
722 does not hurt at all if it stays in. It does not have to be added
726 2002-08-02 Angus Leeming <leeming@lyx.org>
728 Added a boolean "preview" flag to InsetCommandParams.
729 Currently it is written only by InsetInclude, because only this
730 class can generate a preview of its contents.
732 The LyX file now contains:
734 \begin_inset Include \input{snapshot_t=40.tex}
739 Earlier versions of LyX just swallow this extra token silently.
741 2002-08-12 Angus Leeming <leeming@lyx.org>
743 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
744 renamed as "size_kind" and "lyxsize_kind" respectively.
746 \begin_inset Graphics FormatVersion 1
753 - lyxsize_kind original
754 + lyxsize_type original