autotests/export/docbook/Development.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!-- This DocBook file was created by LyX 2.4.0dev
   3   See http://www.lyx.org/ for more information -->
   4 <article xml:lang="en_US" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:m="http://www.w3.org/1998/Math/MathML" xmlns:xi="http://www.w3.org/2001/XInclude" version="5.2">
   5 <title>Developing LyX</title>
   6 <subtitle>Version 2.3.x</subtitle>
   7 <section>
   8 <title>File formats</title>
   9 <section xml:id="sec.When-is-an">
  10 <title>When is an update of the .lyx file format number needed?</title>
  11 <para>When you are working on a new feature you may ask yourself whether it needs an update of the .lyx file format number. Whether an update is needed or not is not always obvious. Rule of thumb: </para>
  12 <blockquote>
  13 <para>Whenever there is the danger that a previous version of LyX cannot open a file using the new feature, a file format update is needed.</para>
  14 </blockquote>
  15 <para>The file format change allows lyx2lyx rules to implement backwards compatibility. Below you can find a list of reasons for file format updates with explanations:</para>
  16 <variablelist>
  17 <varlistentry>
  18 <term>New&#xA0;document&#xA0;setting</term>
  19 <listitem>
  20 <para>Whenever you introduce a new setting that is stored in the document header, a file format update is needed.</para>
  21 </listitem>
  22 </varlistentry>
  23 <varlistentry>
  24 <term>Removed&#xA0;document&#xA0;setting</term>
  25 <listitem>
  26 <para>If a certain setting becomes obsolete and gets removed, a file format update is needed.</para>
  27 </listitem>
  28 </varlistentry>
  29 <varlistentry>
  30 <term>New&#xA0;valid&#xA0;value&#xA0;for&#xA0;an&#xA0;existing&#xA0;setting,</term>
  31 <listitem>
  32 <para>e.&#x2009;g.</para>
  33 <variablelist>
  34 <varlistentry>
  35 <term>Automatically&#xA0;loaded&#xA0;math&#xA0;package</term>
  36 <listitem>
  37 <para>The reason for this is that there is no true ERT inset for math formulas: Each command is parsed, and if a user happens to define a local command with the same name as a command that triggers an automatic load of a package, they need to be able to switch off the automatic loading of that package. This switch is stored by the use_package header setting.</para>
  38 </listitem>
  39 </varlistentry>
  40 <varlistentry>
  41 <term>New&#xA0;language</term>
  42 <listitem>
  43 <para>that is stored in \language. </para>
  44 </listitem>
  45 </varlistentry>
  46 </variablelist>
  47 </listitem>
  48 </varlistentry>
  49 <varlistentry>
  50 <term>New&#xA0;inset</term>
  51 <listitem>
  52 <para>Of course a new inset requires a file format update.</para>
  53 </listitem>
  54 </varlistentry>
  55 <varlistentry>
  56 <term>New&#xA0;style</term>
  57 <listitem>
  58 <para>If a new style or inset layout is added to any layout file or module shipped with LyX, then a new file format is needed in the master (development) branch. It is possible to backport new styles to the stable version without a file format change.</para>
  59 </listitem>
  60 </varlistentry>
  61 <varlistentry>
  62 <term>Removed&#xA0;style</term>
  63 <listitem>
  64 <para>If a style or inset layout is removed in any layout file or module shipped with LyX, a new file format is required.</para>
  65 </listitem>
  66 </varlistentry>
  67 </variablelist>
  68 <para>However, <emphasis role='bold'>new</emphasis> layouts and modules do <emphasis role='bold'>not</emphasis> require a file format update (changed 03/16). </para>
  69 <para>If you are still unsure, please ask on the development list.</para>
  70 <section xml:id="par.export-test-output-formats">
  71 <title>Output formats</title>
  72 <para>The following output formats are currently tested for each sample document:</para>
  73 <variablelist>
  74 <varlistentry>
  75 <term>LyX:</term>
  76 <listitem>
  77 <para />
  78 <variablelist>
  79 <varlistentry>
  80 <term>lyx16</term>
  81 <listitem>
  82 <para>LyX 1.6 file format (lyx2lyx)</para>
  83 </listitem>
  84 </varlistentry>
  85 <varlistentry>
  86 <term>lyx21</term>
  87 <listitem>
  88 <para>LyX 2.1 file format (lyx2lyx)</para>
  89 </listitem>
  90 </varlistentry>
  91 <varlistentry>
  92 <term>xhtml</term>
  93 <listitem>
  94 <para>LyXHTML (native LyX HTML export)</para>
  95 </listitem>
  96 </varlistentry>
  97 </variablelist>
  98 </listitem>
  99 </varlistentry>
 100 <varlistentry>
 101 <term>LyX&#xA0;+&#xA0;LaTeX:</term>
 102 <listitem>
 103 <para />
 104 <variablelist>
 105 <varlistentry>
 106 <term>dvi</term>
 107 <listitem>
 108 <para>DVI (8-bit latex)</para>
 109 </listitem>
 110 </varlistentry>
 111 <varlistentry>
 112 <term>dvi3_texF</term>
 113 <listitem>
 114 <para>DVI (LuaTeX with 8-bit TeX fonts)</para>
 115 </listitem>
 116 </varlistentry>
 117 <varlistentry>
 118 <term>dvi3_systemF</term>
 119 <listitem>
 120 <para>DVI (LuaTeX with Unicode fonts)</para>
 121 </listitem>
 122 </varlistentry>
 123 <varlistentry>
 124 <term>pdf2</term>
 125 <listitem>
 126 <para>PDF (pdflatex)</para>
 127 </listitem>
 128 </varlistentry>
 129 <varlistentry>
 130 <term>pdf4_texF</term>
 131 <listitem>
 132 <para>PDF (XeTeX with 8-bit TeX fonts)</para>
 133 </listitem>
 134 </varlistentry>
 135 <varlistentry>
 136 <term>pdf4_systemF</term>
 137 <listitem>
 138 <para>PDF (XeTeX with Unicode fonts)</para>
 139 </listitem>
 140 </varlistentry>
 141 <varlistentry>
 142 <term>pdf5_texF</term>
 143 <listitem>
 144 <para>PDF (LuaTeX with 8-bit TeX fonts)</para>
 145 </listitem>
 146 </varlistentry>
 147 <varlistentry>
 148 <term>pdf5_systemF</term>
 149 <listitem>
 150 <para>PDF (LuaTeX with Unicode fonts)</para>
 151 </listitem>
 152 </varlistentry>
 153 </variablelist>
 154 </listitem>
 155 </varlistentry>
 156 <varlistentry>
 157 <term>LyX&#xA0;+&#xA0;LaTeX&#xA0;+&#xA0;postprocessing:</term>
 158 <listitem>
 159 <para />
 160 <variablelist>
 161 <varlistentry>
 162 <term>pdf</term>
 163 <listitem>
 164 <para>DVI -&gt; PS (dvips) -&gt; PDF (ps2pdf)</para>
 165 </listitem>
 166 </varlistentry>
 167 <varlistentry>
 168 <term>pdf3</term>
 169 <listitem>
 170 <para>DVI -&gt; PDF (dvipdfm)</para>
 171 </listitem>
 172 </varlistentry>
 173 </variablelist>
 174 </listitem>
 175 </varlistentry>
 176 <varlistentry>
 177 <term>not&#xA0;tested:</term>
 178 <listitem>
 179 <para>(or only if set as default output format in the document source)</para>
 180 <variablelist>
 181 <varlistentry>
 182 <term>latex</term>
 183 <listitem>
 184 <para>LaTeX (plain)</para>
 185 </listitem>
 186 </varlistentry>
 187 <varlistentry>
 188 <term>luatex</term>
 189 <listitem>
 190 <para>LaTeX (LuaTeX)</para>
 191 </listitem>
 192 </varlistentry>
 193 <varlistentry>
 194 <term>dviluatex</term>
 195 <listitem>
 196 <para>LaTeX (dviluatex)</para>
 197 </listitem>
 198 </varlistentry>
 199 <varlistentry>
 200 <term>pdflatex</term>
 201 <listitem>
 202 <para>LaTeX (pdflatex)</para>
 203 </listitem>
 204 </varlistentry>
 205 <varlistentry>
 206 <term>platex</term>
 207 <listitem>
 208 <para>LaTeX (pLaTeX)</para>
 209 </listitem>
 210 </varlistentry>
 211 <varlistentry>
 212 <term>xetex</term>
 213 <listitem>
 214 <para>LaTeX (XeTeX) </para>
 215 </listitem>
 216 </varlistentry>
 217 <varlistentry>
 218 <term>eps3</term>
 219 <listitem>
 220 <para>EPS (encapsulated Postscript) (cropped)</para>
 221 </listitem>
 222 </varlistentry>
 223 <varlistentry>
 224 <term>ps</term>
 225 <listitem>
 226 <para>DVI -&gt; Postscript (dvips)</para>
 227 </listitem>
 228 </varlistentry>
 229 <varlistentry>
 230 <term>odf</term>
 231 <listitem>
 232 <para />
 233 </listitem>
 234 </varlistentry>
 235 <varlistentry>
 236 <term>text</term>
 237 <listitem>
 238 <para>(nor text2, ..., text4)</para>
 239 </listitem>
 240 </varlistentry>
 241 <varlistentry>
 242 <term>textparagraph</term>
 243 <listitem>
 244 <para />
 245 </listitem>
 246 </varlistentry>
 247 <varlistentry>
 248 <term>word</term>
 249 <listitem>
 250 <para />
 251 </listitem>
 252 </varlistentry>
 253 <varlistentry>
 254 <term>word2</term>
 255 <listitem>
 256 <para />
 257 </listitem>
 258 </varlistentry>
 259 <varlistentry>
 260 <term>wordhtml</term>
 261 <listitem>
 262 <para />
 263 </listitem>
 264 </varlistentry>
 265 </variablelist>
 266 </listitem>
 267 </varlistentry>
 268 </variablelist>
 269 </section>
 270 </section>
 271 </section>
 272 </article>