1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
7 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
8 \use_default_options false
16 \maintain_unincluded_children false
19 InsetLayout CharStyle:MenuItem
28 \newcommand*{\menuitem}[1]{{\sffamily #1}}
33 \language_package default
38 \font_typewriter default
40 \font_default_family default
41 \use_non_tex_fonts false
47 \default_output_format default
49 \bibtex_command default
50 \index_command default
54 \pdf_title "LyX's Development manual"
55 \pdf_author "LyX Team"
56 \pdf_subject "LyX's development documentation"
57 \pdf_keywords "LyX, Documentation, Development"
59 \pdf_bookmarksnumbered true
60 \pdf_bookmarksopen true
61 \pdf_bookmarksopenlevel 1
66 \pdf_pdfusetitle false
67 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
70 \use_package amsmath 1
71 \use_package amssymb 1
74 \use_package mathdots 1
75 \use_package mathtools 0
77 \use_package stackrel 0
78 \use_package stmaryrd 0
79 \use_package undertilde 0
81 \cite_engine_type default
85 \paperorientation portrait
89 \notefontcolor #0000ff
96 \paragraph_separation indent
97 \paragraph_indentation default
98 \quotes_language english
101 \paperpagestyle headings
102 \tracking_changes false
103 \output_changes false
112 Developing \SpecialChar LyX
116 \begin_layout Subtitle
121 by the \SpecialChar LyX
126 \begin_layout Plain Layout
128 If you have comments or error corrections, please send them to the \SpecialChar LyX
131 \begin_inset Flex Code
134 \begin_layout Plain Layout
136 <lyx-docs@lists.lyx.org>
149 \begin_layout Standard
150 \begin_inset CommandInset toc
151 LatexCommand tableofcontents
158 \begin_layout Chapter
162 \begin_layout Standard
163 This manual documents some aspects of \SpecialChar LyX
165 It is currently rather incomplete, but will hopefully be extended in the
167 Meanwhile, additional information can be found in the
168 \begin_inset Flex Code
171 \begin_layout Plain Layout
177 subfolder of the \SpecialChar LyX
178 source code distribution.
179 This document is not translated, since the development language of \SpecialChar LyX
182 If you want to use \SpecialChar LyX
183 you don't need to read this manual.
184 However, if you want to learn more about how \SpecialChar LyX
185 is developed, or even want
186 to participate in \SpecialChar LyX
187 development, you may find some interesting information.
190 \begin_layout Chapter
194 \begin_layout Standard
196 uses several custom file formats for configuration files and documents.
197 This chapter contains some background concerning these file formats.
198 Several file formats are also described in detail in the regular user documenta
202 \begin_layout Section
206 \begin_layout Section
207 When is an update of the .lyx file format number needed?
208 \begin_inset CommandInset label
210 name "sec:When-is-an"
217 \begin_layout Standard
218 When you are working on a new feature you may ask yourself whether it needs
219 an update of the .lyx file format number.
220 Whether an update is needed or not is not always obvious.
221 Below you can find a list of reasons for file format updates with explanations:
224 \begin_layout Description
233 setting Whenever you introduce a new setting that is stored in the document
234 header, a file format update is needed.
235 This is also true if you add a new valid value to an existing setting,
237 \begin_inset space \thinspace{}
241 \begin_inset space \space{}
244 a new language that is stored in
245 \begin_inset Flex Code
248 \begin_layout Plain Layout
259 \begin_layout Description
268 setting If a certain setting becomes obsolete and gets removed, a file format
272 \begin_layout Description
277 inset Of course a new inset requires a file format update.
280 \begin_layout Description
285 style in any layout file or module shipped with \SpecialChar LyX
286 , or new shipped layout
288 These requirements are currently under discussion and might change in the
292 \begin_layout Description
305 package Any new math package that is automatically loaded needs a file format
307 The reason for this is that there is no true ERT inset for math formulas:
308 Each command is parsed, and if a user happens to defne a local command
309 with the same name as a command that triggers an automatic load of a package,
310 he needs to be able to switch off the automatic loading of that package.
311 This switch is stored by the
312 \begin_inset Flex Code
315 \begin_layout Plain Layout
324 \begin_layout Standard
325 If you are still unsure, please ask on the development list.
328 \begin_layout Section
329 How to update the file format number of .lyx files
332 \begin_layout Standard
333 Once you came to the conclusion that a file format update is needed you
334 should use the following procedure to perform the update:
337 \begin_layout Enumerate
338 Implement and test the new feature, including the reading and writing of
340 Note that any file produced at this stage does not use a valid format,
341 so do not use this version of \SpecialChar LyX
342 for working on any important documents.
345 \begin_layout Enumerate
346 Describe the new format in
347 \begin_inset Flex Code
350 \begin_layout Plain Layout
359 \begin_layout Enumerate
360 Update the \SpecialChar LyX
361 file format number in
362 \begin_inset Flex Code
365 \begin_layout Plain Layout
374 \begin_layout Enumerate
375 Add an entry to both format lists (for conversion and reversion) in
376 \begin_inset Newline newline
380 \begin_inset Flex Code
383 \begin_layout Plain Layout
384 lib/lyx2lyx/lyx_2_2.py
390 Add a conversion routine if needed (e.
391 \begin_inset space \thinspace{}
395 \begin_inset space \space{}
398 a new header setting always needs a conversion that adds the new setting,
399 a new document language does not need one).
400 Add a reversion routine if needed.
401 While the conversion routine is required to produce a document that is
402 equivalent to the old version, the requirements of the reversion are not
404 If possible, try to produce a proper reversion, using ERT if needed, but
405 for some features this might be too complicated.
406 In this case, the minimum requirement of the reversion routine is that
407 it produces a valid document which can be read by an older \SpecialChar LyX
409 If absolutely needed, even data loss is allowed for the reversion.
412 \begin_layout Enumerate
413 Since tex2lyx has several implicit file format dependencies caused by sharing
414 code with \SpecialChar LyX
415 , updating the file format of .lyx files produced by tex2lyx at
416 the same time as updating the main .lyx file format is strongly recommended.
417 Therefore, a compiler warning will be issued if the \SpecialChar LyX
418 and tex2lyx .lyx file
419 format numbers differ.
420 In many cases the tex2lyx update requires only the first and last item
422 \begin_inset Separator parbreak
429 \begin_layout Enumerate
430 Update the tex2lyx file format number in
431 \begin_inset Flex Code
434 \begin_layout Plain Layout
443 \begin_layout Enumerate
444 If the lyx2lyx conversion from the old to the new format is empty, or if
445 tex2lyx does not yet output the changed feature, you do not need any further
447 Otherwise, search for the changed feature in tex2lyx, and adjust the output
448 according to the lyx2lyx changes.
451 \begin_layout Enumerate
452 Update the tex2lyx test references as described in
453 \begin_inset CommandInset ref
454 LatexCommand formatted
455 reference "sec:Updating-test-references"
463 \begin_layout Enumerate
464 If you did not implement full tex2lyx support of the new feature, add a
466 \begin_inset Flex Code
469 \begin_layout Plain Layout
475 describing the missing bits.
476 Note that it is perfectly fine if you do not add full tex2lyx support for
477 a new feature: The updating recommendation above is only issued for the
478 syntax of the produced .lyx file.
479 It is no problem if some features supported by \SpecialChar LyX
480 are still output as ERT
481 by tex2lyx, since the problems in the past that resulted in the update
482 recommendation were related to mixed version syntax, not ERT.
485 \begin_layout Enumerate
486 It would be nice if you could create a .lyx test file which contains instances
487 of all changed or added features.
488 This could then be used to test lyxl2yx and tex2lyx.
489 Unfortunately it has not yet been decided how to collect such examples,
490 so please ask on the development list if you want to create one.
493 \begin_layout Section
494 Backporting new styles to the stable version
497 \begin_layout Standard
498 Starting with the stable \SpecialChar LyX
499 2.1 branch, there is a mechanism in place to backport
500 new styles to the stable version without the need to update the file format.
501 The basic idea is that the new style definition is automatically copied
502 to the document preamble, so that it can even be used by older minor revisions
503 that did not yet include the style.
504 To backport a new style to the stable version, the following steps are
508 \begin_layout Enumerate
510 \begin_inset Flex Code
513 \begin_layout Plain Layout
519 to the style definition in the development version.
522 \begin_layout Enumerate
523 Copy the style definition to the stable version, but use
524 \begin_inset Flex Code
527 \begin_layout Plain Layout
534 If needed adjust the format to the one used by the stable version (see
535 the customization manual for details of the layout file format).
538 \begin_layout Enumerate
539 For each update of the style in a later stable version, increase the argument
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
550 by one (in the stable version, the development version should not be touched).
553 \begin_layout Standard
554 For details about the
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
564 flag see the customization manual.
566 \begin_inset Flex Code
569 \begin_layout Plain Layout
575 support is needed for backported styles: Since the style of the development
576 version has an infinite version number, it will always be used.
577 Furthermore, since its version number is less than one, the style will
578 not be written anymore to the document header for files saved by the new
582 \begin_layout Chapter
586 \begin_layout Standard
587 Automated tests are an important tool to detect bugs and regressions in
588 software development.
589 Some projects like gcc even require each bug fix to be accompanied by a
590 test case for the automatic test suite, that would detect this bug.
591 Testing interactive features automatically is of course very hard, but
592 core functionality like document import and export can be tested quite
593 easily, and some tests of this kind exist.
596 \begin_layout Section
601 \begin_layout Standard
602 Some tests are located in the
603 \begin_inset Flex Code
606 \begin_layout Plain Layout
607 development/autotests
612 subfolder of the \SpecialChar LyX
613 source code distribution.
616 \begin_layout Subsection
620 \begin_layout Standard
621 cmake is required to run the \SpecialChar LyX
622 tests, running them is not implemented for
625 tests can be run by the commands
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
645 (when using a make based build system and not MSVC) in the
646 \begin_inset Flex Code
649 \begin_layout Plain Layout
655 subfolder of the build directory.
658 \begin_layout Section
662 \begin_layout Standard
663 The tex2lyx tests are located in the
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 subfolder of the \SpecialChar LyX
674 source code distribution.
675 The actual testing is performed by the simple python script
676 \begin_inset Flex Code
679 \begin_layout Plain Layout
680 src/tex2lyx/test/runtests.py
686 Each test consists of two files:
687 \begin_inset Flex Code
690 \begin_layout Plain Layout
696 contains the \SpecialChar LaTeX
697 code that should be tested.
699 \begin_inset Flex Code
702 \begin_layout Plain Layout
708 contains the expected output of tex2lyx.
709 When a test is run, the actual produced output is compared with the stored
711 The test passes if both are identical.
712 The test machinery is also able to generate a file
713 \begin_inset Flex Code
716 \begin_layout Plain Layout
722 by exporting the produced .lyx file with \SpecialChar LyX
724 This may be useful for roundtrip comparisons.
727 \begin_layout Subsection
731 \begin_layout Standard
732 The tex2lyx tests can be run in several ways.
734 \begin_inset Flex Code
737 \begin_layout Plain Layout
743 subfolder of the build directory, the commands
744 \begin_inset Flex Code
747 \begin_layout Plain Layout
753 (cmake, all platforms),
754 \begin_inset Flex Code
757 \begin_layout Plain Layout
763 (cmake, when using a make based build system and not MSVC) or
764 \begin_inset Flex Code
767 \begin_layout Plain Layout
773 (autotools) will run the tex2lyx tests.
774 Alternatively, in the root of the build directory, the command
775 \begin_inset Flex Code
778 \begin_layout Plain Layout
784 runs all tests whose names match the regex
785 \begin_inset Quotes eld
789 \begin_inset Quotes erd
793 Another way to run the tex2lyx tests in the root build directory is to
794 instead use the command
795 \begin_inset Flex Code
798 \begin_layout Plain Layout
799 ctest -L '(cmplyx|roundtrip)'
804 , which runs all tests categorized with the label
805 \begin_inset Quotes eld
809 \begin_inset Quotes erd
813 \begin_inset Quotes eld
817 \begin_inset Quotes erd
821 If a test fails, the differences between the expected and actual results
822 are output in unified diff format.
825 \begin_layout Subsection
826 Updating test references
827 \begin_inset CommandInset label
829 name "sec:Updating-test-references"
836 \begin_layout Standard
837 In some cases a changed tex2lyx output is not a test failure, but wanted,
839 \begin_inset space \thinspace{}
843 \begin_inset space \space{}
846 if a tex2lyx bug was fixed, or a new feature was added.
847 In these cases the stored references need to be updated.
848 To do so if using autotools, call
849 \begin_inset Flex Code
852 \begin_layout Plain Layout
859 \begin_inset Flex Code
862 \begin_layout Plain Layout
868 subdirectory of the build directory.
869 If instead using CMake, call
870 \begin_inset Flex Code
873 \begin_layout Plain Layout
874 make updatetex2lyxtests
879 in the build directory or in the
880 \begin_inset Flex Code
883 \begin_layout Plain Layout
889 subdirectory of the build directory
893 \begin_layout Plain Layout
894 Note that this is a case where a make target in the build directory can
895 affect the source directory, which might not be advisable.
901 For convenience, these commands also produce re-exported roundtrip .lyx.tex
903 Please examine the changed output carefully before committing the changed
904 files to the repository: Since the test machinery does not do a roundtrip
906 \begin_inset Formula $\Rightarrow$
910 \begin_inset Formula $\Rightarrow$
913 .tex, and does not compare the produced dvi or pdf output, it assumes that
914 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
916 There is only one chance to detect wrong output: before committing a new
918 Once it is committed, it is quite difficult to verify whether it is correct.
921 \begin_layout Standard
926 update the test references by opening them with \SpecialChar LyX
927 or directly running lyx2lyx
929 This would not work, since lyx2lyx and \SpecialChar LyX
930 produce slightly different files
931 regarding insignificant whitespace and line breaks.
934 \begin_layout Subsection
938 \begin_layout Standard
939 In many cases tests for new features may be added to one of the existing
940 test files, but sometimes this is not possible or not wanted.
941 Then a new test file needs to be added:
944 \begin_layout Enumerate
946 \begin_inset Flex Code
949 \begin_layout Plain Layout
950 src/tex2lyx/test/<test name>.tex
955 and run tex2lyx in roundtrip mode to produce the file
956 \begin_inset Flex Code
959 \begin_layout Plain Layout
960 src/tex2lyx/test/<test name>.lyx.lyx
966 This file will be the new reference.
969 \begin_layout Enumerate
970 Once you confirmed that the tex2lyx output is correct, add the new files
971 to the corresponding lists in
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
976 src/tex2lyx/test/runtests.py
982 \begin_inset Flex Code
985 \begin_layout Plain Layout
986 src/tex2lyx/Makefile.am
992 \begin_inset Flex Code
995 \begin_layout Plain Layout
996 src/tex2lyx/test/CMakeLists.txt
1004 \begin_layout Enumerate
1005 Commit the changes to the repository, or send a patch to the development
1006 list and ask for committing if you do not have commit rights.
1009 \begin_layout Section
1013 \begin_layout Standard
1014 The export tests are integration tests.
1015 They take longer to run and are more likely to break than the tex2lyx tests.
1016 Nevertheless, they have caught many regressions and without a better alternativ
1017 e it is important to keep them up-to-date and understand how they work.
1020 \begin_layout Subsection
1021 Expectations of LyX developers
1024 \begin_layout Standard
1025 Because the export tests are integration tests and take a long time to run,
1026 LyX developers are rarely expected to run all of the tests.
1027 Here are some good practices to follow by developers:
1030 \begin_layout Itemize
1031 When making a non-trivial change to a .layout file, run the export and layout
1032 tests corresponding with that .layout file.
1035 \begin_layout Itemize
1036 When making non-trivial changes to a .lyx file, run the export tests correspondin
1037 g to that .lyx file.
1040 \begin_layout Itemize
1041 When making non-trivial changes to LyX's LaTeX export code (e.g.
1042 touching the encoding code or package handling code that you expect will
1043 change the exported LaTeX in some way), consider running all of the export
1044 tests before and after your change.
1045 If there are differences, please reconcile these (i.e.
1046 fix the bug or fix the tests)
1051 Ask for help if you're not sure what to do or if you do not want to run
1052 the tests, post the patch on the list and others will run the tests.
1055 \begin_layout Itemize
1056 Understand how to interpret test failures.
1057 If your commit is found to have broken a test, you should be able to interpret
1058 the test results when made aware of them.
1060 \begin_inset CommandInset ref
1062 reference "subsec:Interpreting-export-tests"
1069 \begin_layout Subsection
1070 Configuring the tests
1073 \begin_layout Standard
1074 To enable these tests when using CMake, add the
1075 \begin_inset Flex Code
1078 \begin_layout Plain Layout
1079 -DLYX_ENABLE_EXPORT_TESTS=ON
1088 \begin_layout Standard
1089 \begin_inset Flex Code
1092 \begin_layout Plain Layout
1093 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1101 \begin_layout Standard
1103 This flag will increase the time for the cmake command by several seconds,
1104 mainly because of the process of inverting tests (see Section
1105 \begin_inset CommandInset ref
1107 reference "subsec:Interpreting-export-tests"
1114 \begin_layout Subsection
1118 \begin_layout Standard
1119 To run all tests, in the build directory simply run the command
1120 \begin_inset Flex Code
1123 \begin_layout Plain Layout
1130 To run only some of the tests, use the command
1131 \begin_inset Flex Code
1134 \begin_layout Plain Layout
1141 \begin_inset Flex Code
1144 \begin_layout Plain Layout
1150 is a regular expression that matches test names.
1151 To run only the export tests, you can use
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1162 For the list of test categories available in addition to
1163 \begin_inset Quotes eld
1167 \begin_inset Quotes erd
1171 \begin_inset Flex Code
1174 \begin_layout Plain Layout
1175 ctest --print-labels
1181 It is often useful to list the tests without running them (e.g.
1182 if you want to know how many tests there are or whether your
1183 \begin_inset Flex Code
1186 \begin_layout Plain Layout
1192 regular expression did what you expected).
1193 This can be done with the
1194 \begin_inset Flex Code
1197 \begin_layout Plain Layout
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1214 We are still working on getting the tests to run in parallel which is supported
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1226 \begin_inset Flex Code
1229 \begin_layout Plain Layout
1236 \begin_inset Flex Code
1239 \begin_layout Plain Layout
1246 However, when running the tests in parallel, sometimes tests fail that
1247 pass when run sequentially.
1248 A reasonable approach is to first run the tests in parallel and then run
1249 the failed tests sequentially.
1250 For example, to run 8 jobs at a time:
1253 \begin_layout Standard
1254 \begin_inset Flex Code
1257 \begin_layout Plain Layout
1266 \begin_layout Standard
1267 \begin_inset Flex Code
1270 \begin_layout Plain Layout
1271 ctest \SpecialChar nobreakdash
1272 \SpecialChar nobreakdash
1281 \begin_layout Standard
1283 Note that some tests cannot be run in parallel.
1284 These tests are marked in the code with the
1285 \begin_inset Flex Code
1288 \begin_layout Plain Layout
1298 \begin_layout Standard
1299 In some situations the option
1300 \begin_inset Flex Code
1303 \begin_layout Plain Layout
1310 There have been bugs in LyX and in LaTeX which cause compilation to hang,
1311 and without a timeout a test might never stop (in one case there was even
1313 If a test times out, the
1314 \begin_inset Flex Code
1317 \begin_layout Plain Layout
1323 command exits with error, but you can distinguish between a timed out test
1324 and a failed test in the output reported at the end of the
1325 \begin_inset Flex Code
1328 \begin_layout Plain Layout
1337 \begin_layout Subsection
1338 \begin_inset CommandInset label
1340 name "subsec:Interpreting-export-tests"
1344 Interpreting the export test results
1347 \begin_layout Standard
1348 A test can fail for several reasons, not all of them bad.
1351 \begin_layout Enumerate
1352 The .lyx file could have been added recently and some formats are not expected
1356 \begin_layout Enumerate
1357 A dependency is not met (e.g.
1358 the LaTeX class file).
1359 One hint that this is the case is that the corresponding
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1369 test will likely also fail.
1372 \begin_layout Enumerate
1373 An export that previously failed to compile now compiles.
1376 \begin_layout Enumerate
1377 An external dependency was updated (e.g.
1381 \begin_layout Enumerate
1382 A recent code change introduced a bug.
1385 \begin_layout Enumerate
1386 \begin_inset CommandInset label
1392 A change in a document exposed the incompatibility of that class with an
1397 \begin_layout Standard
1398 Because the .lyx files are exported in several formats, it is not surprising
1399 that many of the exports fail.
1400 This expectation of failure is addressed by
1401 \begin_inset Quotes eld
1405 \begin_inset Quotes erd
1408 the tests, that is, by marking the test as
1409 \begin_inset Quotes eld
1413 \begin_inset Quotes erd
1416 if the export exits with error and as
1417 \begin_inset Quotes eld
1421 \begin_inset Quotes erd
1424 if the export succeeds
1429 It follows that these expected failures will not show up as failed tests
1430 in the test results and thus will not pollute the
1431 \begin_inset Quotes eld
1435 \begin_inset Quotes erd
1439 If the export actually succeeds, then the test will fail.
1440 The purpose of this failure is to get your attention—something has changed,
1441 possibly for the better.
1444 \begin_layout Standard
1445 We try to document why a test is inverted or ignored.
1446 See the comment (prefixed with
1447 \begin_inset Flex Code
1450 \begin_layout Plain Layout
1456 ) above the block in which the test is listed as inverted or ignored in
1458 \begin_inset Flex Code
1461 \begin_layout Plain Layout
1462 development/autotests/revertedTests
1468 \begin_inset Flex Code
1471 \begin_layout Plain Layout
1472 development/autotests/ignoredTests
1478 It is possible that an export goes from succeeding to failing just because
1479 the document was changed and the document was never expected to work with
1480 a certain export format in the first case.
1481 Once this is confirmed to be the situation, the test can be inverted.
1484 \begin_layout Standard
1485 A good question is why do we enable the tests for non-default formats? The
1486 answer is that if a non-default route is broken it is often because a bug
1487 was introduced in LyX and not because a document-specific change was made
1488 that is not supported by the route.
1489 In other words, there is a high signal/noise ratio in the export tests
1490 for the non-default formats.
1494 \begin_layout Standard
1495 What action should you take if a test fails? First, check manually that
1496 when the compilation succeeded before the resulting PDF was good.
1497 In fact, sometimes it is an improvement when a test fails.
1498 If you check manually, it might be the case that the export was succeeding
1499 before but showing garbled text in a PDF output.
1500 Now it might fail with a clear message of "language xyz not supported".
1501 It is always good to check manually why something fails and if it passes
1502 if the PDF output is good.
1505 \begin_layout Standard
1506 Sometimes a test is fixed by accident.
1507 We should uninvert a test (remove it from the
1508 \begin_inset Flex Code
1511 \begin_layout Plain Layout
1517 file) in order to preserve the fix.
1520 \begin_layout Standard
1521 When a test or several tests fail, consider checking the files in the
1522 \begin_inset Flex Code
1525 \begin_layout Plain Layout
1531 subdirectory of your build directory.
1532 In this subdirectory are three files: the file
1533 \begin_inset Flex Code
1536 \begin_layout Plain Layout
1542 simply lists the tests that failed on your last
1543 \begin_inset Flex Code
1546 \begin_layout Plain Layout
1553 \begin_inset Flex Code
1556 \begin_layout Plain Layout
1562 file contains the output from the tests (and often has details explaining
1563 why a test failed); and the
1564 \begin_inset Flex Code
1567 \begin_layout Plain Layout
1573 file lists the times that it took to run the tests.
1576 \begin_layout Section
1580 \begin_layout Standard
1581 These tests check whether a .lyx file loads without any terminal messages.
1582 They correspond to the manual operations of simply opening a .lyx file on
1583 the terminal, exiting LyX once the file is loaded, and then checking whether
1584 there is any output from the terminal.
1585 These tests are useful for catching malformed .lyx files and parsing bugs.
1586 They can also be used to find a .lyx file in which an instance of something
1588 To do this, compile LyX with a local patch that outputs something to the
1589 terminal when an instance is found, and then run the check_load tests to
1590 see if any fail, which would mean that the situation occurs in the LyX
1591 documentation files corresponding to the failed tests.
1592 These tests are expectedly fragile: any LyX diagnostic message, which is
1593 not necessarily an error, would cause the tests to fail.
1594 Similarly, any message output by a library (e.g.
1595 Qt) would also cause failure.
1596 There are some messages that the check_load tests are instructed to ignore,
1597 which are stored in the file
1598 \begin_inset Flex Code
1601 \begin_layout Plain Layout
1602 development/autotests/filterCheckWarnings
1610 \begin_layout Section
1614 \begin_layout Standard
1615 The URL tests are enabled with the
1616 \begin_inset Flex Code
1619 \begin_layout Plain Layout
1620 -DLYX_ENABLE_URLTESTS=ON
1625 CMake flag and are useful for finding broken links in our documentation
1627 If a URL test fails, to see which link in particular was reported as broken,
1629 \begin_inset Flex Code
1632 \begin_layout Plain Layout
1639 These tests are extremely fragile (e.g.
1640 a test can depend on your Internet connection) and a failed URL test should
1641 not be taken too seriously.
1644 \begin_layout Chapter
1645 Development policies
1648 \begin_layout Standard
1649 This chapter lists some guidelines that should be followed.
1650 This list is not complete, and many guidelines are in separate chapters,
1652 \begin_inset Quotes eld
1655 When is an update of the .lyx file format number needed?
1656 \begin_inset Quotes erd
1660 \begin_inset CommandInset ref
1662 reference "sec:When-is-an"
1669 \begin_layout Section
1670 When to set a fixed milestone?
1673 \begin_layout Standard
1674 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
1678 \begin_layout Enumerate
1679 Somebody is actively working on a fix.
1682 \begin_layout Enumerate
1683 The bug is so severe that it would block the release if it is not fixed.
1686 \begin_layout Standard
1687 If a bug is important, but nobody is working on it, and it is no showstopper,
1688 use a milestone like 2.1.x or 2.2.x.
1689 For all other bugs, do not set a milestone at all.
1692 \begin_layout Section
1693 Can we add rc entries in stable branch?
1696 \begin_layout Standard
1698 We are supposed to increase the prefs2prefs version number with such things.
1701 \begin_layout Chapter
1702 Documentation policies
1705 \begin_layout Standard
1706 The main documentation consists of these files:
1709 \begin_layout Description
1710 splash.lyx it is the first file you see after an installation.
1711 We assume that a new user sees this.
1712 It is therefore designed to be as simple as possible.
1713 Therefore please don't add any new formatting, only fix typos etc.
1714 Splash.lyx is up to date for \SpecialChar LyX
1715 2.1.x, currently maintained by Uwe Stöhr.
1718 \begin_layout Description
1719 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
1721 It therefore uses a limited set of formatting.
1722 For example a standard document class.
1723 Since new users will first learn about the formatting possibilities of
1725 please keep this file that simple.
1726 Intro.lyx is up to date for \SpecialChar LyX
1727 2.1.x, currently maintained by Uwe Stöhr.
1730 \begin_layout Description
1731 Tutorial.lyx our tutorial.
1732 It must be always up to date.
1733 Normally there is nothing to add since we don't want to overwhelm new users
1734 with too much details.
1735 The will learn these details while using \SpecialChar LyX
1736 and we have special manuals.
1737 Tutorial.lyx is up to date for \SpecialChar LyX
1738 2.1.x, currently maintained by Uwe Stöhr.
1741 \begin_layout Description
1742 UserGuide.lyx our main user guide.
1743 It covers a mixture of basic and detailed information.
1744 Some information is also in the Math and EmbeddedObjects manual so that
1745 the UserGuide refers to these files.
1746 UserGuide.lyx is up to date for \SpecialChar LyX
1747 2.1.x, currently maintained by Uwe Stöhr.
1750 \begin_layout Description
1751 EmbeddedObjects.lyx a special manual to explain things like tables floats
1754 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
1755 2.1.x, currently maintained by Uwe
1759 \begin_layout Description
1760 Math.lyx a special manual to explain everything regarding math in all detail.
1761 Math.lyx is up to date for \SpecialChar LyX
1762 2.1.x, currently maintained by Uwe Stöhr.
1765 \begin_layout Description
1766 Additional.lyx this manual covers information that would be too much detail
1767 for the UserGuide or would make the UserGuide uncompilable or only compilable
1768 when installing a lot of special \SpecialChar LaTeX
1770 What should be in the UserGuide or better in Additional is a matter of
1772 it is up to you to decide that.
1773 Additional.lyx is not completely up to date for \SpecialChar LyX
1776 \begin_inset space ~
1779 8 is up to date and currently maintained by Uwe Stöhr.
1780 It certainly needs a rewrite and update.
1781 For example many info in chapter
1782 \begin_inset space ~
1785 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
1789 \begin_layout Description
1790 Customization.lyx this manual covers information how to customize \SpecialChar LyX
1792 output formats, operating systems, languages etc.
1793 It is currently completely out of date and needs a major rewrite and update.
1794 If you do this please assure that your information are given for all OSes
1795 and \SpecialChar LaTeX
1796 distributions (meaning be as objective as possible).
1799 \begin_layout Standard
1801 \begin_inset space ~
1804 rules in editing the docs:
1807 \begin_layout Enumerate
1808 If you are not the maintainer of a doc file or a chapter/section, you MUST
1809 use change tracking so that the maintainer could review your changes
1812 \begin_layout Enumerate
1813 Respect the formatting of the document.
1814 The different files use different formatting styles.
1815 That is OK and has historic reasons nobody fully know ;-).
1816 But it is important to be consistent within one file.
1819 \begin_layout Enumerate
1820 All changes you make to a file in one language MUST also go the file in
1821 the other actively maintained languages.
1822 Normally the maintainer does this for you, if you are the maintainer, you
1823 must do this by copying or changing the changed or added text to the other
1824 files so that the translators sees the blue underlined text and know what
1825 they have to translate and what was changed.
1828 \begin_layout Enumerate
1829 You MUST assure that the document is compilable as
1830 \begin_inset Quotes eld
1834 \begin_inset Quotes erd