]> git.lyx.org Git - lyx.git/blob - development/FORMAT
64dd3cd4ed6bec8f5254d1b220141314e0c5fc00
[lyx.git] / development / FORMAT
1 LyX file-format changes
2 -----------------------§
3
4 2007-01-31  Uwe Stöhr
5
6         * format incremented to 258: new \lyxline definition
7         Old:
8                 \\newcommand{\\lyxline}[1]{ 
9                   {#1 \\vspace{1ex} \\hrule width \\columnwidth \\vspace{1ex}} 
10                 } 
11         New:
12                 \\newcommand{\\lyxline}[1][1pt]{% 
13                   \\par\\noindent% 
14                   \\rule[.5ex]{\\linewidth}{#1}\\par}
15         The new definition is more robust, see bug 1988 and now really takes care about
16         the fontsize: \lyxline{\Huge} produces now a thicker line then \lyxline{\normalfont}
17
18 2006-12-22  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
19
20         * format incremented to 256: allow some new inputenc settings.
21         For the complete list, see lib/lyx2lyx/lyx_1_5.py.
22
23 2006-11-25  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
24
25         * format incremented to 255: new insets for \clearpage and
26         \cleardoublepage. They are written inline to the file, exactly like
27         \newpage.
28
29 2006-11-13  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
30
31         * format incremented to 254: new header parameter \use_esint.
32         It can have the same values as \use_amsmath: 0 (off), 1 (auto) and
33         2 (on).
34
35 2006-10-18  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
36
37         * format incremented to 253: new nomenclature and printnomenclature
38         insets. These are standard InsetCommand with the following parameters:
39         \nomenclature[prefix]{symbol}{description}
40         \printnomenclature[labelwidth]
41
42 2006-10-15  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
43
44         * format incremented to 252: changed command inset syntax
45
46         Old:
47
48         \begin_inset LatexCommand \cmdname[opt1][opt2]{arg}
49         preview true
50         \end_inset
51
52         and
53
54         \bibitem [opt1]{arg}
55
56
57         New:
58
59         \begin_inset LatexCommand cmdname
60         name1 "opt1"
61         name2 "opt2"
62         name3 "arg"
63         preview true
64         \end_inset
65
66         The order of the parameters and for each parameter the name and
67         optional/required bit is now stored in InsetCommandParams.
68
69 2006-10-03  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
70
71         * format incremented to 251: save show_label param for charstyles.
72
73         On revert, the show_label param is just removed. Nothing to convert.
74
75 2006-10-12  Martin Vermeer <martin.vermeer@hut.fi>
76
77         * Format incremented to 250: allow optional arg to environments
78
79         No material format change. Now optargs for environments are allowed
80         to be specified in layout files and will be handled properly. When 
81         converted back to older formats, they will be ignored in LaTeX 
82         output.
83
84 2006-08-14  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
85
86         * format incremented to 249: Unicode
87
88         LyX documents are now always encoded in utf8. The value of
89         \inputencoding does now only determine the encoding of the created
90         LaTeX file.
91         Up to format 248 the value of \inputencoding did also determine the
92         encoding of the LyX file:
93
94         \inputencoding       LyX file encoding
95         auto                 as determined by the document and character
96                              languages
97         default              ditto
98         everything else      as determined by \inputencoding
99
100         The difference between auto and default is only the LaTeX output:
101         auto causes loading of the inputenc package, default does not.
102
103 2006-07-03  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
104
105         * format incremented to 248: Basic booktabs support
106
107         The <features> tag has a new switch: booktabs="true|false".
108         An absent switch is equivalent to booktabs="false".
109         Horizontal lines are set with the booktabs package if this switch
110         is on.
111
112         The <row> tag of tabulars has the following new attributes:
113         topspace, bottomspace and interlinespace. All take a LyXLength
114         as value, or the special keyword "default".
115
116 2006-06-10  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
117
118         * format incremented to 247. The Grand Font Interface Rewrite.
119         (1) Split font selection to rm, sf, tt:
120                 \fontscheme -> \font_roman, \font_sans, \font_typewriter
121                 Change 246->247:
122                         \fontscheme     \font_roman     \font_sans      \font_typewriter
123                         default         default         default         default
124                         ae              ae              default         default
125                         times           times           default         default
126                         palatino        palatino        default         default
127                         helvet          default         helvet          default
128                         avant           default         avant           default
129                         newcent         newcent         default         default
130                         bookman         bookman         default         default
131                         pslatex         times           (or \usepackage{pslatex})
132                 New 246->247:
133                         \font_roman: cmr (-> \renewcommand{\rmdefault}{cmr}), 
134                                      lmodern, charter, utopia, ccfonts, chancery, beraserif
135                                         (-> \usepackage{<name>})
136                         \font_sans: cmss, lmss, cmbr 
137                                         (-> \renewcommand{\sfdefault}{<name>})
138                                     berasans (-> \usepackage{<name>})
139                         \font_typewriter: cmtt, lmtt, cmtl,
140                                         (-> \renewcommand{\sfdefault}{<name>})
141                                         courier, luximono, beramono
142                                         (-> \usepackage{<name>})
143         (2) New param \font_default_family (rmdefault, sfdefault, ttdefault)
144         (3) New param \font_sc (true, false).
145         (4) New param \font_osf (true, false).
146         (5) New param \font_sf_scale (float)
147         (6) New param \font_tt_scale (float)
148         Support for the following fonts has been added:
149                 bera, ccfonts, chancery, charter, cmbright, computer modern (explicitely),
150                 courier, lmodern, luximono, utopia.
151         Support for the following font has been removed:
152                 pslatex (it's superseded by mathptmx (times)).
153
154 2006-06-03  Martin Vermeer  <martin.vermeer@hut.fi>
155
156         * format incremented to 246. The framed.sty package is 
157         now supported with note types framed and shaded.
158
159 2005-10-12  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
160
161         * format incremented to 245. The \quotes_times parameter
162         has been removed.
163
164 2005-09-24  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
165
166         * format incremented to 244. Rename '\InsetSpace \,'
167         to '\InsetSpace \thinspace{}', because the comma was
168         not parsed by lyxlex, and '\InsetSpace \space' to
169         '\InsetSpace \space{}' in favour of consistency.
170
171 2005-07-18  José Matos  <jamatos@lyx.org>
172
173         * format incremented to 243.
174
175         * this change only affects the preamble, the paperpackage
176           option was removed and papersize is changed to default.
177
178 2005-06-21  Jean-Marc Lasgouttes  <lasgouttes@lyx.org>
179
180         * format incremented to 242. There is no file format per
181         se, but the "frenchb" language has been removed from lib/language
182         and has to be translated to "french" by lyx2lyx.
183
184 2005-02-03  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
185
186         * format incremented to 241.
187
188         All following changes apply only to text in ERT insets. The
189         rationale is that text in ERT is simply ASCII text, and nothing more.
190
191         * paragraph breaks are now a single newline in latex and not a
192         paragraph break anymore (bug 698).
193         * \newline is not allowed anymore, because it is redundant (see above)
194         * layouts other than Standard, paragraph parameters and font changes
195         are not allowed anymore. They never made sense and were ignored for
196         latex output, but now they can't be read or set anymore (bug 922).
197
198
199 2005-01-23  Jürgen Spitzmüller  <j.spitzmüller@gmx.de>
200
201         * format incremented to 240.
202         * new bufferparam:
203                 \output_changes {true|false}
204         (should the change tracking marks be visible in the output or not?)
205         * lyx2lyx should just delete the param in 239.
206
207 2005-01-06  José Matos  <jamatos@lyx.org>
208
209         * format incremented to 239.
210         * the paragraph parameters are displayed in their own line. This
211         change is consistent with the insets behaviour, and corresponds
212         to a more uniform treatment of the paragraphs since some of them
213         had already their own line.
214
215         An example of a single paragraph follows:
216
217 \begin_layout Standard
218 \paragraph_spacing single
219 \align left
220 Paragraph text.
221 \end_layout
222
223
224 2004-12-03  José Matos  <jamatos@lyx.org>
225
226         * format incremented to 238.
227         * The compatibility code to read old latex accents from 0.12.x in
228         InsetLatexAccent::checkContents has been removed.
229         The following translations are done:
230                 "\i \x"   -> "\i \x{}"
231                 "\i \xy"  -> "\i \x{y}"
232                 "\i \x y" -> "\i \x{y}"
233                 "\i \x\i" -> "\i \x{\i}"
234                 "\i \x\j" -> "\i \x{\j}"
235         x is a latex accent command, y the base character. \, i and j are
236         literal.
237         lyx did these changes already from 0.12.x -> 215, but not lyx2lyx,
238         so formats 215 - 237 can have both versions.
239
240
241 2004-10-10  José Matos  <jamatos@lyx.org>
242
243         * format incremented to 237.
244         * In the header, the following statments use now booleans values,
245         instead of 0, 1:
246                 - \use_geometry
247                 - \use_bibtopic
248                 - \tracking_changes
249
250 2004-08-15  José Matos  <jamatos@lyx.org>
251
252         * format incremented to 236.
253         * Added tags:
254                 - \begin_document
255                 - \begin_header
256                 - \begin_body
257                 - \end_body
258
259         * The options for \papersize are changed:
260                 Default -> default
261                 Custom -> custom
262         * All whitespaces are removed at the end of lines, when
263         not necessary. As an example we have all the lines in the header that
264         do not belong to the preamble.
265
266 2004-07-01  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
267
268         * format incremented to 235.
269         * \paperpackage had an off-by-one error. Translation table:
270
271           234: a4    a4wide  widemarginsa4
272           235: none  a4      a4wide         widemarginsa4
273
274           The "widemarginsa4" setting of 235 has no equivalent in 234.
275
276 2004-05-12  Angus Leeming  <leeming@lyx.org>
277
278         * format incremented to 234.
279         * the citation engine is specified explicitly rather than being
280         deduced from 3 bools.
281
282         \use_natbib 1
283         \use_numerical_citations 0   ->   \cite_engine <style>
284         \use_jurabib 0
285
286         where <style> is one of "basic", "natbib_authoryear",
287         "natbib_numerical" or "jurabib".
288
289 2004-04-29  Georg Baum  <Georg.Baum@post.rwth-aachen.de>
290
291         * format incremented to 233.
292         * insetgraphics does not allow filenames without extension anymore.
293         The complete filename has to be given.
294
295 2004-03-29  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
296
297         * format incremented to 232.
298
299         * Support for bibtopic (sectioned bibliographies).
300           - bufferparam \use_bibtopic [1|0]
301           - the bibtex inset has a second argument for bibtopic's
302             btPrint{Cited|NotCited|All} command:
303             < 231:
304             \begin_inset LatexCommand \bibtex[<style>]{<database>}
305             now:
306             \begin_inset LatexCommand \bibtex[<style>][<btPrintX>]{<database>}
307           Forwards, there's nothing to be done. Backwards, \usepackage[dot]{bibtopic}
308           has to be inserted to the preamble. Instead of the bibtex inset, the LaTeX
309           \bibliographystyle{<style>}
310           \begin{btSect}{<database>}
311           \<btprintX>
312           \end{btSect}
313           has to be inserted.
314
315 2004-03-29  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
316
317         * format incremented to 231.
318
319         * Support for sidewaysfigure/sidewaystable (rotating package).
320         insetfloat has now a param \sideways [true|false] (default is false).
321         The param should be erased on downwards conversion, if it was true,
322         the inset should be replaced by
323         \begin{sidewaysfigure} <content> \end{sidewaysfigure}
324         resp.
325         \begin{sidewaystable} <content> \end{sidewaystable}
326         i.e. ERT.
327
328 2004-02-23  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
329
330         * format incremented to 230.
331
332         * Support for a second optional argument in insetcommand.
333         currently, citation uses this to support natbibs second
334         optional argument \cite[before][after]{key}.
335         I think there's nothing to convert upwards. Downwards, the
336         commands with 2 optional args need to be converted to ERT.
337
338         * Support for jurabib (param \use_jurabib [1|0], default is 0).
339         When converting downwards, \usepackage{jurabib} has to be added
340         to the preamble and, if babel is used, \usepackage{babel} before
341         (jurabib fails if babel is called afterwards). If the natbib commands
342         are used together with jurabib, they have to be converted to ERT too.
343
344 2003-12-29  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
345
346         * format incremented to 229.
347         * Minipages cannot be read anymore. All minipage insets will
348         be converted to frameless box insets between 228->229.
349
350 2003-12-15  Angus Leeming  <leeming@lyx.org>
351
352         * format incremented to 228.
353         * Change the output of all insets derived from InsetCollapsable
354         except for InsetERT (which has a similar output already), changing lines
355         "collapsed true" -> "status collapsed"
356         "collapsed false" -> "status open".
357         * Change the output of InsetERT, changing lines
358         "status Collapsed" -> "status collapsed"
359         "status Open" -> "status open".
360         "status Inlined" -> "status inlined".
361
362 2003-12-10  Angus Leeming  <leeming@lyx.org>
363
364         * format NOT incremented.
365         * add a 'draft' option to InsetExternal.
366
367 2003-12-10  Angus Leeming  <leeming@lyx.org>
368
369         * format incremented to 227.
370         * Change the output of InsetBox:
371         \begin_inset Boxed -> \begin_inset Box Boxed
372         \begin_inset Doublebox -> \begin_inset Box Doublebox
373         \begin_inset Frameless -> \begin_inset Box Frameless
374         \begin_inset ovalbox -> \begin_inset Box ovalbox
375         \begin_inset Ovalbox -> \begin_inset Box Ovalbox
376         \begin_inset Shadowbox -> \begin_inset Box Shadowbox
377
378 2003-12-10  Angus Leeming  <leeming@lyx.org>
379
380         * format incremented to 226.
381         * Change the output of InsetNote:
382         \begin_inset Note -> \begin_inset Note Note
383         \begin_inset Comment -> \begin_inset Note Comment
384         \begin_inset Greyedout -> \begin_inset Note Greyedout
385
386 2003-11-28  André Pönitz
387
388         * Remove space_above/space_below from Paragraph.
389     This is now handled by InsetVSpace.
390
391 2003-10-07  Angus Leeming  <leeming@lyx.org>
392
393         * Add transformations to InsetExternal
394
395         boundingBox 0 0 20 20           the dimensions of the B.B..
396                                         Output if the B.B. is not empty.
397         clip                            clip the image to the B.B.
398                                         Output if true.
399         extra LaTeX "draft"             'extra' data passed to the primary
400                                         command for this output format.
401                                         (Possible formats LaTeX, PDFLaTeX,
402                                          LinuxDoc, DocBook, Ascii.)
403                                         The string can contain spaces and so
404                                         is wrapped in "...".
405         rotateAngle 30                  Rotation of the data.
406                                         Output for non-zero rotation only.
407         rotateOrigin bottomleft         Rotation origin.
408                                         Output for non-zero rotation and
409                                         non-default origin (center) only.
410         scale 50
411         width 2cm                       Output only if the image is resized.
412         height 2cm
413         keepAspectRatio
414
415 2003-10-07  Martin Vermeer  <martin.vermeer@hut.fi>
416
417         * Added box inset. File format:
418
419         \begin_inset Ovalbox            Boxed/Frameless/ovalbox/Ovalbox
420                                             /Shadowbox/Doublebox
421         position "b"                    t/c/b
422         hor_pos "c"                     l/c/r/s
423         has_inner_box 1                 1/0
424         inner_pos "b"                   t/c/b/s
425         use_parbox 0                    1/0
426         width "100col%"                 unit+width-string
427         special "none"                  none/height/depth
428                                             /totalheight/width
429         height "1in"                    unit+width-string
430         height_special "totalheight"    none/height/depth
431                                             /totalheight/width
432         collapsed false                 true/false
433
434         \begin_layout Standard
435
436         <box contents>
437         \end_layout
438
439         \end_inset
440
441         This box (Frameless, has_inner_box=1, use_parbox=0) replaces
442         the pre-existing Minipage inset. Parameters translate as follows:
443         position                        0/1/2   -> t/c/b
444         inner_position                  0/1/2/3 -> inner_pos c/t/b/s
445         height                          same
446         width                           same
447         collapsed                       same
448
449 2003-08-19  Michael Schmitt  <michael.schmitt@teststep.org>
450
451         * attribute valignment="center" is replaced by valignment="middle"
452         for tabular columns and cells
453
454 2003-08-17  Martin Vermeer  <martin.vermeer@hut.fi>
455
456         * Added branch inset. File format:
457
458         branch definition in the header:
459         \branch <branchname>
460         \selected 0                    0/1
461         \color #rrggbb
462         \end_branch
463
464         \begin_inset Branch <branchname>
465         collapsed false                 true/false
466
467         \begin_layout Standard
468
469         <branch contents>
470         \end_layout
471
472         \end_inset
473
474 2003-07-28  José Matos  <jamatos@lyx.org>
475
476         * \the_end is replaced with \end_document
477
478 2003-07-28  José Matos  <jamatos@lyx.org>
479
480         * \layout is replaced with \begin_layout
481
482 2003-07-28  José Matos  <jamatos@fep.up.pt>
483
484         Format bumped to 225
485
486         * All layouts finish now with \end_layout
487
488 2003-06-04  Angus Leeming  <leeming@lyx.org>
489
490         Format bumped to 224
491
492         * the storage of the external inset has been changed from
493
494                 \begin_inset External XFig,"file.fig",""
495
496                 \end_inset
497
498         to this
499
500                 \begin_inset External
501                         template XFig
502                         filename file.fig
503                         display <display_type>
504                         lyxscale <scale>
505
506                 \end_inset
507
508         throwing away the final arg (here "", more generally "<string>") that holds
509         the parameters variable.
510         Variables are output if present (filename) or different from the default
511         values (display, lyxscale).
512
513         Moreover, the RasterImage template has been scrapped. All RasterImage
514         external insets are now converted to Graphics insets.
515
516 2003-05-20  Jürgen Spitzmüller  <j.spitzmueller@gmx.de>
517
518         * Added new space insets:
519                 \SpecialChar ~ is now \InsetSpace ~
520                 ERT: "\ " could be converted to InsetSpace \<space>
521                 ERT: "\," could be converted to InsetSpace \,
522
523 2003-04-24  André Pönitz <poenitz@gmx.net>
524
525         * Added eqref support:
526         \begin_inset LatexCommand \eqref{label}
527
528 2003-03-14  Dekel Tsur
529
530         * Format bumped to 223.
531
532 2003-03-12  John Levon  <levon@movementarian.org>
533
534         * Added \\end_header to signify the end of the header in a
535           more robust fashion.
536
537         * use_amsmath is now a tristate {0 = never, 1 = auto, 2 = always}
538
539 2003-02-10  John Levon  <levon@movementarian.org>
540
541         Format bumped to 222
542
543         Added \\tracking_changes 0|1 to the header.
544
545         Added \\author to the header. This can be present multiple
546         times, and is of the form :
547
548         \\author "Real Name" email@address.com
549
550         Added \\change_deleted, \\change_inserted. Each of these does not
551         span a paragraph, and is delimited by "\\change_unchanged\n". Both are
552         of the form :
553
554         \\change_inserted author time
555
556         where author is an integer ID reference into the author list in
557         the header, and time is time_t.
558
559 2002-10-24  Rob Lahaye  <lahaye@snu.ac.kr>
560
561         * insetgraphicsParams.h (scale): is now a float, not an unsigned int.
562
563 2002-08-22  Rob Lahaye <lahaye@snu.ac.kr>
564
565 New graphics dialog. With the removal of buttons in the dialog, also
566 keywords in the graphics inset went. The following keywords do not
567 exist anymore:
568         lyxsize_kind
569         lyxsize_type
570         lyxwidth
571         lyxheight
572         size_kind
573         size_type
574         rotate
575
576 Only non-default values are saved to the lyx files. The defaults of the remaining
577 keywords are;
578         filename <empty>
579         lyxscale 100
580         display default
581         scale 100
582         width <empty>
583         height <empty>
584         draft <off>
585         noUnzip <off>
586         BoundingBox <from file>
587         clip <off>
588         rotateAngle 0
589         rotateOrigin centerBaseline
590         subcaption <off>
591         subcaptionText <empty>
592         special <empty>
593
594 The remaining keywords have sufficient overlap with the old ones for a
595 smooth reading of the 1.2.x inset keywords in most common cases.
596
597 Compatibility is certainly broken for the old lyxwidth/lyxheight keywords.
598 They don't exist anymore and we can't translate them into a scaling value, while
599 we're reading the graphics inset. The old lyxwidth/lyxheight keyword and its
600 argument is ignored and lost.
601
602 Only few compatibility issues are left for lyx2lyx:
603
604 ------------------------------------------------------------------------------
605 old-token                                   new-token         remove
606 ------------------------------------------------------------------------------
607 size_kind original / size_type 0            scale 100         width <val>
608                                                               height <val>
609                                                               scale <val>
610
611 size_kind width_height / size_type 1            -             scale <val>
612
613 lyxsize_kind original / lyxsize_type 0      lyxscale 100      lyxscale <val>
614 ------------------------------------------------------------------------------
615 [replace old-token by new-token, and remove any of subsequent tokens as listed]
616
617 If "rotate" is absent, lyx2lyx should ignore "rotateAngle <val>":
618    if ( "rotateAngle <val>" is there WITHOUT being preceded by the keyword "rotate" )
619    then
620         replace "rotateAngle <val>" by "rotateAngle 0"
621
622
623 2002-08-12  Andre' Poenitz <poenitz@gmx.de>
624
625 Added \lyxlock for locked math inset when written to .lyx file.
626 When "downgrading" .lyx files this should simple be deleted but it
627 does not hurt at all if it stays in. It does not have to be added
628 when "upgrading".
629
630
631 2002-08-02  Angus Leeming  <leeming@lyx.org>
632
633 Added a boolean "preview" flag to InsetCommandParams.
634 Currently it is written only by InsetInclude, because only this
635 class can generate a preview of its contents.
636
637 The LyX file now contains:
638
639  \begin_inset Include \input{snapshot_t=40.tex}
640 +preview true
641
642  \end_inset
643
644 Earlier versions of LyX just swallow this extra token silently.
645
646 2002-08-12  Angus Leeming  <leeming@lyx.org>
647
648 The 1.2.0 InsetGraphicsParams "size_type" and "lyxsize_type" have been
649 renamed as "size_kind" and "lyxsize_kind" respectively.
650
651  \begin_inset Graphics FormatVersion 1
652         filename file.eps
653         display default
654 -       size_kind original
655 +       size_type original
656         width 7cm
657         rotateOrigin center
658 -       lyxsize_kind original
659 +       lyxsize_type original
660         lyxwidth 4cm
661
662  \end_inset
663