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 Chapter
952 \begin_layout Standard
953 This chapter lists some guidelines that should be followed.
954 This list is not complete, and many guidelines are in separate chapters,
956 \begin_inset Quotes eld
959 When is an update of the .lyx file format number needed?
960 \begin_inset Quotes erd
964 \begin_inset CommandInset ref
966 reference "sec:When-is-an"
973 \begin_layout Section
974 When to set a fixed milestone?
977 \begin_layout Standard
978 Only set a fixed milestone (like 2.1.4 or 2.2.0) if at least one of the following
982 \begin_layout Enumerate
983 Somebody is actively working on a fix.
986 \begin_layout Enumerate
987 The bug is so severe that it would block the release if it is not fixed.
990 \begin_layout Standard
991 If a bug is important, but nobody is working on it, and it is no showstopper,
992 use a milestone like 2.1.x or 2.2.x.
993 For all other bugs, do not set a milestone at all.
996 \begin_layout Section
997 Can we add rc entries in stable branch?
1000 \begin_layout Standard
1002 We are supposed to increase the prefs2prefs version number with such things.
1005 \begin_layout Chapter
1006 Documentation policies
1009 \begin_layout Standard
1010 The main documentation consists of these files:
1013 \begin_layout Description
1014 splash.lyx it is the first file you see after an installation.
1015 We assume that a new user sees this.
1016 It is therefore designed to be as simple as possible.
1017 Therefore please don't add any new formatting, only fix typos etc.
1018 Splash.lyx is up to date for \SpecialChar LyX
1019 2.1.x, currently maintained by Uwe Stöhr.
1022 \begin_layout Description
1023 Intro.lyx This is the manual new users will read to learn \SpecialChar LyX
1025 It therefore uses a limited set of formatting.
1026 For example a standard document class.
1027 Since new users will first learn about the formatting possibilities of
1029 please keep this file that simple.
1030 Intro.lyx is up to date for \SpecialChar LyX
1031 2.1.x, currently maintained by Uwe Stöhr.
1034 \begin_layout Description
1035 Tutorial.lyx our tutorial.
1036 It must be always up to date.
1037 Normally there is nothing to add since we don't want to overwhelm new users
1038 with too much details.
1039 The will learn these details while using \SpecialChar LyX
1040 and we have special manuals.
1041 Tutorial.lyx is up to date for \SpecialChar LyX
1042 2.1.x, currently maintained by Uwe Stöhr.
1045 \begin_layout Description
1046 UserGuide.lyx our main user guide.
1047 It covers a mixture of basic and detailed information.
1048 Some information is also in the Math and EmbeddedObjects manual so that
1049 the UserGuide refers to these files.
1050 UserGuide.lyx is up to date for \SpecialChar LyX
1051 2.1.x, currently maintained by Uwe Stöhr.
1054 \begin_layout Description
1055 EmbeddedObjects.lyx a special manual to explain things like tables floats
1058 EmbeddedObjects.lyx is up to date for \SpecialChar LyX
1059 2.1.x, currently maintained by Uwe
1063 \begin_layout Description
1064 Math.lyx a special manual to explain everything regarding math in all detail.
1065 Math.lyx is up to date for \SpecialChar LyX
1066 2.1.x, currently maintained by Uwe Stöhr.
1069 \begin_layout Description
1070 Additional.lyx this manual covers information that would be too much detail
1071 for the UserGuide or would make the UserGuide uncompilable or only compilable
1072 when installing a lot of special \SpecialChar LaTeX
1074 What should be in the UserGuide or better in Additional is a matter of
1076 it is up to you to decide that.
1077 Additional.lyx is not completely up to date for \SpecialChar LyX
1080 \begin_inset space ~
1083 8 is up to date and currently maintained by Uwe Stöhr.
1084 It certainly needs a rewrite and update.
1085 For example many info in chapter
1086 \begin_inset space ~
1089 2 and 3 are already covered by the UserGuide and/or the EmbeddedObjects
1093 \begin_layout Description
1094 Customization.lyx this manual covers information how to customize \SpecialChar LyX
1096 output formats, operating systems, languages etc.
1097 It is currently completely out of date and needs a major rewrite and update.
1098 If you do this please assure that your information are given for all OSes
1099 and \SpecialChar LaTeX
1100 distributions (meaning be as objective as possible).
1103 \begin_layout Standard
1105 \begin_inset space ~
1108 rules in editing the docs:
1111 \begin_layout Enumerate
1112 If you are not the maintainer of a doc file or a chapter/section, you MUST
1113 use change tracking so that the maintainer could review your changes
1116 \begin_layout Enumerate
1117 Respect the formatting of the document.
1118 The different files use different formatting styles.
1119 That is OK and has historic reasons nobody fully know ;-).
1120 But it is important to be consistent within one file.
1123 \begin_layout Enumerate
1124 All changes you make to a file in one language MUST also go the file in
1125 the other actively maintained languages.
1126 Normally the maintainer does this for you, if you are the maintainer, you
1127 must do this by copying or changing the changed or added text to the other
1128 files so that the translators sees the blue underlined text and know what
1129 they have to translate and what was changed.
1132 \begin_layout Enumerate
1133 You MUST assure that the document is compilable as
1134 \begin_inset Quotes eld
1138 \begin_inset Quotes erd