autotests/export/docbook/Development.lyx

   1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
   2 \lyxformat 598
   3 \begin_document
   4 \begin_header
   5 \save_transient_properties true
   6 \origin unavailable
   7 \textclass scrartcl
   8 \options BCOR8mm,captions=tableheading
   9 \use_default_options false
  10 \begin_modules
  11 logicalmkup
  12 \end_modules
  13 \maintain_unincluded_children no
  14 \language english
  15 \language_package default
  16 \inputencoding utf8
  17 \fontencoding auto
  18 \font_roman "lmodern" "default"
  19 \font_sans "lmss" "default"
  20 \font_typewriter "lmtt" "default"
  21 \font_math "auto" "auto"
  22 \font_default_family default
  23 \use_non_tex_fonts false
  24 \font_sc false
  25 \font_roman_osf false
  26 \font_sans_osf false
  27 \font_typewriter_osf false
  28 \font_sf_scale 100 100
  29 \font_tt_scale 100 100
  30 \use_microtype false
  31 \use_dash_ligatures true
  32 \graphics default
  33 \default_output_format pdf2
  34 \output_sync 1
  35 \bibtex_command default
  36 \index_command default
  37 \paperfontsize 12
  38 \spacing single
  39 \use_hyperref true
  40 \pdf_title "LyX's Development manual"
  41 \pdf_author "LyX Team"
  42 \pdf_subject "LyX's development documentation"
  43 \pdf_keywords "LyX, Documentation, Development"
  44 \pdf_bookmarks true
  45 \pdf_bookmarksnumbered true
  46 \pdf_bookmarksopen true
  47 \pdf_bookmarksopenlevel 1
  48 \pdf_breaklinks false
  49 \pdf_pdfborder false
  50 \pdf_colorlinks true
  51 \pdf_backref false
  52 \pdf_pdfusetitle false
  53 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
  54 \papersize a4
  55 \use_geometry false
  56 \use_package amsmath 1
  57 \use_package amssymb 1
  58 \use_package cancel 1
  59 \use_package esint 1
  60 \use_package mathdots 1
  61 \use_package mathtools 1
  62 \use_package mhchem 1
  63 \use_package stackrel 1
  64 \use_package stmaryrd 1
  65 \use_package undertilde 1
  66 \cite_engine basic
  67 \cite_engine_type default
  68 \biblio_style plain
  69 \use_bibtopic false
  70 \use_indices false
  71 \paperorientation portrait
  72 \suppress_date false
  73 \justification true
  74 \use_refstyle 0
  75 \use_minted 0
  76 \use_lineno 0
  77 \notefontcolor #0000ff
  78 \index Index
  79 \shortcut idx
  80 \color #008000
  81 \end_index
  82 \secnumdepth 4
  83 \tocdepth 4
  84 \paragraph_separation indent
  85 \paragraph_indentation default
  86 \is_math_indent 0
  87 \math_numbering_side default
  88 \quotes_style english
  89 \dynamic_quotes 0
  90 \papercolumns 1
  91 \papersides 2
  92 \paperpagestyle headings
  93 \tablestyle default
  94 \tracking_changes false
  95 \output_changes false
  96 \change_bars false
  97 \postpone_fragile_content false
  98 \html_math_output 0
  99 \html_css_as_file 0
 100 \html_be_strict true
 101 \docbook_table_output 0
 102 \end_header
 103
 104 \begin_body
 105
 106 \begin_layout Title
 107 Developing \SpecialChar LyX
 108
 109 \end_layout
 110
 111 \begin_layout Subtitle
 112 Version 2.3.x
 113 \end_layout
 114
 115 \begin_layout Section
 116 File formats
 117 \end_layout
 118
 119 \begin_layout Subsection
 120 When is an update of the .lyx file format number needed?
 121 \begin_inset CommandInset label
 122 LatexCommand label
 123 name "sec:When-is-an"
 124
 125 \end_inset
 126
 127
 128 \end_layout
 129
 130 \begin_layout Standard
 131 When you are working on a new feature you may ask yourself whether it needs
 132  an update of the .lyx file format number.
 133  Whether an update is needed or not is not always obvious.
 134  Rule of thumb:
 135 \end_layout
 136
 137 \begin_layout Quote
 138 Whenever there is the danger that a previous version of LyX cannot open
 139  a file using the new feature, a file format update is needed.
 140 \end_layout
 141
 142 \begin_layout Standard
 143 The file format change allows lyx2lyx rules to implement backwards compatibility.
 144  Below you can find a list of reasons for file format updates with explanations:
 145 \end_layout
 146
 147 \begin_layout Description
 148 New
 149 \begin_inset space ~
 150 \end_inset
 151
 152 document
 153 \begin_inset space ~
 154 \end_inset
 155
 156 setting Whenever you introduce a new setting that is stored in the document
 157  header, a file format update is needed.
 158 \end_layout
 159
 160 \begin_layout Description
 161 Removed
 162 \begin_inset space ~
 163 \end_inset
 164
 165 document
 166 \begin_inset space ~
 167 \end_inset
 168
 169 setting If a certain setting becomes obsolete and gets removed, a file format
 170  update is needed.
 171 \end_layout
 172
 173 \begin_layout Description
 174 New
 175 \begin_inset space ~
 176 \end_inset
 177
 178 valid
 179 \begin_inset space ~
 180 \end_inset
 181
 182 value
 183 \begin_inset space ~
 184 \end_inset
 185
 186 for
 187 \begin_inset space ~
 188 \end_inset
 189
 190 an
 191 \begin_inset space ~
 192 \end_inset
 193
 194 existing
 195 \begin_inset space ~
 196 \end_inset
 197
 198 setting, e.
 199 \begin_inset space \thinspace{}
 200 \end_inset
 201
 202 g.
 203 \end_layout
 204
 205 \begin_deeper
 206 \begin_layout Description
 207 \paragraph_spacing single
 208 Automatically
 209 \begin_inset space ~
 210 \end_inset
 211
 212 loaded
 213 \begin_inset space ~
 214 \end_inset
 215
 216 math
 217 \begin_inset space ~
 218 \end_inset
 219
 220 package The reason for this is that there is no true ERT inset for math
 221  formulas: Each command is parsed, and if a user happens to define a local
 222  command with the same name as a command that triggers an automatic load
 223  of a package, they need to be able to switch off the automatic loading
 224  of that package.
 225  This switch is stored by the
 226 \begin_inset Flex Code
 227 status collapsed
 228
 229 \begin_layout Plain Layout
 230 use_package
 231 \end_layout
 232
 233 \end_inset
 234
 235  header setting.
 236 \end_layout
 237
 238 \begin_layout Description
 239 New
 240 \begin_inset space ~
 241 \end_inset
 242
 243 language that is stored in
 244 \begin_inset Flex Code
 245 status collapsed
 246
 247 \begin_layout Plain Layout
 248
 249 \backslash
 250 language
 251 \end_layout
 252
 253 \end_inset
 254
 255 .
 256
 257 \begin_inset Note Note
 258 status collapsed
 259
 260 \begin_layout Plain Layout
 261 This requirement is under discussion.
 262 \end_layout
 263
 264 \end_inset
 265
 266
 267 \end_layout
 268
 269 \end_deeper
 270 \begin_layout Description
 271 New
 272 \begin_inset space ~
 273 \end_inset
 274
 275 inset Of course a new inset requires a file format update.
 276 \end_layout
 277
 278 \begin_layout Description
 279 New
 280 \begin_inset space ~
 281 \end_inset
 282
 283 style If a new style or inset layout is added to any layout file or module
 284  shipped with \SpecialChar LyX
 285 , then a new file format is needed in the master (development)
 286  branch.
 287  It is possible to backport new styles to the stable version without a file
 288  format change.
 289 \end_layout
 290
 291 \begin_layout Description
 292 Removed
 293 \begin_inset space ~
 294 \end_inset
 295
 296 style If a style or inset layout is removed in any layout file or module
 297  shipped with \SpecialChar LyX
 298 , a new file format is required.
 299 \end_layout
 300
 301 \begin_layout Standard
 302 However,
 303 \series bold
 304 new
 305 \series default
 306  layouts and modules do
 307 \series bold
 308 not
 309 \series default
 310  require a file format update (changed 03/16).
 311
 312 \end_layout
 313
 314 \begin_layout Standard
 315 If you are still unsure, please ask on the development list.
 316 \end_layout
 317
 318 \begin_layout Paragraph
 319 \begin_inset CommandInset label
 320 LatexCommand label
 321 name "par:export-test-output-formats"
 322
 323 \end_inset
 324
 325 Output formats
 326 \end_layout
 327
 328 \begin_layout Standard
 329 The following output formats are currently tested for each sample document:
 330 \end_layout
 331
 332 \begin_layout Labeling
 333 \labelwidthstring 00.00.0000
 334 LyX:
 335 \end_layout
 336
 337 \begin_deeper
 338 \begin_layout Labeling
 339 \labelwidthstring 00.00.0000
 340 lyx16 LyX 1.6 file format (lyx2lyx)
 341 \end_layout
 342
 343 \begin_layout Labeling
 344 \labelwidthstring 00.00.0000
 345 lyx21 LyX 2.1 file format (lyx2lyx)
 346 \end_layout
 347
 348 \begin_layout Labeling
 349 \labelwidthstring 00.00.0000
 350 xhtml LyXHTML (native LyX HTML export)
 351 \end_layout
 352
 353 \end_deeper
 354 \begin_layout Labeling
 355 \labelwidthstring 00.00.0000
 356 LyX
 357 \begin_inset space ~
 358 \end_inset
 359
 360 +
 361 \begin_inset space ~
 362 \end_inset
 363
 364 LaTeX:
 365 \end_layout
 366
 367 \begin_deeper
 368 \begin_layout Labeling
 369 \labelwidthstring pdf5msystemFM
 370 dvi DVI (8-bit latex)
 371 \end_layout
 372
 373 \begin_layout Labeling
 374 \labelwidthstring pdf5msystemFM
 375 dvi3_texF DVI (LuaTeX with 8-bit TeX fonts)
 376 \end_layout
 377
 378 \begin_layout Labeling
 379 \labelwidthstring pdf5msystemFM
 380 dvi3_systemF DVI (LuaTeX with Unicode fonts)
 381 \end_layout
 382
 383 \begin_layout Labeling
 384 \labelwidthstring pdf5msystemFM
 385 pdf2 PDF (pdflatex)
 386 \end_layout
 387
 388 \begin_layout Labeling
 389 \labelwidthstring pdf5msystemFM
 390 pdf4_texF PDF (XeTeX with 8-bit TeX fonts)
 391 \end_layout
 392
 393 \begin_layout Labeling
 394 \labelwidthstring pdf5msystemFM
 395 pdf4_systemF PDF (XeTeX with Unicode fonts)
 396 \end_layout
 397
 398 \begin_layout Labeling
 399 \labelwidthstring pdf5msystemFM
 400 pdf5_texF PDF (LuaTeX with 8-bit TeX fonts)
 401 \end_layout
 402
 403 \begin_layout Labeling
 404 \labelwidthstring pdf5msystemFM
 405 pdf5_systemF PDF (LuaTeX with Unicode fonts)
 406 \end_layout
 407
 408 \end_deeper
 409 \begin_layout Labeling
 410 \labelwidthstring 00.00.0000
 411 LyX
 412 \begin_inset space ~
 413 \end_inset
 414
 415 +
 416 \begin_inset space ~
 417 \end_inset
 418
 419 LaTeX
 420 \begin_inset space ~
 421 \end_inset
 422
 423 +
 424 \begin_inset space ~
 425 \end_inset
 426
 427 postprocessing:
 428 \end_layout
 429
 430 \begin_deeper
 431 \begin_layout Labeling
 432 \labelwidthstring pdf5msystemFM
 433 pdf DVI -> PS (dvips) -> PDF (ps2pdf)
 434 \end_layout
 435
 436 \begin_layout Labeling
 437 \labelwidthstring pdf5msystemFM
 438 pdf3 DVI -> PDF (dvipdfm)
 439 \end_layout
 440
 441 \end_deeper
 442 \begin_layout Labeling
 443 \labelwidthstring 00.00.0000
 444 not
 445 \begin_inset space ~
 446 \end_inset
 447
 448 tested: (or only if set as default output format in the document source)
 449 \end_layout
 450
 451 \begin_deeper
 452 \begin_layout Labeling
 453 \labelwidthstring pdf5msystemFM
 454 latex LaTeX (plain)
 455 \end_layout
 456
 457 \begin_layout Labeling
 458 \labelwidthstring pdf5msystemFM
 459 luatex LaTeX (LuaTeX)
 460 \end_layout
 461
 462 \begin_layout Labeling
 463 \labelwidthstring pdf5msystemFM
 464 dviluatex LaTeX (dviluatex)
 465 \end_layout
 466
 467 \begin_layout Labeling
 468 \labelwidthstring pdf5msystemFM
 469 pdflatex LaTeX (pdflatex)
 470 \end_layout
 471
 472 \begin_layout Labeling
 473 \labelwidthstring pdf5msystemFM
 474 platex LaTeX (pLaTeX)
 475 \end_layout
 476
 477 \begin_layout Labeling
 478 \labelwidthstring pdf5msystemFM
 479 xetex LaTeX (XeTeX)
 480 \end_layout
 481
 482 \begin_layout Labeling
 483 \labelwidthstring pdf5msystemFM
 484 eps3 EPS (encapsulated Postscript) (cropped)
 485 \end_layout
 486
 487 \begin_layout Labeling
 488 \labelwidthstring pdf5msystemFM
 489 ps DVI -> Postscript (dvips)
 490 \end_layout
 491
 492 \begin_layout Labeling
 493 \labelwidthstring pdf5msystemFM
 494 odf
 495 \end_layout
 496
 497 \begin_layout Labeling
 498 \labelwidthstring pdf5msystemFM
 499 text (nor text2, ..., text4)
 500 \end_layout
 501
 502 \begin_layout Labeling
 503 \labelwidthstring pdf5msystemFM
 504 textparagraph
 505 \end_layout
 506
 507 \begin_layout Labeling
 508 \labelwidthstring pdf5msystemFM
 509 word
 510 \end_layout
 511
 512 \begin_layout Labeling
 513 \labelwidthstring pdf5msystemFM
 514 word2
 515 \end_layout
 516
 517 \begin_layout Labeling
 518 \labelwidthstring pdf5msystemFM
 519 wordhtml
 520 \end_layout
 521
 522 \end_deeper
 523 \end_body
 524 \end_document