1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
7 \options BCOR8mm,captions=tableheading
8 \use_default_options false
12 \maintain_unincluded_children false
14 \language_package default
17 \font_roman "lmodern" "default"
18 \font_sans "lmss" "default"
19 \font_typewriter "lmtt" "default"
20 \font_math "auto" "auto"
21 \font_default_family default
22 \use_non_tex_fonts false
25 \font_sf_scale 100 100
26 \font_tt_scale 100 100
28 \default_output_format default
30 \bibtex_command default
31 \index_command default
35 \pdf_title "LyX's Development manual"
36 \pdf_author "LyX Team"
37 \pdf_subject "LyX's development documentation"
38 \pdf_keywords "LyX, Documentation, Development"
40 \pdf_bookmarksnumbered true
41 \pdf_bookmarksopen true
42 \pdf_bookmarksopenlevel 1
47 \pdf_pdfusetitle false
48 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
51 \use_package amsmath 1
52 \use_package amssymb 1
55 \use_package mathdots 1
56 \use_package mathtools 0
58 \use_package stackrel 0
59 \use_package stmaryrd 0
60 \use_package undertilde 0
62 \cite_engine_type default
66 \paperorientation portrait
70 \notefontcolor #0000ff
77 \paragraph_separation indent
78 \paragraph_indentation default
79 \quotes_language english
82 \paperpagestyle headings
83 \tracking_changes false
93 Developing \SpecialChar LyX
97 \begin_layout Subtitle
102 by the \SpecialChar LyX
107 \begin_layout Plain Layout
109 If you have comments or error corrections, please send them to the \SpecialChar LyX
112 \begin_inset Flex Code
115 \begin_layout Plain Layout
117 <lyx-docs@lists.lyx.org>
130 \begin_layout Standard
131 \begin_inset CommandInset toc
132 LatexCommand tableofcontents
139 \begin_layout Section
143 \begin_layout Standard
144 This manual documents some aspects of \SpecialChar LyX
146 It is currently rather incomplete, but will hopefully be extended in the
148 Meanwhile, additional information can be found in the
149 \begin_inset Flex Code
152 \begin_layout Plain Layout
158 subfolder of the \SpecialChar LyX
159 source code distribution.
160 This document is not translated, since the development language of \SpecialChar LyX
163 If you want to use \SpecialChar LyX
164 you don't need to read this manual.
165 However, if you want to learn more about how \SpecialChar LyX
166 is developed, or even want
167 to participate in \SpecialChar LyX
168 development, you may find some interesting information.
171 \begin_layout Section
175 \begin_layout Standard
177 uses several custom file formats for configuration files and documents.
178 This chapter contains some background concerning these file formats.
179 Several file formats are also described in detail in the regular user documenta
183 \begin_layout Subsection
187 \begin_layout Subsection
188 When is an update of the .lyx file format number needed?
189 \begin_inset CommandInset label
191 name "sec:When-is-an"
198 \begin_layout Standard
199 When you are working on a new feature you may ask yourself whether it needs
200 an update of the .lyx file format number.
201 Whether an update is needed or not is not always obvious.
202 Below you can find a list of reasons for file format updates with explanations:
205 \begin_layout Description
214 setting Whenever you introduce a new setting that is stored in the document
215 header, a file format update is needed.
216 This is also true if you add a new valid value to an existing setting,
218 \begin_inset space \thinspace{}
222 \begin_inset space \space{}
225 a new language that is stored in
226 \begin_inset Flex Code
229 \begin_layout Plain Layout
240 \begin_layout Description
249 setting If a certain setting becomes obsolete and gets removed, a file format
253 \begin_layout Description
258 inset Of course a new inset requires a file format update.
261 \begin_layout Description
266 style in any layout file or module shipped with \SpecialChar LyX
267 , or new shipped layout
269 These requirements are currently under discussion and might change in the
273 \begin_layout Description
286 package Any new math package that is automatically loaded needs a file format
288 The reason for this is that there is no true ERT inset for math formulas:
289 Each command is parsed, and if a user happens to define a local command
290 with the same name as a command that triggers an automatic load of a package,
291 he needs to be able to switch off the automatic loading of that package.
292 This switch is stored by the
293 \begin_inset Flex Code
296 \begin_layout Plain Layout
305 \begin_layout Standard
306 If you are still unsure, please ask on the development list.
309 \begin_layout Subsection
310 How to update the file format number of .lyx files
311 \begin_inset CommandInset label
313 name "subsec:update_lyx_files"
320 \begin_layout Standard
321 Once you came to the conclusion that a file format update is needed you
322 should use the following procedure to perform the update:
325 \begin_layout Enumerate
326 Implement and test the new feature, including the reading and writing of
328 Note that any file produced at this stage does not use a valid format,
329 so do not use this version of \SpecialChar LyX
330 for working on any important documents.
333 \begin_layout Enumerate
334 Describe the new format in
335 \begin_inset Flex Code
338 \begin_layout Plain Layout
347 \begin_layout Enumerate
348 Update the \SpecialChar LyX
349 file format number in
350 \begin_inset Flex Code
353 \begin_layout Plain Layout
362 \begin_layout Enumerate
363 Update the range of file formats in the array
364 \begin_inset Flex Code
367 \begin_layout Plain Layout
374 \begin_inset Flex Code
377 \begin_layout Plain Layout
386 \begin_layout Enumerate
387 Add an entry to both format lists (for conversion and reversion) in
388 \begin_inset Newline newline
392 \begin_inset Flex Code
395 \begin_layout Plain Layout
396 lib/lyx2lyx/lyx_2_2.py
402 Add a conversion routine if needed (e.
403 \begin_inset space \thinspace{}
407 \begin_inset space \space{}
410 a new header setting always needs a conversion that adds the new setting,
411 a new document language does not need one).
412 Add a reversion routine if needed.
413 While the conversion routine is required to produce a document that is
414 equivalent to the old version, the requirements of the reversion are not
416 If possible, try to produce a proper reversion, using ERT if needed, but
417 for some features this might be too complicated.
418 In this case, the minimum requirement of the reversion routine is that
419 it produces a valid document which can be read by an older \SpecialChar LyX
421 If absolutely needed, even data loss is allowed for the reversion.
424 \begin_layout Enumerate
425 Since tex2lyx has several implicit file format dependencies caused by sharing
426 code with \SpecialChar LyX
427 , updating the file format of .lyx files produced by tex2lyx at
428 the same time as updating the main .lyx file format is strongly recommended.
429 Therefore, a compiler warning will be issued if the \SpecialChar LyX
430 and tex2lyx .lyx file
431 format numbers differ.
432 In many cases the tex2lyx update requires only the first and last item
434 \begin_inset Separator parbreak
441 \begin_layout Enumerate
442 Update the tex2lyx file format number in
443 \begin_inset Flex Code
446 \begin_layout Plain Layout
455 \begin_layout Enumerate
456 If the lyx2lyx conversion from the old to the new format is empty, or if
457 tex2lyx does not yet output the changed feature, you do not need any further
459 Otherwise, search for the changed feature in tex2lyx, and adjust the output
460 according to the lyx2lyx changes.
463 \begin_layout Enumerate
464 Update the tex2lyx test references as described in
465 \begin_inset CommandInset ref
466 LatexCommand formatted
467 reference "sec:Updating-test-references"
475 \begin_layout Enumerate
476 If you did not implement full tex2lyx support of the new feature, add a
478 \begin_inset Flex Code
481 \begin_layout Plain Layout
487 describing the missing bits.
488 Note that it is perfectly fine if you do not add full tex2lyx support for
489 a new feature: The updating recommendation above is only issued for the
490 syntax of the produced .lyx file.
491 It is no problem if some features supported by \SpecialChar LyX
492 are still output as ERT
493 by tex2lyx, since the problems in the past that resulted in the update
494 recommendation were related to mixed version syntax, not ERT.
497 \begin_layout Enumerate
498 It would be nice if you could create a .lyx test file which contains instances
499 of all changed or added features.
500 This could then be used to test lyx2lyx and tex2lyx.
501 Unfortunately it has not yet been decided how to collect such examples,
502 so please ask on the development list if you want to create one.
505 \begin_layout Enumerate
506 \begin_inset CommandInset label
508 name "enu:updatefiles"
512 Update LyX's .lyx documentation files to the new format.
513 The developer who makes the change knows best what changes to expect when
514 inspecting the resulting diff.
515 Because of this, you might be able to catch a bug in the lyx2lyx code that
516 updates the format just by taking a quick scan through the large diff that
518 \begin_inset Note Note
521 \begin_layout Plain Layout
522 Another advantage is that if later we suspect a bug in lyx2lyx we can easily
523 see which layout update made an unexpected change by looking at the git
524 log of a .lyx file that suffers the problem.
530 To do this, first make sure that there are no changes to the git repository
531 that you will not want to commit (this is needed because it will be convenient
532 to commit with the command
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
543 Then run the following command in the root folder of the source:
544 \begin_inset Flex Code
547 \begin_layout Plain Layout
548 python development/tools/updatedocs.py
554 Then, revert the change to
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
564 because that file is meant to be generated separately:
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
569 git checkout lib/doc/LFUNs.lyx
575 \begin_inset Note Note
578 \begin_layout Plain Layout
579 TODO: this step should be done within updatedocs.py
585 Look at the resulting changes using the command
586 \begin_inset Flex Code
589 \begin_layout Plain Layout
596 If anything looks surprising, please investigate.
597 Finally, commit using
598 \begin_inset Flex Code
601 \begin_layout Plain Layout
610 \begin_layout Subsection
611 Updating the file format number of layout files
614 \begin_layout Standard
616 \begin_inset CommandInset ref
618 reference "enu:updatefiles"
623 \begin_inset CommandInset ref
625 reference "subsec:update_lyx_files"
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
639 command, use this command:
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
644 python development/tools/updatelayouts.py
652 \begin_layout Subsection
653 Updating the file format number of bind/ui files
656 \begin_layout Standard
658 \begin_inset CommandInset ref
660 reference "enu:updatefiles"
665 \begin_inset CommandInset ref
667 reference "subsec:update_lyx_files"
672 \begin_inset Flex Code
675 \begin_layout Plain Layout
681 command, use this command:
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
686 bash development/tools/updatelfuns.sh
694 \begin_layout Subsection
695 Backporting new styles to the stable version
698 \begin_layout Standard
699 Starting with the stable \SpecialChar LyX
700 2.1 branch, there is a mechanism in place to backport
701 new styles to the stable version without the need to update the file format.
702 The basic idea is that the new style definition is automatically copied
703 to the document preamble, so that it can even be used by older minor revisions
704 that did not yet include the style.
705 To backport a new style to the stable version, the following steps are
709 \begin_layout Enumerate
711 \begin_inset Flex Code
714 \begin_layout Plain Layout
720 to the style definition in the development version.
723 \begin_layout Enumerate
724 Copy the style definition to the stable version, but use
725 \begin_inset Flex Code
728 \begin_layout Plain Layout
735 If needed adjust the format to the one used by the stable version (see
736 the customization manual for details of the layout file format).
739 \begin_layout Enumerate
740 For each update of the style in a later stable version, increase the argument
742 \begin_inset Flex Code
745 \begin_layout Plain Layout
751 by one (in the stable version, the development version should not be touched).
754 \begin_layout Standard
755 For details about the
756 \begin_inset Flex Code
759 \begin_layout Plain Layout
765 flag see the customization manual.
767 \begin_inset Flex Code
770 \begin_layout Plain Layout
776 support is needed for backported styles: Since the style of the development
777 version has an infinite version number, it will always be used.
778 Furthermore, since its version number is less than one, the style will
779 not be written anymore to the document header for files saved by the new
783 \begin_layout Standard
784 \begin_inset Newpage newpage
790 \begin_layout Section
794 \begin_layout Standard
795 Automated tests are an important tool to detect bugs and regressions in
796 software development.
797 Some projects like gcc even require each bug fix to be accompanied by a
798 test case for the automatic test suite, that would detect this bug.
799 Testing interactive features automatically is of course very hard, but
800 core functionality like document import and export can be tested quite
801 easily, and some tests of this kind exist.
804 \begin_layout Subsection
808 \begin_layout Standard
809 There are attempts to set up a suite of unit tests for LyX.
812 \begin_layout Standard
813 TODO: describe what is done and what is still to do.
816 \begin_layout Subsection
820 \begin_layout Standard
821 The tex2lyx tests are located in the
822 \begin_inset Flex Code
825 \begin_layout Plain Layout
831 subfolder of the \SpecialChar LyX
832 source code distribution.
833 The actual testing is performed by the simple python script
834 \begin_inset Flex Code
837 \begin_layout Plain Layout
838 src/tex2lyx/test/runtests.py
844 Each test consists of two files:
845 \begin_inset Flex Code
848 \begin_layout Plain Layout
854 contains the \SpecialChar LaTeX
855 code that should be tested.
857 \begin_inset Flex Code
860 \begin_layout Plain Layout
866 contains the expected output of tex2lyx.
867 When a test is run, the actual produced output is compared with the stored
869 The test passes if both are identical.
870 The test machinery is also able to generate a file
871 \begin_inset Flex Code
874 \begin_layout Plain Layout
880 by exporting the produced .lyx file with \SpecialChar LyX
882 This may be useful for roundtrip comparisons.
885 \begin_layout Subsubsection
889 \begin_layout Standard
890 The tex2lyx tests can be run in several ways.
892 \begin_inset Flex Code
895 \begin_layout Plain Layout
901 subfolder of the build directory, the commands
902 \begin_inset Flex Code
905 \begin_layout Plain Layout
911 (cmake, all platforms),
912 \begin_inset Flex Code
915 \begin_layout Plain Layout
921 (cmake, when using a make based build system and not MSVC) or
922 \begin_inset Flex Code
925 \begin_layout Plain Layout
931 (autotools) will run the tex2lyx tests.
932 Alternatively, in the root of the build directory, the command
933 \begin_inset Flex Code
936 \begin_layout Plain Layout
942 runs all tests whose names match the regex
943 \begin_inset Quotes eld
947 \begin_inset Quotes erd
951 Another way to run the tex2lyx tests in the root build directory is to
952 instead use the command
953 \begin_inset Flex Code
956 \begin_layout Plain Layout
957 ctest -L '(cmplyx|roundtrip)'
962 , which runs all tests categorized with the label
963 \begin_inset Quotes eld
967 \begin_inset Quotes erd
971 \begin_inset Quotes eld
975 \begin_inset Quotes erd
979 If a test fails, the differences between the expected and actual results
980 are output in unified diff format.
983 \begin_layout Subsubsection
984 Updating test references
985 \begin_inset CommandInset label
987 name "sec:Updating-test-references"
994 \begin_layout Standard
995 In some cases a changed tex2lyx output is not a test failure, but wanted,
997 \begin_inset space \thinspace{}
1001 \begin_inset space \space{}
1004 if a tex2lyx bug was fixed, or a new feature was added.
1005 In these cases the stored references need to be updated.
1006 To do so if using autotools, call
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1017 \begin_inset Flex Code
1020 \begin_layout Plain Layout
1026 subdirectory of the build directory.
1027 If instead using CMake, call
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1032 make updatetex2lyxtests
1037 in the build directory or in the
1038 \begin_inset Flex Code
1041 \begin_layout Plain Layout
1047 subdirectory of the build directory.
1051 \begin_layout Plain Layout
1052 Note that this is a case where a make target in the build directory can
1053 affect the source directory, which might not be advisable.
1058 On Windows do the following:
1061 \begin_layout Itemize
1062 Assure that the path to the python.exe is in your system PATH variable.
1065 \begin_layout Itemize
1066 Double-click on the file
1067 \begin_inset Flex Code
1070 \begin_layout Plain Layout
1071 updatetex2lyxtests.vcxproj
1076 in the build directory or in the
1077 \begin_inset Flex Code
1080 \begin_layout Plain Layout
1086 subdirectory of your build directory.
1089 \begin_layout Itemize
1090 In the appearing MSVC program right-click on the project
1094 in the project explorer and chose
1101 \begin_layout Standard
1102 For convenience, these commands also produce re-exported roundtrip .lyx.tex
1104 Please examine the changed output carefully before committing the changed
1105 files to the repository: Since the test machinery does not do a roundtrip
1107 \begin_inset Formula $\Rightarrow$
1111 \begin_inset Formula $\Rightarrow$
1114 .tex, and does not compare the produced dvi or pdf output, it assumes that
1115 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
1117 There is only one chance to detect wrong output: before committing a new
1119 Once it is committed, it is quite difficult to verify whether it is correct.
1122 \begin_layout Standard
1127 update the test references by opening them with \SpecialChar LyX
1128 or directly running lyx2lyx
1130 This would not work, since lyx2lyx and \SpecialChar LyX
1131 produce slightly different files
1132 regarding insignificant whitespace and line breaks.
1135 \begin_layout Subsubsection
1139 \begin_layout Standard
1140 In many cases tests for new features may be added to one of the existing
1141 test files, but sometimes this is not possible or not wanted.
1142 Then a new test file needs to be added:
1145 \begin_layout Enumerate
1147 \begin_inset Flex Code
1150 \begin_layout Plain Layout
1151 src/tex2lyx/test/<test name>.tex
1156 and run tex2lyx in roundtrip mode to produce the file
1157 \begin_inset Flex Code
1160 \begin_layout Plain Layout
1161 src/tex2lyx/test/<test name>.lyx.lyx
1167 This file will be the new reference.
1170 \begin_layout Enumerate
1171 Once you confirmed that the tex2lyx output is correct, add the new files
1172 to the corresponding lists in
1173 \begin_inset Flex Code
1176 \begin_layout Plain Layout
1177 src/tex2lyx/test/runtests.py
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1187 src/tex2lyx/Makefile.am
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1197 src/tex2lyx/test/CMakeLists.txt
1205 \begin_layout Enumerate
1206 Commit the changes to the repository, or send a patch to the development
1207 list and ask for committing if you do not have commit rights.
1210 \begin_layout Subsection
1211 ctest automatic tests (cmake only)
1214 \begin_layout Standard
1215 Some tests are located in the
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1220 development/autotests
1225 subfolder of the \SpecialChar LyX
1226 source code distribution.
1228 \begin_inset Flex Code
1231 \begin_layout Plain Layout
1237 is required to run the automatic \SpecialChar LyX
1238 tests, running them is not implemented
1243 \begin_layout Standard
1244 The \SpecialChar LyX
1245 tests can be run by the commands
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1256 \begin_inset Flex Code
1259 \begin_layout Plain Layout
1265 (when using a make based build system and not MSVC) in the
1266 \begin_inset Flex Code
1269 \begin_layout Plain Layout
1275 subfolder of the build directory.
1278 \begin_layout Subsubsection
1282 \begin_layout Standard
1283 The export tests are integration tests.
1284 They take longer to run and are more likely to break than the tex2lyx tests.
1285 Nevertheless, they have caught many regressions and without a better alternativ
1286 e it is important to keep them up-to-date and understand how they work.
1289 \begin_layout Paragraph
1290 Expectations of LyX developers
1293 \begin_layout Standard
1294 Because the export tests are integration tests and take a long time to run,
1295 LyX developers are rarely expected to run all of the tests.
1296 Here are some good practices to follow by developers:
1299 \begin_layout Itemize
1300 When making a non-trivial change to a .layout file, run the export and layout
1301 tests corresponding with that .layout file.
1304 \begin_layout Itemize
1305 When making non-trivial changes to a .lyx file, run the export tests correspondin
1306 g to that .lyx file.
1309 \begin_layout Itemize
1310 When making non-trivial changes to LyX's \SpecialChar LaTeX
1312 touching the encoding code or package handling code that you expect will
1313 change the exported \SpecialChar LaTeX
1314 in some way), consider running all of the export tests
1315 before and after your change.
1316 If there are differences, please reconcile these (i.e.
1317 fix the bug or fix the tests)
1322 Ask for help if you're not sure what to do or if you do not want to run
1323 the tests, post the patch on the list and others will run the tests.
1326 \begin_layout Itemize
1327 Understand how to interpret test failures.
1328 If your commit is found to have broken a test, you should be able to interpret
1329 the test results when made aware of them.
1331 \begin_inset CommandInset ref
1333 reference "subsec:Interpreting-export-tests"
1340 \begin_layout Paragraph
1341 Configuring the tests
1344 \begin_layout Standard
1345 To enable these tests, add the
1346 \begin_inset Flex Code
1349 \begin_layout Plain Layout
1350 -DLYX_ENABLE_EXPORT_TESTS=ON
1359 \begin_layout Standard
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1364 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1372 \begin_layout Standard
1374 This flag will increase the time for the cmake command by several seconds,
1375 mainly because of the process of inverting tests (see Section
1376 \begin_inset CommandInset ref
1378 reference "subsec:Interpreting-export-tests"
1385 \begin_layout Paragraph
1389 \begin_layout Standard
1390 To run all tests, in the build directory simply run the command
1391 \begin_inset Flex Code
1394 \begin_layout Plain Layout
1401 To run only some of the tests, use the command
1402 \begin_inset Flex Code
1405 \begin_layout Plain Layout
1412 \begin_inset Flex Code
1415 \begin_layout Plain Layout
1421 is a regular expression that matches test names.
1422 To run only the export tests, you can use
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1433 For the list of test categories available in addition to
1434 \begin_inset Quotes eld
1438 \begin_inset Quotes erd
1442 \begin_inset Flex Code
1445 \begin_layout Plain Layout
1446 ctest \SpecialChar nobreakdash
1447 \SpecialChar nobreakdash
1454 It is often useful to list the tests without running them (e.g.
1455 if you want to know how many tests there are or whether your
1456 \begin_inset Flex Code
1459 \begin_layout Plain Layout
1465 regular expression did what you expected).
1466 This can be done with the
1467 \begin_inset Flex Code
1470 \begin_layout Plain Layout
1477 \begin_inset Flex Code
1480 \begin_layout Plain Layout
1481 \SpecialChar nobreakdash
1482 \SpecialChar nobreakdash
1489 We are still working on getting the tests to run in parallel which is supported
1491 \begin_inset Flex Code
1494 \begin_layout Plain Layout
1501 \begin_inset Flex Code
1504 \begin_layout Plain Layout
1511 \begin_inset Flex Code
1514 \begin_layout Plain Layout
1515 \SpecialChar nobreakdash
1516 \SpecialChar nobreakdash
1523 However, when running the tests in parallel, sometimes tests fail that
1524 pass when run sequentially.
1525 A reasonable approach is to first run the tests in parallel and then run
1526 the failed tests sequentially.
1527 For example, to run 8 jobs at a time:
1530 \begin_layout Standard
1531 \begin_inset Flex Code
1534 \begin_layout Plain Layout
1543 \begin_layout Standard
1544 \begin_inset Flex Code
1547 \begin_layout Plain Layout
1548 ctest \SpecialChar nobreakdash
1549 \SpecialChar nobreakdash
1558 \begin_layout Standard
1560 Note that some tests cannot be run in parallel.
1561 These tests are marked in the code with the
1562 \begin_inset Flex Code
1565 \begin_layout Plain Layout
1575 \begin_layout Standard
1576 In some situations the option
1577 \begin_inset Flex Code
1580 \begin_layout Plain Layout
1581 \SpecialChar nobreakdash
1582 \SpecialChar nobreakdash
1589 There have been bugs in LyX and in \SpecialChar LaTeX
1590 which cause compilation to hang, and
1591 without a timeout a test might never stop (in one case there was even a
1593 If a test times out, the
1594 \begin_inset Flex Code
1597 \begin_layout Plain Layout
1603 command exits with error, but you can distinguish between a timed out test
1604 and a failed test in the output reported at the end of the
1605 \begin_inset Flex Code
1608 \begin_layout Plain Layout
1617 \begin_layout Standard
1619 \begin_inset Flex Code
1622 \begin_layout Plain Layout
1628 ) the full list of command line options.
1631 \begin_layout Paragraph
1632 \begin_inset CommandInset label
1634 name "subsec:Interpreting-export-tests"
1638 Interpreting the export test results
1641 \begin_layout Standard
1642 A test can fail for several reasons, not all of them bad.
1645 \begin_layout Enumerate
1646 The .lyx file could have been added recently and some formats are not expected
1650 \begin_layout Enumerate
1651 A dependency is not met (e.g.
1652 the \SpecialChar LaTeX
1654 One hint that this is the case is that the corresponding
1655 \begin_inset Flex Code
1658 \begin_layout Plain Layout
1664 test will likely also fail.
1667 \begin_layout Enumerate
1668 An inverted test fails to fail (i.e.
1669 export that previously failed now works).
1672 \begin_layout Enumerate
1673 An external dependency was updated (e.g.
1678 \begin_layout Enumerate
1679 A recent code change introduced a bug.
1682 \begin_layout Enumerate
1683 \begin_inset CommandInset label
1689 A change in a document exposed a previously unknown bug or an incompatibility
1690 with an export format (e.g.
1691 Lua\SpecialChar LaTeX
1695 \begin_layout Standard
1696 Because the .lyx files are exported in several formats, it is not surprising
1697 that many of the exports fail.
1698 This expectation of failure is addressed by
1699 \begin_inset Quotes eld
1703 \begin_inset Quotes erd
1706 the tests, that is, by marking the test as
1707 \begin_inset Quotes eld
1711 \begin_inset Quotes erd
1714 if the export exits with error and as
1715 \begin_inset Quotes eld
1719 \begin_inset Quotes erd
1722 if the export succeeds
1727 It follows that these expected failures will not show up as failed tests
1728 in the test results and thus will not pollute the
1729 \begin_inset Quotes eld
1733 \begin_inset Quotes erd
1737 If the export actually succeeds, then the test will fail.
1738 The purpose of this failure is to get your attention—something has changed,
1739 possibly for the better.
1742 \begin_layout Standard
1743 We try to document why a test is inverted or ignored.
1744 See the comment (prefixed with
1745 \begin_inset Flex Code
1748 \begin_layout Plain Layout
1754 ) above the block in which the test is listed as inverted or ignored in
1756 \begin_inset Flex Code
1759 \begin_layout Plain Layout
1760 development/autotests/suspiciousTests
1766 \begin_inset Flex Code
1769 \begin_layout Plain Layout
1770 development/autotests/ignoredTests
1776 It is possible that an export goes from succeeding to failing just because
1777 the document was changed and the document was never expected to work with
1778 a certain export format in the first case.
1779 Once this is confirmed to be the situation, the test can be inverted.
1782 \begin_layout Standard
1783 A good question is why do we enable the tests for non-default formats? The
1784 answer is that if a non-default route is broken it is often because a bug
1785 was introduced in LyX and not because a document-specific change was made
1786 that is not supported by the route.
1787 In other words, there is a high signal/noise ratio in the export tests
1788 for some non-default formats.
1792 \begin_layout Standard
1793 What action should you take if a test fails? First, check manually that
1794 when the compilation succeeded before the resulting PDF was good.
1795 In fact, sometimes it is an improvement when a test fails.
1796 If you check manually, it might be the case that the export was succeeding
1797 before but showing garbled text in a PDF output.
1798 Now it might fail with a clear message of "language xyz not supported".
1799 It is always good to check manually why something fails and if it passes
1800 if the PDF output is good.
1803 \begin_layout Standard
1804 Sometimes a test is fixed as side-effect of some change.
1805 We should uninvert a test (remove it from the
1806 \begin_inset Flex Code
1809 \begin_layout Plain Layout
1815 file) in order to preserve the fix.
1818 \begin_layout Standard
1819 When a test or several tests fail, consider checking the files in the
1820 \begin_inset Flex Code
1823 \begin_layout Plain Layout
1829 subdirectory of your build directory.
1830 In this subdirectory are three files: the file
1831 \begin_inset Flex Code
1834 \begin_layout Plain Layout
1840 simply lists the tests that failed on your last
1841 \begin_inset Flex Code
1844 \begin_layout Plain Layout
1851 \begin_inset Flex Code
1854 \begin_layout Plain Layout
1860 file contains the output from the tests (and often has details explaining
1861 why a test failed); and the
1862 \begin_inset Flex Code
1865 \begin_layout Plain Layout
1871 file lists the times that it took to run the tests.
1874 \begin_layout Paragraph
1878 \begin_layout Standard
1879 These tests are expected to always fail.
1882 \begin_layout Description
1883 inverted These tests are expected to fail, but are subject to be examined.
1884 It is expected that they will pass in a foreseeable future.
1885 They are labeled 'inverted'.
1888 \begin_layout Description
1889 suspended Some inverted tests are labeled 'suspended'.
1890 This means, they are not executed using
1891 \begin_inset Flex Code
1894 \begin_layout Plain Layout
1901 \begin_inset Flex Code
1904 \begin_layout Plain Layout
1911 From time to time they still have to be checked using
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1925 \begin_layout Standard
1926 These tests are suspended, because they fail for known reasons which cannot
1928 But it is expected the reason might disappear in the future.
1929 Be it new TL or better handling in \SpecialChar LyX
1933 \begin_layout Standard
1934 For ctest commands without the
1935 \begin_inset Flex Code
1938 \begin_layout Plain Layout
1944 parameter nothing changes.
1945 Suspended or not, tests will be executed depending only on the regexes
1946 parameters given to the ctest command.
1950 \begin_layout Paragraph
1954 \begin_layout Description
1955 nonstandard Requires non-standard ressources (\SpecialChar LaTeX
1956 packages and document classes,
1957 fonts, ...) that are not a requirement for running this test suite.
1961 \begin_layout Standard
1962 These tests are labeled as
1968 \begin_layout Description
1970 \begin_inset Quotes eld
1974 \begin_inset Quotes erd
1977 result, depending on local configuration, OS, \SpecialChar TeX
1978 distribution, package versions,
1979 or the phase of the moon.
1983 \begin_layout Standard
1984 These tests are labeled as
1990 \begin_layout Paragraph
1991 Export test filtering
1994 \begin_layout Standard
1995 There are files which control the assignment of a label to a test.
1998 \begin_layout Description
1999 ignoredTests (small file)
2000 \begin_inset Newline newline
2003 Tests selected here are withdrawn
2007 \begin_layout Labeling
2008 \labelwidthstring 00.00.0000
2009 Input Test of any export combination
2012 \begin_layout Labeling
2013 \labelwidthstring 00.00.0000
2014 Output Stop if tests not selected here
2018 \begin_layout Description
2019 unreliableTests: Tests selected either pass or fail, but that is dependent
2020 on the system where the test is run.
2021 Selected tests gain the label 'unreliable'.
2025 \begin_layout Labeling
2026 \labelwidthstring 00.00.0000
2027 Input Each test which passed 'ignoredTests'
2030 \begin_layout Labeling
2031 \labelwidthstring 00.00.0000
2032 Output Stop if test selected, gain label 'unreliable'.
2036 \begin_layout Description
2038 \begin_inset space \space{}
2045 \begin_layout Labeling
2046 \labelwidthstring 00.00.0000
2047 Input Each test which passed 'unreliableTests'
2050 \begin_layout Labeling
2051 \labelwidthstring 00.00.0000
2052 Output Stop if not selected.
2055 \begin_layout Standard
2056 The following file is meant as subselections of 'suspiciousTests'.
2057 If neither subselection applies, test gains labels 'export' and 'inverted'
2060 \begin_layout Description
2061 suspendedTests Tests selected here gain the label 'suspended' but _not_
2062 'export' or 'inverted', although in ctest they remain inverted.
2063 ('ctest' knows only 'inverted' or not, labels are used only for test selection)
2067 \begin_layout Labeling
2068 \labelwidthstring 00.00.0000
2069 Input Each test selected by 'suspiciousTests'
2072 \begin_layout Labeling
2073 \labelwidthstring 00.00.0000
2074 Output Selected test gains label 'suspended'.
2080 \begin_layout Standard
2081 The following table may clarify label assignement
2084 \begin_layout Standard
2085 \begin_inset Tabular
2086 <lyxtabular version="3" rows="7" columns="12">
2087 <features tabularvalignment="middle">
2088 <column alignment="left" valignment="top" width="0pt">
2089 <column alignment="left" valignment="top" width="0pt">
2090 <column alignment="left" valignment="top" width="0pt">
2091 <column alignment="left" valignment="top" width="0pt">
2092 <column alignment="center" valignment="top">
2093 <column alignment="center" valignment="top">
2094 <column alignment="center" valignment="top">
2095 <column alignment="center" valignment="top">
2096 <column alignment="center" valignment="top">
2097 <column alignment="center" valignment="top">
2098 <column alignment="center" valignment="top">
2099 <column alignment="center" valignment="top">
2101 <cell multicolumn="1" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2104 \begin_layout Plain Layout
2110 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2113 \begin_layout Plain Layout
2119 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2122 \begin_layout Plain Layout
2128 <cell multicolumn="2" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2131 \begin_layout Plain Layout
2137 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2140 \begin_layout Plain Layout
2141 Marked in ctest, Assigned label
2146 <cell multicolumn="2" alignment="center" valignment="top" usebox="none">
2149 \begin_layout Plain Layout
2155 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2158 \begin_layout Plain Layout
2164 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2167 \begin_layout Plain Layout
2173 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2176 \begin_layout Plain Layout
2182 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2185 \begin_layout Plain Layout
2191 <cell multicolumn="2" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2194 \begin_layout Plain Layout
2200 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2203 \begin_layout Plain Layout
2211 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2214 \begin_layout Plain Layout
2220 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2223 \begin_layout Plain Layout
2229 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2232 \begin_layout Plain Layout
2238 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2241 \begin_layout Plain Layout
2247 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2250 \begin_layout Plain Layout
2256 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2259 \begin_layout Plain Layout
2265 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2268 \begin_layout Plain Layout
2274 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2277 \begin_layout Plain Layout
2283 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2286 \begin_layout Plain Layout
2292 <cell multicolumn="2" alignment="center" valignment="top" topline="true" usebox="none">
2295 \begin_layout Plain Layout
2301 <cell multicolumn="1" alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
2304 \begin_layout Plain Layout
2310 <cell multicolumn="2" alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2313 \begin_layout Plain Layout
2321 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2324 \begin_layout Plain Layout
2330 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2333 \begin_layout Plain Layout
2339 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2342 \begin_layout Plain Layout
2348 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2351 \begin_layout Plain Layout
2357 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2360 \begin_layout Plain Layout
2366 <cell alignment="center" valignment="top" topline="true" usebox="none">
2369 \begin_layout Plain Layout
2375 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2378 \begin_layout Plain Layout
2384 <cell alignment="center" valignment="top" topline="true" usebox="none">
2387 \begin_layout Plain Layout
2393 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2396 \begin_layout Plain Layout
2402 <cell alignment="center" valignment="top" topline="true" usebox="none">
2405 \begin_layout Plain Layout
2411 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2414 \begin_layout Plain Layout
2420 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2423 \begin_layout Plain Layout
2431 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2434 \begin_layout Plain Layout
2440 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2443 \begin_layout Plain Layout
2449 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2452 \begin_layout Plain Layout
2458 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2461 \begin_layout Plain Layout
2467 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2470 \begin_layout Plain Layout
2476 <cell alignment="center" valignment="top" topline="true" usebox="none">
2479 \begin_layout Plain Layout
2485 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2488 \begin_layout Plain Layout
2494 <cell alignment="center" valignment="top" topline="true" usebox="none">
2497 \begin_layout Plain Layout
2503 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2506 \begin_layout Plain Layout
2512 <cell alignment="center" valignment="top" topline="true" usebox="none">
2515 \begin_layout Plain Layout
2521 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2524 \begin_layout Plain Layout
2530 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2533 \begin_layout Plain Layout
2541 <cell multirow="4" alignment="left" valignment="middle" topline="true" leftline="true" usebox="none">
2544 \begin_layout Plain Layout
2550 <cell multirow="3" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2553 \begin_layout Plain Layout
2559 <cell multirow="3" alignment="left" valignment="middle" topline="true" bottomline="true" leftline="true" usebox="none">
2562 \begin_layout Plain Layout
2568 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2571 \begin_layout Plain Layout
2577 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2580 \begin_layout Plain Layout
2586 <cell alignment="center" valignment="top" topline="true" usebox="none">
2589 \begin_layout Plain Layout
2595 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2598 \begin_layout Plain Layout
2604 <cell alignment="center" valignment="top" topline="true" usebox="none">
2607 \begin_layout Plain Layout
2613 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2616 \begin_layout Plain Layout
2622 <cell alignment="center" valignment="top" topline="true" usebox="none">
2625 \begin_layout Plain Layout
2631 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2634 \begin_layout Plain Layout
2640 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2643 \begin_layout Plain Layout
2651 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2654 \begin_layout Plain Layout
2660 <cell multirow="4" alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
2663 \begin_layout Plain Layout
2669 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2672 \begin_layout Plain Layout
2678 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2681 \begin_layout Plain Layout
2687 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2690 \begin_layout Plain Layout
2696 <cell alignment="center" valignment="top" topline="true" usebox="none">
2699 \begin_layout Plain Layout
2705 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2708 \begin_layout Plain Layout
2714 <cell alignment="center" valignment="top" topline="true" usebox="none">
2717 \begin_layout Plain Layout
2723 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2726 \begin_layout Plain Layout
2732 <cell alignment="center" valignment="top" topline="true" usebox="none">
2735 \begin_layout Plain Layout
2741 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
2744 \begin_layout Plain Layout
2750 <cell alignment="center" valignment="top" topline="true" rightline="true" usebox="none">
2753 \begin_layout Plain Layout
2761 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2764 \begin_layout Plain Layout
2770 <cell multirow="4" alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2773 \begin_layout Plain Layout
2779 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2782 \begin_layout Plain Layout
2788 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2791 \begin_layout Plain Layout
2797 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2800 \begin_layout Plain Layout
2806 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2809 \begin_layout Plain Layout
2815 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2818 \begin_layout Plain Layout
2824 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2827 \begin_layout Plain Layout
2833 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2836 \begin_layout Plain Layout
2842 <cell alignment="center" valignment="top" topline="true" bottomline="true" usebox="none">
2845 \begin_layout Plain Layout
2851 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
2854 \begin_layout Plain Layout
2860 <cell alignment="center" valignment="top" topline="true" bottomline="true" rightline="true" usebox="none">
2863 \begin_layout Plain Layout
2877 \begin_layout Subsubsection
2881 \begin_layout Standard
2882 These tests check whether a .lyx file loads without any terminal messages.
2883 They correspond to the manual operations of simply opening a .lyx file on
2884 the terminal, exiting LyX once the file is loaded, and then checking whether
2885 there is any output from the terminal.
2886 These tests are useful for catching malformed .lyx files and parsing bugs.
2887 They can also be used to find a .lyx file in which an instance of something
2889 To do this, compile LyX with a local patch that outputs something to the
2890 terminal when an instance is found, and then run the check_load tests to
2891 see if any fail, which would mean that the situation occurs in the LyX
2892 documentation files corresponding to the failed tests.
2893 These tests are expectedly fragile: any LyX diagnostic message, which is
2894 not necessarily an error, would cause the tests to fail.
2895 Similarly, any message output by a library (e.g.
2896 Qt) would also cause failure.
2897 There are some messages that the check_load tests are instructed to ignore,
2898 which are stored in the file
2899 \begin_inset Flex Code
2902 \begin_layout Plain Layout
2903 development/autotests/filterCheckWarnings
2911 \begin_layout Standard
2912 Under cmake, the tests are labeled as 'load'.
2915 \begin_layout Subsubsection
2919 \begin_layout Standard
2920 The URL tests are enabled with the
2921 \begin_inset Flex Code
2924 \begin_layout Plain Layout
2925 -DLYX_ENABLE_URLTESTS=ON
2930 CMake flag and are useful for finding broken links in our documentation
2932 If a URL test fails, to see which link in particular was reported as broken,
2934 \begin_inset Flex Code
2937 \begin_layout Plain Layout
2944 These tests are extremely fragile (e.g.
2945 a test can depend on your Internet connection) and a failed URL test should
2946 not be taken too seriously.
2947 URL tests are labeled as
2952 \begin_layout Paragraph
2956 \begin_layout Standard
2957 cmake is required to run the \SpecialChar LyX
2958 tests, running them is not implemented for
2962 \begin_layout Standard
2963 The appropriate commands are:
2966 \begin_layout Itemize
2972 \begin_inset Newline newline
2975 runns all tests with label
2980 \begin_layout Itemize
2983 ctest -R 'check_.*urls'
2986 \begin_inset Newline newline
2989 runns the tests 'check_accessible_urls'
2992 \begin_layout Standard
2993 Associated test results can be examined in ctest-log directory in files
2994 of the form 'LastFailed.*URLS.log'
2997 \begin_layout Subsubsection
3001 \begin_layout Standard
3002 ctest label commands:
3005 \begin_layout Description
3006 \SpecialChar nobreakdash
3007 \SpecialChar nobreakdash
3008 print-labels shows all assigned labels
3011 \begin_layout Description
3012 \SpecialChar nobreakdash
3014 \begin_inset space ~
3017 labelname executes all tests to which this label is assigned to.
3018 A test may have more that one label.
3021 \begin_layout Description
3022 \SpecialChar nobreakdash
3024 \begin_inset space ~
3027 number executes tests in parallel using 'number' simultaneously processes.
3028 Some tests are marked as 'sequencial', for them this parameter has no effect.
3031 \begin_layout Section
3032 Development policies
3035 \begin_layout Standard
3036 This chapter lists some guidelines that should be followed.
3037 This list is not complete, and many guidelines are in separate chapters,
3039 \begin_inset Quotes eld
3042 When is an update of the .lyx file format number needed?
3043 \begin_inset Quotes erd
3047 \begin_inset CommandInset ref
3049 reference "sec:When-is-an"
3056 \begin_layout Subsection
3057 When to set a fixed milestone?
3060 \begin_layout Standard
3061 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
3065 \begin_layout Enumerate
3066 Somebody is actively working on a fix.
3069 \begin_layout Enumerate
3070 The bug is so severe that it would block the release if it is not fixed.
3073 \begin_layout Standard
3074 If a bug is important, but nobody is working on it, and it is no showstopper,
3075 use a milestone like 2.1.x or 2.2.x.
3076 For all other bugs, do not set a milestone at all.
3079 \begin_layout Subsection
3080 Can we add rc entries in stable branch?
3083 \begin_layout Standard
3085 We are supposed to increase the prefs2prefs version number with such things.
3088 \begin_layout Section
3089 Documentation policies
3092 \begin_layout Standard
3093 The main documentation consists of these files:
3096 \begin_layout Description
3097 splash.lyx it is the first file you see after an installation.
3098 We assume that a new user sees this.
3099 It is therefore designed to be as simple as possible.
3100 Therefore please don't add any new formatting, only fix typos etc.
3101 Splash.lyx is up to date for \SpecialChar LyX
3102 2.1.x, currently maintained by Uwe Stöhr.
3105 \begin_layout Description
3106 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
3108 It therefore uses a limited set of formatting.
3109 For example a standard document class.
3110 Since new users will first learn about the formatting possibilities of
3112 please keep this file that simple.
3113 Intro.lyx is up to date for \SpecialChar LyX
3114 2.1.x, currently maintained by Uwe Stöhr.
3117 \begin_layout Description
3118 Tutorial.lyx our tutorial.
3119 It must be always up to date.
3120 Normally there is nothing to add since we don't want to overwhelm new users
3121 with too much details.
3122 The will learn these details while using \SpecialChar LyX
3123 and we have special manuals.
3124 Tutorial.lyx is up to date for \SpecialChar LyX
3125 2.1.x, currently maintained by Uwe Stöhr.
3128 \begin_layout Description
3129 UserGuide.lyx our main user guide.
3130 It covers a mixture of basic and detailed information.
3131 Some information is also in the Math and EmbeddedObjects manual so that
3132 the UserGuide refers to these files.
3133 UserGuide.lyx is up to date for \SpecialChar LyX
3134 2.1.x, currently maintained by Uwe Stöhr.
3137 \begin_layout Description
3138 EmbeddedObjects.lyx a special manual to explain things like tables floats
3141 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
3142 2.1.x, currently maintained by Uwe
3146 \begin_layout Description
3147 Math.lyx a special manual to explain everything regarding math in all detail.
3148 Math.lyx is up to date for \SpecialChar LyX
3149 2.1.x, currently maintained by Uwe Stöhr.
3152 \begin_layout Description
3153 Additional.lyx this manual covers information that would be too much detail
3154 for the UserGuide or would make the UserGuide uncompilable or only compilable
3155 when installing a lot of special \SpecialChar LaTeX
3157 What should be in the UserGuide or better in Additional is a matter of
3159 it is up to you to decide that.
3160 Additional.lyx is not completely up to date for \SpecialChar LyX
3163 \begin_inset space ~
3166 8 is up to date and currently maintained by Uwe Stöhr.
3167 It certainly needs a rewrite and update.
3168 For example many info in chapter
3169 \begin_inset space ~
3172 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
3176 \begin_layout Description
3177 Customization.lyx this manual covers information how to customize \SpecialChar LyX
3179 output formats, operating systems, languages etc.
3180 It is currently completely out of date and needs a major rewrite and update.
3181 If you do this please assure that your information are given for all OSes
3182 and \SpecialChar LaTeX
3183 distributions (meaning be as objective as possible).
3186 \begin_layout Standard
3188 \begin_inset space ~
3191 rules in editing the docs:
3194 \begin_layout Enumerate
3195 If you are not the maintainer of a doc file or a chapter/section, you MUST
3196 use change tracking so that the maintainer could review your changes
3199 \begin_layout Enumerate
3200 Respect the formatting of the document.
3201 The different files use different formatting styles.
3202 That is OK and has historic reasons nobody fully know ;-).
3203 But it is important to be consistent within one file.
3206 \begin_layout Enumerate
3207 All changes you make to a file in one language MUST also go the file in
3208 the other actively maintained languages.
3209 Normally the maintainer does this for you, if you are the maintainer, you
3210 must do this by copying or changing the changed or added text to the other
3211 files so that the translators sees the blue underlined text and know what
3212 they have to translate and what was changed.
3215 \begin_layout Enumerate
3216 You MUST assure that the document is compilable as
3217 \begin_inset Quotes eld
3221 \begin_inset Quotes erd