1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
5 \origin /systemlyxdir/doc/
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
622 tests can be run by the commands
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
642 subfolder of the build directory.
643 \begin_inset Note Note
646 \begin_layout Plain Layout
647 FIXME: Is this possible with autotools?
655 \begin_layout Section
659 \begin_layout Standard
660 The tex2lyx tests are located in the
661 \begin_inset Flex Code
664 \begin_layout Plain Layout
670 subfolder of the \SpecialChar LyX
671 source code distribution.
672 The actual testing is performed by the simple python script
673 \begin_inset Flex Code
676 \begin_layout Plain Layout
677 src/tex2lyx/test/runtests.py
683 Each test consists of two files:
684 \begin_inset Flex Code
687 \begin_layout Plain Layout
693 contains the \SpecialChar LaTeX
694 code that should be tested.
696 \begin_inset Flex Code
699 \begin_layout Plain Layout
705 contains the expected output of tex2lyx.
706 When a test is run, the actual produced output is compared with the stored
708 The test passes if both are identical.
709 The test machinery is also able to generate a file
710 \begin_inset Flex Code
713 \begin_layout Plain Layout
719 by exporting the produced .lyx file with \SpecialChar LyX
721 This may be useful for roundtrip comparisons.
724 \begin_layout Subsection
728 \begin_layout Standard
729 The tex2lyx tests can be run by the commands
730 \begin_inset Flex Code
733 \begin_layout Plain Layout
740 \begin_inset Flex Code
743 \begin_layout Plain Layout
750 \begin_inset Flex Code
753 \begin_layout Plain Layout
759 subfolder of the build directory.
760 If a test fails, the differences between the expected and actual results
761 are output in unified diff format.
764 \begin_layout Subsection
765 Updating test references
766 \begin_inset CommandInset label
768 name "sec:Updating-test-references"
775 \begin_layout Standard
776 In some cases a changed tex2lyx output is not a test failure, but wanted,
778 \begin_inset space \thinspace{}
782 \begin_inset space \space{}
785 if a tex2lyx bug was fixed, or a new feature was added.
786 In these cases the stored references need to be updated.
787 To do so if using autotools, call
788 \begin_inset Flex Code
791 \begin_layout Plain Layout
798 \begin_inset Flex Code
801 \begin_layout Plain Layout
807 subdirectory of the build directory.
808 If instead using CMake, call
809 \begin_inset Flex Code
812 \begin_layout Plain Layout
813 make updatetex2lyxtests
818 in the build directory or in the
819 \begin_inset Flex Code
822 \begin_layout Plain Layout
828 subdirectory of the build directory
832 \begin_layout Plain Layout
833 Note that this is a case where a make target in the build directory can
834 affect the source directory, which might not be advisable.
840 For convenience, these commands also produce re-exported roundtrip .lyx.tex
842 Please examine the changed output carefully before committing the changed
843 files to the repository: Since the test machinery does not do a roundtrip
845 \begin_inset Formula $\Rightarrow$
849 \begin_inset Formula $\Rightarrow$
852 .tex, and does not compare the produced dvi or pdf output, it assumes that
853 the stored .lyx reference produces correct output if processed by \SpecialChar LyX
855 There is only one chance to detect wrong output: before committing a new
857 Once it is committed, it is quite difficult to verify whether it is correct.
860 \begin_layout Standard
865 update the test references by opening them with \SpecialChar LyX
866 or directly running lyx2lyx
868 This would not work, since lyx2lyx and \SpecialChar LyX
869 produce slightly different files
870 regarding insignificant whitespace and line breaks.
873 \begin_layout Subsection
877 \begin_layout Standard
878 In many cases tests for new features may be added to one of the existing
879 test files, but sometimes this is not possible or not wanted.
880 Then a new test file needs to be added:
883 \begin_layout Enumerate
885 \begin_inset Flex Code
888 \begin_layout Plain Layout
889 src/tex2lyx/test/<test name>.tex
894 and run tex2lyx in roundtrip mode to produce the file
895 \begin_inset Flex Code
898 \begin_layout Plain Layout
899 src/tex2lyx/test/<test name>.lyx.lyx
905 This file will be the new reference.
908 \begin_layout Enumerate
909 Once you confirmed that the tex2lyx output is correct, add the new files
910 to the corresponding lists in
911 \begin_inset Flex Code
914 \begin_layout Plain Layout
915 src/tex2lyx/test/runtests.py
921 \begin_inset Flex Code
924 \begin_layout Plain Layout
925 src/tex2lyx/Makefile.am
931 \begin_inset Flex Code
934 \begin_layout Plain Layout
935 src/tex2lyx/test/CMakeLists.txt
943 \begin_layout Enumerate
944 Commit the changes to the repository, or send a patch to the development
945 list and ask for committing if you do not have commit rights.
948 \begin_layout Section
952 \begin_layout Standard
953 The export tests are integration tests.
954 They take longer to run and are more likely to break than the tex2lyx tests.
955 Nevertheless, they have caught many regressions and without a better alternativ
956 e it is important to keep them up-to-date and understand how they work.
959 \begin_layout Subsection
960 Expectations of LyX developers
963 \begin_layout Standard
964 Because the export tests are integration tests and take a long time to run,
965 LyX developers are rarely expected to run all of the tests.
966 Here are some good practices to follow by developers:
969 \begin_layout Itemize
970 When making a non-trivial change to a .layout file, run the export and layout
971 tests corresponding with that .layout file.
974 \begin_layout Itemize
975 When making non-trivial changes to a .lyx file, run the export tests correspondin
979 \begin_layout Itemize
980 When making non-trivial changes to LyX's LaTeX export code (e.g.
981 touching the encoding code or package handling code that you expect will
982 change the exported LaTeX in some way), consider running all of the export
983 tests before and after your change.
984 If there are differences, please reconcile these (i.e.
985 fix the bug or fix the tests)
990 Ask for help if you're not sure what to do or if you do not want to run
991 the tests, post the patch on the list and others will run the tests.
994 \begin_layout Itemize
995 Understand how to interpret test failures.
996 If your commit is found to have broken a test, you should be able to interpret
997 the test results when made aware of them.
999 \begin_inset CommandInset ref
1001 reference "subsec:Interpreting-export-tests"
1008 \begin_layout Subsection
1009 Configuring the tests
1012 \begin_layout Standard
1013 To enable these tests when using CMake, add the
1014 \begin_inset Flex Code
1017 \begin_layout Plain Layout
1018 -DLYX_ENABLE_EXPORT_TESTS=ON
1027 \begin_layout Standard
1028 \begin_inset Flex Code
1031 \begin_layout Plain Layout
1032 cmake -DLYX_ENABLE_EXPORT_TESTS=ON /path/to/source
1040 \begin_layout Standard
1042 This flag will increase the time for the cmake command by several seconds,
1043 mainly because of the process of inverting tests (see Section
1044 \begin_inset CommandInset ref
1046 reference "subsec:Interpreting-export-tests"
1053 \begin_layout Subsection
1057 \begin_layout Standard
1058 To run all of the export tests, in the build directory simply run the command
1060 \begin_inset Flex Code
1063 \begin_layout Plain Layout
1070 To run only some of the tests, use the command
1071 \begin_inset Flex Code
1074 \begin_layout Plain Layout
1081 \begin_inset Flex Code
1084 \begin_layout Plain Layout
1090 is a regular expression that matches test names.
1091 It is often useful to list the tests without running them (e.g.
1092 if you want to know how many tests there are or whether your
1093 \begin_inset Flex Code
1096 \begin_layout Plain Layout
1102 regular expression did what you expected).
1103 This can be done with the
1104 \begin_inset Flex Code
1107 \begin_layout Plain Layout
1114 \begin_inset Flex Code
1117 \begin_layout Plain Layout
1124 We are still working on getting the tests to run in parallel which is supported
1126 \begin_inset Flex Code
1129 \begin_layout Plain Layout
1136 \begin_inset Flex Code
1139 \begin_layout Plain Layout
1146 \begin_inset Flex Code
1149 \begin_layout Plain Layout
1156 However, when running the tests in parallel, sometimes tests fail that
1157 pass when run sequentially.
1158 A reasonable approach is to first run the tests in parallel and then run
1159 the failed tests sequentially.
1160 For example, to run 8 jobs at a time:
1163 \begin_layout Standard
1164 \begin_inset Flex Code
1167 \begin_layout Plain Layout
1176 \begin_layout Standard
1177 \begin_inset Flex Code
1180 \begin_layout Plain Layout
1185 \begin_layout Plain Layout
1200 \begin_layout Standard
1202 Note that some tests cannot be run in parallel.
1203 These tests are marked in the code with the
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1217 \begin_layout Standard
1218 In some situations the option
1219 \begin_inset Flex Code
1222 \begin_layout Plain Layout
1229 There have been bugs in LyX and in LaTeX which cause compilation to hang,
1230 and without a timeout a test might never stop (in one case there was even
1232 If a test times out, the
1233 \begin_inset Flex Code
1236 \begin_layout Plain Layout
1242 command exits with error, but you can distinguish between a timed out test
1243 and a failed test in the output reported at the end of the
1244 \begin_inset Flex Code
1247 \begin_layout Plain Layout
1256 \begin_layout Subsection
1257 \begin_inset CommandInset label
1259 name "subsec:Interpreting-export-tests"
1263 Interpreting the export test results
1266 \begin_layout Standard
1267 A test can fail for several reasons, not all of them bad.
1270 \begin_layout Itemize
1271 The .lyx file could have been added recently and some formats are not expected
1275 \begin_layout Itemize
1276 A dependency is not met (e.g.
1277 the LaTeX class file).
1278 One hint that this is the case is that the corresponding
1279 \begin_inset Flex Code
1282 \begin_layout Plain Layout
1288 test will likely also fail.
1291 \begin_layout Itemize
1292 An export that previously failed to compile now compiles.
1295 \begin_layout Itemize
1296 An external dependency was updated (e.g.
1300 \begin_layout Itemize
1301 A recent code change introduced a bug.
1304 \begin_layout Standard
1305 Because the .lyx files are exported in several formats, it is not surprising
1306 that many of the exports fail.
1307 This expectation of failure is addressed by
1308 \begin_inset Quotes eld
1312 \begin_inset Quotes erd
1315 the tests, that is, by marking the test as
1316 \begin_inset Quotes eld
1320 \begin_inset Quotes erd
1323 if the export exits with error and as
1324 \begin_inset Quotes eld
1328 \begin_inset Quotes erd
1331 if the export succeeds
1336 It follows that these expected failures will not show up as failed tests
1337 in the test results and thus will not pollute the
1338 \begin_inset Quotes eld
1342 \begin_inset Quotes erd
1346 If the export actually succeeds, then the test will fail.
1347 The purpose of this failure is to get your attentions—something has changed,
1348 possibly for the better.
1351 \begin_layout Standard
1352 We try to document why a test is inverted or ignored.
1353 See the comment (prefixed with
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1363 ) above the block in which the test is listed as inverted or ignored in
1365 \begin_inset Flex Code
1368 \begin_layout Plain Layout
1369 development/autotests/revertedTests
1375 \begin_inset Flex Code
1378 \begin_layout Plain Layout
1379 development/autotests/ignoredTests
1387 \begin_layout Standard
1388 What action should you take if a test fails? First, check manually that
1389 when the compilation succeeded before the resulting PDF was good.
1390 In fact, sometimes it is an improvement when a test fails.
1391 If you check manually, it might be the case that the export was succeeding
1392 before but showing garbled text in a PDF output.
1393 Now it might fail with a clear message of "language xyz not supported".
1394 It is always good to check manually why something fails and if it passes
1395 if the PDF output is good.
1398 \begin_layout Standard
1399 Sometimes a test is fixed by accident.
1400 We should uninvert a test (remove it from the
1401 \begin_inset Flex Code
1404 \begin_layout Plain Layout
1410 file) in order to preserve the fix.
1413 \begin_layout Standard
1414 When a test or several tests fail, consider checking the files in the
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1424 subdirectory of your build directory.
1425 In this subdirectory are three files: the file
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1435 simply lists the tests that failed on your last
1436 \begin_inset Flex Code
1439 \begin_layout Plain Layout
1446 \begin_inset Flex Code
1449 \begin_layout Plain Layout
1455 file contains the output from the tests (and often has details explaining
1456 why a test failed); and the
1457 \begin_inset Flex Code
1460 \begin_layout Plain Layout
1466 file lists the times that it took to run the tests.
1469 \begin_layout Section
1473 \begin_layout Standard
1474 These tests check whether a .lyx file loads without any terminal messages.
1475 They correspond to the manual operations of simply opening a .lyx file on
1476 the terminal, exiting LyX once the file is loaded, and then checking whether
1477 there is any output from the terminal.
1478 These tests are useful for catching malformed .lyx files and parsing bugs.
1479 They can also be used to find a .lyx file in which an instance of something
1481 To do this, compile LyX with a local patch that outputs something to the
1482 terminal when an instance is found, and then run the check_load tests to
1483 see if any fail, which would mean that the situation occurs in the LyX
1484 documentation files corresponding to the failed tests.
1485 These tests are expectedly fragile: any LyX diagnostic message, which is
1486 not necessarily an error, would cause the tests to fail.
1487 Similarly, any message output by a library (e.g.
1488 Qt) would also cause failure.
1489 There are some messages that the check_load tests are instructed to ignore,
1490 which are stored in the file
1491 \begin_inset Flex Code
1494 \begin_layout Plain Layout
1495 development/autotests/filterCheckWarnings
1503 \begin_layout Section
1507 \begin_layout Standard
1508 These tests are extremely fragile and a failed URL test should not be taken
1510 They are useful for finding broken links in our documentation files.
1511 These must be enabled at configure.
1514 \begin_layout Chapter
1515 Development policies
1518 \begin_layout Standard
1519 This chapter lists some guidelines that should be followed.
1520 This list is not complete, and many guidelines are in separate chapters,
1522 \begin_inset Quotes eld
1525 When is an update of the .lyx file format number needed?
1526 \begin_inset Quotes erd
1530 \begin_inset CommandInset ref
1532 reference "sec:When-is-an"
1539 \begin_layout Section
1540 When to set a fixed milestone?
1543 \begin_layout Standard
1544 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
1548 \begin_layout Enumerate
1549 Somebody is actively working on a fix.
1552 \begin_layout Enumerate
1553 The bug is so severe that it would block the release if it is not fixed.
1556 \begin_layout Standard
1557 If a bug is important, but nobody is working on it, and it is no showstopper,
1558 use a milestone like 2.1.x or 2.2.x.
1559 For all other bugs, do not set a milestone at all.
1562 \begin_layout Section
1563 Can we add rc entries in stable branch?
1566 \begin_layout Standard
1568 We are supposed to increase the prefs2prefs version number with such things.
1571 \begin_layout Chapter
1572 Documentation policies
1575 \begin_layout Standard
1576 The main documentation consists of these files:
1579 \begin_layout Description
1580 splash.lyx it is the first file you see after an installation.
1581 We assume that a new user sees this.
1582 It is therefore designed to be as simple as possible.
1583 Therefore please don't add any new formatting, only fix typos etc.
1584 Splash.lyx is up to date for \SpecialChar LyX
1585 2.1.x, currently maintained by Uwe Stöhr.
1588 \begin_layout Description
1589 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
1591 It therefore uses a limited set of formatting.
1592 For example a standard document class.
1593 Since new users will first learn about the formatting possibilities of
1595 please keep this file that simple.
1596 Intro.lyx is up to date for \SpecialChar LyX
1597 2.1.x, currently maintained by Uwe Stöhr.
1600 \begin_layout Description
1601 Tutorial.lyx our tutorial.
1602 It must be always up to date.
1603 Normally there is nothing to add since we don't want to overwhelm new users
1604 with too much details.
1605 The will learn these details while using \SpecialChar LyX
1606 and we have special manuals.
1607 Tutorial.lyx is up to date for \SpecialChar LyX
1608 2.1.x, currently maintained by Uwe Stöhr.
1611 \begin_layout Description
1612 UserGuide.lyx our main user guide.
1613 It covers a mixture of basic and detailed information.
1614 Some information is also in the Math and EmbeddedObjects manual so that
1615 the UserGuide refers to these files.
1616 UserGuide.lyx is up to date for \SpecialChar LyX
1617 2.1.x, currently maintained by Uwe Stöhr.
1620 \begin_layout Description
1621 EmbeddedObjects.lyx a special manual to explain things like tables floats
1624 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
1625 2.1.x, currently maintained by Uwe
1629 \begin_layout Description
1630 Math.lyx a special manual to explain everything regarding math in all detail.
1631 Math.lyx is up to date for \SpecialChar LyX
1632 2.1.x, currently maintained by Uwe Stöhr.
1635 \begin_layout Description
1636 Additional.lyx this manual covers information that would be too much detail
1637 for the UserGuide or would make the UserGuide uncompilable or only compilable
1638 when installing a lot of special \SpecialChar LaTeX
1640 What should be in the UserGuide or better in Additional is a matter of
1642 it is up to you to decide that.
1643 Additional.lyx is not completely up to date for \SpecialChar LyX
1646 \begin_inset space ~
1649 8 is up to date and currently maintained by Uwe Stöhr.
1650 It certainly needs a rewrite and update.
1651 For example many info in chapter
1652 \begin_inset space ~
1655 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
1659 \begin_layout Description
1660 Customization.lyx this manual covers information how to customize \SpecialChar LyX
1662 output formats, operating systems, languages etc.
1663 It is currently completely out of date and needs a major rewrite and update.
1664 If you do this please assure that your information are given for all OSes
1665 and \SpecialChar LaTeX
1666 distributions (meaning be as objective as possible).
1669 \begin_layout Standard
1671 \begin_inset space ~
1674 rules in editing the docs:
1677 \begin_layout Enumerate
1678 If you are not the maintainer of a doc file or a chapter/section, you MUST
1679 use change tracking so that the maintainer could review your changes
1682 \begin_layout Enumerate
1683 Respect the formatting of the document.
1684 The different files use different formatting styles.
1685 That is OK and has historic reasons nobody fully know ;-).
1686 But it is important to be consistent within one file.
1689 \begin_layout Enumerate
1690 All changes you make to a file in one language MUST also go the file in
1691 the other actively maintained languages.
1692 Normally the maintainer does this for you, if you are the maintainer, you
1693 must do this by copying or changing the changed or added text to the other
1694 files so that the translators sees the blue underlined text and know what
1695 they have to translate and what was changed.
1698 \begin_layout Enumerate
1699 You MUST assure that the document is compilable as
1700 \begin_inset Quotes eld
1704 \begin_inset Quotes erd