1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @node Documentation work
3 @chapter Documentation work
5 There are currently 11 manuals for LilyPond, not including the
6 translations. Each book is available in HTML, PDF, and info. The
7 documentation is written in a language called @code{texinfo} --
8 this allows us to generate different output formats from a single
11 To organize multiple authors working on the documentation, we use a
12 Version Control System (VCS) called git, previously discussed in
13 @ref{Starting with Git}.
16 * Introduction to documentation work::
17 * Documentation suggestions::
18 * Texinfo introduction and usage policy::
19 * Documentation policy::
20 * Tips for writing docs::
21 * Scripts to ease doc work::
22 * Docstrings in scheme::
23 * Translating the documentation::
27 @node Introduction to documentation work
28 @section Introduction to documentation work
30 Our documentation tries to adhere to our @ref{Documentation
31 policy}. This policy contains a few items which may seem odd.
32 One policy in particular is often questioned by potential
33 contributors: we do not repeat material in the Notation Reference,
34 and instead provide links to the @qq{definitive} presentation of
35 that information. Some people point out, with good reason, that
36 this makes the documentation harder to read. If we repeated
37 certain information in relevant places, readers would be less
38 likely to miss that information.
40 That reasoning is sound, but we have two counter-arguments.
41 First, the Notation Reference -- one of @emph{five} manuals for
42 users to read -- is already over 500 pages long. If we repeated
43 material, we could easily exceed 1000 pages! Second, and much
44 more importantly, LilyPond is an evolving project. New features
45 are added, bugs are fixed, and bugs are discovered and documented.
46 If features are discussed in multiple places, the documentation
47 team must find every instance. Since the manual is so large, it
48 is impossible for one person to have the location of every piece
49 of information memorized, so any attempt to update the
50 documentation will invariably omit a few places. This second
51 concern is not at all theoretical; the documentation used to be
52 plagued with inconsistent information.
54 If the documentation were targeted for a specific version -- say,
55 LilyPond 2.10.5 -- and we had unlimited resources to spend on
56 documentation, then we could avoid this second problem. But since
57 LilyPond evolves (and that is a very good thing!), and since we
58 have quite limited resources, this policy remains in place.
60 A few other policies (such as not permitting the use of tweaks in
61 the main portion of NR 1+2) may also seem counter-intuitive, but
62 they also stem from attempting to find the most effective use of
63 limited documentation help.
66 @node Documentation suggestions
67 @section Documentation suggestions
69 @subheading Small additions
71 For additions to the documentation,
76 Tell us where the addition should be placed. Please include both
77 the section number and title (i.e. "LM 2.13 Printing lyrics").
80 Please write exact changes to the text.
83 A formal patch to the source code is @emph{not} required; we can
84 take care of the technical details. Here is an example of a
85 perfect documentation report:
88 To: lilypond-devel@gnu.org
89 From: helpful-user@example.net
92 In LM 2.13 (printing lyrics), above the last line ("More options,
93 like..."), please add:
96 To add lyrics to a divided part, use blah blah blah. For example,
99 \notes {blah <<blah>> }
100 \lyrics {blah <<blah>> }
105 In addition, the second sentence of the first paragraph is
106 confusing. Please delete that sentence (it begins "Users
107 often...") and replace it with this:
109 To align lyrics with something, do this thing.
119 @subheading Larger contributions
121 To replace large sections of the documentation, the guidelines are
122 stricter. We cannot remove parts of the current documentation
123 unless we are certain that the new version is an improvement.
128 Ask on the lilypond-devel maillist if such a rewrite is necessary;
129 somebody else might already be working on this issue!
132 Split your work into small sections; this makes it much easier to
133 compare the new and old documentation.
136 Please prepare a formal git patch.
140 Once you have followed these guidelines, please send a message to
141 lilypond-devel with your documentation submissions. Unfortunately
142 there is a strict “no top-posting” check on the mailist; to avoid
145 > I'm not top posting.
147 (you must include the > ) to the top of your documentation
150 We may edit your suggestion for spelling, grammar, or style, and
151 we may not place the material exactly where you suggested, but if
152 you give us some material to work with, we can improve the manual
153 much faster. Thanks for your interest!
156 @node Texinfo introduction and usage policy
157 @section Texinfo introduction and usage policy
160 * Texinfo introduction::
161 * Documentation files::
162 * Sectioning commands::
163 * LilyPond formatting::
166 * Other text concerns::
170 @node Texinfo introduction
171 @subsection Texinfo introduction
173 The language is called Texinfo; you can see its manual here:
175 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
177 However, you don't need to read those docs. The most important
178 thing to notice is that text is text. If you see a mistake in the
179 text, you can fix it. If you want to change the order of
180 something, you can cut-and-paste that stuff into a new location.
182 @warning{Rule of thumb: follow the examples in the existing docs.
183 You can learn most of what you need to know from this; if you want
184 to do anything fancy, discuss it on @code{lilypond-devel} first.}
187 @node Documentation files
188 @subsection Documentation files
190 All manuals live in @file{Documentation/}.
192 In particular, there are four user manuals, their respective master
193 source files are @file{learning.tely} (LM, Learning Manual),
194 @file{notation.tely} (NR, Notation Reference),
195 @file{music-glossary.tely} (MG, Music Glossary), and
196 @file{lilypond-program} (AU). Each chapter is written in a separate
197 file, ending in @file{.itely} for files containing lilypond code, and
198 @file{.itexi} for files without lilypond code, located in a subdirectory
199 associated to the manual (@file{learning/} for @file{learning.tely}, and
200 so on); list the subdirectory of each manual to determine the filename
201 of the specific chapter you wish to modify.
203 Developer manuals live in @file{Documentation/} too. Currently there is
204 only one: the Contributor's Guide @file{contrib-guide.texi} you are
207 Snippet files are part of documentation, and the Snippet List (SL) lives
208 in @file{Documentation/} just like the manuals. For information about
209 how to modify the snippet files and SL, see @ref{LSR work}.
212 @node Sectioning commands
213 @subsection Sectioning commands
215 Most of the manual operates at the
223 level. Sections are created with
232 Please leave two blank lines above a @@node; this makes it
233 easier to find sections in texinfo.
236 If a heading is desired without creating a node, please use
244 Sectioning commands (@@node and @@section) must not appear
245 inside an @@ignore. Separate those commands with a space, ie
250 Nodes must be included inside a
260 construct. These are easily constructed with automatic tools; see
261 @ref{Scripts to ease doc work}.
264 @node LilyPond formatting
265 @subsection LilyPond formatting
270 Use two spaces for indentation in lilypond examples. (no
274 All text strings should be prefaced with #. LilyPond does
275 not strictly require this, but it is helpful to get users
276 accustomed to this scheme construct. ie @code{\set
277 Staff.instrumentName = #"cello"}
280 All engravers should have double-quotes around them:
283 \consists "Spans_arpeggio_engraver"
286 Again, LilyPond does not strictly require this, but it is a useful
290 If possible, only write one bar per line.
293 If you only have one bar per line, omit bar checks. If you
294 must put more than one bar per line (not recommended), then include bar
298 Tweaks should, if possible, also occur on their own line.
302 \override textscript #'padding = #3 c1^"hi"
308 \override textscript #'padding = #3
313 Most LilyPond input should be produced with:
316 @@lilypond[verbatim,quote,relative=2]
323 @@lilypond[verbatim,quote,relative=1]
326 If you want to use \layout@{@} or define variables, use
329 @@lilypond[verbatim,quote]
332 In rare cases, other options may be used (or omitted), but ask first.
335 Inspirational headwords are produced with
338 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
339 @{pitches-headword.ly@}
343 LSR snippets are linked with
346 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
351 excepted in Templates, where `doctitle' may be omitted.
354 Avoid long stretches of input code. Nobody is going to read
355 them in print. Create small examples. However, this does not mean
359 Specify durations for at least the first note of every bar.
362 If possible, end with a complete bar.
365 Comments should go on their own line, and be placed before
366 the line(s) to which they refer.
369 Add extra spaces around @{ @} marks; ie
372 not: \chordmode @{c e g@}
373 but instead: \chordmode @{ c e g @}
377 If you want to work on an example outside of the manual (for
378 easier/faster processing), use this header:
383 line-width = 160\mm - 2.0 * 0.4\in
385 force-assignment = #""
386 line-width = #(- line-width (* mm 3.000000))
393 You may not change any of these values. If you are making an
394 example demonstrating special \paper@{@} values, contact the
395 Documentation Editor.
400 @node Text formatting
401 @subsection Text formatting
406 Lines should be less than 72 characters long. (We personally
407 recommend writing with 66-char lines, but do not bother modifying
408 existing material). However, see the note below regarding line
409 lengths within @code{@@example} blocks.
412 Individual lines within an @code{@@example} block should not
413 exceed 74 characters; otherwise they will run into the margin in
414 the pdf output, and may get clipped. If an @code{@@example} block
415 is part of an @code{@@item} within an @code{@@itemize} or
416 @code{@@enumerate} block, each line of the @code{@@example} should
417 not exceed 70 columns---each additional level of @code{@@itemize}
418 or @code{@@enumerate} shortens the line by about 4 columns.
420 For command line examples, if possible, use a trailing backslash
421 to break up a single line, indenting the next line with 2 spaces.
422 If this isn't feasible, use @code{@@smallexample ...
423 @@end@tie{}smallexample} instead, which uses a smaller fontsize.
424 Use @code{@@example} whenever possible, but if needed,
425 @code{@@smallexample} can fit up to 96 characters per line before
426 running into the pdf margin. Each additional level of
427 @code{@@itemize} or @code{@@enumerate} shortens a
428 @code{@@smallexample} line by about 5 columns.
434 Do not use spaces at the beginning of a line (except in
435 @code{@@example} or @code{@@verbatim} environments), and do not
436 use more than a single space between words. @q{makeinfo} copies
437 the input lines verbatim without removing those spaces.
440 Use two spaces after a period.
443 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
447 Don't use @code{@@rinternals@{@}} in the main text. If you're
448 tempted to do so, you're probably getting too close to @qq{talking
449 through the code}. If you really want to refer to a context, use
450 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
451 the @code{@@seealso}.
454 Variables or numbers which consist of a single character (probably
455 followed by a punctuation mark) should be tied properly, either to
456 the previous or the next word. Example:
459 The variable@@tie@{@}@@var@{a@} ...
463 To get consistent indentation in the DVI output it is better to
464 avoid the @code{@@verbatim} environment. Use the @code{@@example}
465 environment instead if possible, but without extraneous
466 indentation. For example, this
477 should be replaced with
488 where @q{@code{@@example}} starts the line (without leading
492 Do not compress the input vertically; that is, do not use
495 Beginning of logical unit
499 continuation of logical unit
506 Beginning of logical unit
513 continuation of logical unit
516 This makes it easier to remember the @q{@code{@@noindent}}. Only
517 use @code{@@noindent} if the material is discussing the same
518 material; new material should simply begin without anything
519 special on the line above it.
522 in @code{@@itemize} and @code{@@enumerate} blocks, use
523 @code{@@item} on a separate line like this:
534 Do not use @code{@@itemize@tie{}@@bullet}.
537 To get LilyPond version, use @code{@@version@{@}} (this does not
538 work inside LilyPond snippets). If you write
539 @code{"@@version@{@}"} (enclosed with quotes), or generally if
540 @code{@@version@{@}} is not followed by a space, there will be an
541 ugly line break in PDF output unless you enclose it with
548 @@w@{"@@version@{@}"@}
555 @subsection Syntax survey
559 @code{@@bs} --- Generates a backslash inside @code{@@warning}.
560 Any @q{@bs{}} used inside @code{@@warning} (and @code{@@q} or
561 @code{@@qq}) must be written as @q{@code{@@bs@{@}}} (texinfo would
562 also allow @q{@bs{}@bs{}}, but this breaks with PDF output).
565 @code{@@c} --- single line comments. @qq{@code{@@c NOTE:}} is a
566 comment which should remain in the final version. (gp only
570 @code{@@cindex} --- General index. Please add as many as you can.
571 Don't capitalize the first word.
574 @code{@@code@{@}} --- typeset in a tt-font. Use for actual
575 LilyPond code or property/context names. If the name contains a
576 space, wrap the entire thing inside @code{@@w@{@@code@{ @}@}}.
579 @code{@@example ... @@end example} --- example text that should be
580 set as a blockquote. Any @code{@{@tie{}@}} must be escaped with
581 @code{@@@{@tie{}@@@}}.
584 @code{@@funindex} --- is for a \lilycommand.
587 @code{@@ignore ... @@end ignore} --- multi-line comment
590 @code{@@itemize @@item A @@item B ... @@end itemize} --- for
591 bulleted lists. Do not compress vertically like this.
594 @code{@@notation@{@}} --- refers to pieces of notation, e.g.
595 @qq{@code{@@notation@{clef}.@}}. Also use for specific lyrics
596 (@qq{the @code{@@notation@{}A@tie{}-@tie{}men@} is centered}).
597 Only use once per subsection per term.
600 @code{@@q@{@}} --- Single quotes. Used for @q{vague} terms.
603 @code{@@qq@{@}} --- Double quotes. Used for actual quotes (@qq{he
604 said}) or for introducing special input modes.
607 @code{@@rchanges@{@}} --- link to Changes.
610 @code{@@rcontrib@{@}} --- link to Contributor's Guide.
613 @code{@@ref@{@}} --- link within current manual (type the exact
614 node name inside the @code{@{@}}).
617 @code{@@ressay@{@}} --- link to Engraving Essay.
620 @code{@@rextend@{@}} --- link to Extending LilyPond.
623 @code{@@rglos@{@}} --- link to the Music Glossary.
626 @code{@@rinternals@{@}} --- link to the Internals Reference.
629 @code{@@rlearning@{@}} --- link to Learning Manual.
632 @code{@@rlsr@{@}} --- link to a Snippet section.
635 @code{@@rprogram@{@}} --- link to Application Usage.
638 @code{@@ruser@{@}} --- link to Notation Reference.
641 @code{@@rweb@{@}} --- link to General Informaion.
644 @code{@@tie@{@}} --- Variables or numbers which consist of a
645 single character (probably followed by a punctuation mark) should
646 be tied properly, either to the previous or the next word.
647 Example: @q{@code{The letter@@tie@{@}@@q@{I@} is skipped}}
650 @code{@@uref@{@}} --- link to an external url.
653 @code{@@var} --- Use for variables.
656 @code{@@version@{@}} --- Return the current LilyPond version
660 @code{@@warning@{@}} --- produces a @qq{Note:@tie{}} box. Use for
667 @node Other text concerns
668 @subsection Other text concerns
673 References must occur at the end of a sentence, for more
674 information see @@ref@{the texinfo manual@}. Ideally this should
675 also be the final sentence of a paragraph, but this is not
676 required. Any link in a doc section must be duplicated in the
677 @@seealso section at the bottom.
680 Introducing examples must be done with
683 . (ie finish the previous sentence/paragaph)
684 : (ie `in this example:')
685 , (ie `may add foo with the blah construct,')
688 The old @qq{sentence runs directly into the example} method is not
692 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
703 When beginning a quote: "So, he said,...".
705 This usage is rarer. Americans often just use a comma.
708 When adding a defining example at the end of a sentence.
713 Non-ASCII characters which are in utf-8 should be directly used;
714 this is, don't say @q{Ba@@ss@{@}tuba} but @q{Baßtuba}. This ensures
715 that all such characters appear in all output formats.
722 @node Documentation policy
723 @section Documentation policy
727 * Section organization::
728 * Checking cross-references::
730 * Technical writing style::
736 There are four parts to the documentation: the Learning Manual,
737 the Notation Reference, the Program Reference, and the Music
745 The LM is written in a tutorial style which introduces the most
746 important concepts, structure and syntax of the elements of a
747 LilyPond score in a carefully graded sequence of steps.
748 Explanations of all musical concepts used in the Manual can be
749 found in the Music Glossary, and readers are assumed to have no
750 prior knowledge of LilyPond. The objective is to take readers to
751 a level where the Notation Reference can be understood and
752 employed to both adapt the templates in the Appendix to their
753 needs and to begin to construct their own scores. Commonly used
754 tweaks are introduced and explained. Examples are provided
755 throughout which, while being focussed on the topic being
756 introduced, are long enough to seem real in order to retain the
757 readers' interest. Each example builds on the previous material,
758 and comments are used liberally. Every new aspect is thoroughly
759 explained before it is used.
761 Users are encouraged to read the complete Learning Manual from
766 Notation Reference: a (hopefully complete) description of LilyPond
767 input notation. Some material from here may be duplicated in the
768 Learning Manual (for teaching), but consider the NR to be the
769 "definitive" description of each notation element, with the LM
770 being an "extra". The goal is _not_ to provide a step-by-step
771 learning environment -- do not avoid using notation that has not
772 be introduced previously in the NR (for example, use \break if
773 appropriate). This section is written in formal technical writing
776 Avoid duplication. Although users are not expected to read this
777 manual from start to finish, they should be familiar with the
778 material in the Learning Manual (particularly ``Fundamental
779 Concepts''), so do not repeat that material in each section of
780 this book. Also watch out for common constructs, like ^ - _ for
781 directions -- those are explained in NR 3. In NR 1, you can
782 write: DYNAMICS may be manually placed above or below the staff,
783 see @@ref@{Controlling direction and placement@}.
785 Most tweaks should be added to LSR and not placed directly in the
786 .itely file. In some cases, tweaks may be placed in the main
787 text, but ask about this first.
789 Finally, you should assume that users know what the notation
790 means; explaining musical concepts happens in the Music Glossary.
794 Application Usage: information about using the program lilypond
795 with other programs (lilypond-book, operating systems, GUIs,
796 convert-ly, etc). This section is written in formal technical
799 Users are not expected to read this manual from start to finish.
803 Music Glossary: information about the music notation itself.
804 Explanations and translations about notation terms go here.
806 Users are not expected to read this manual from start to finish.
809 Internals Reference: not really a documentation book, since it is
810 automagically generated from the source, but this is its name.
815 @node Section organization
816 @subsection Section organization
821 The order of headings inside documentation sections should
834 You @emph{must} include a @@seealso.
838 The order of items inside the @@seealso section is
847 @@rlearning@{foozle@}.
860 @@file@{path/to/dir/blahz@}.
862 Snippets: @@rlsr@{section@}.
865 @@rinternals@{fazzle@},
866 @@rinternals@{booar@}.
870 If there are multiple entries, separate them by commas but do not
874 Always end with a period.
877 Place each link on a new line as above; this makes it much easier
878 to add or remove links. In the output, they appear on a single
881 ("Snippets" is REQUIRED; the others are optional)
884 Any new concepts or links which require an explanation should go
885 as a full sentence(s) in the main text.
888 Don't insert an empty line between @@seealso and the first entry!
889 Otherwise there is excessive vertical space in the PDF output.
894 To create links, use @@ref@{@} if the link is within the same
898 @@predefined ... @@endpredefined is for commands in
902 Do not include any real info in second-level sections (ie 1.1
903 Pitches). A first-level section may have introductory material,
904 but other than that all material goes into third-level sections
905 (ie 1.1.1 Writing Pitches).
910 @node Checking cross-references
911 @subsection Checking cross-references
913 Cross-references between different manuals are heavily used in the
914 documentation, but they are not checked during compilation.
915 However, if you compile the documentation, a script called
916 check_texi_refs can help you with checking and fixing these
917 cross-references; for information on usage, cd into a source tree
918 where documentation has been built, cd into Documentation and run:
925 Note that you have to find yourself the source files to fix
926 cross-references in the generated documentation such as the
927 Internals Reference; e.g. you can grep scm/ and lily/.
929 @c temporary? how long will kainhofer be used? -gp
930 Also of interest may be the linkdoc checks on kainhofer.com. Be
931 warned that these docs are not completely rebuilt every day, so it
932 might not accurately reflect the current state of the docs.
935 @uref{http://kainhofer.com/~lilypond/linkdoc/}
939 @node General writing
940 @subsection General writing
945 Do not forget to create @@cindex entries for new sections of text.
946 Enter commands with @@funindex, i.e.
949 @@cindex pitches, writing in different octaves
954 do not bother with the @@code@{@} (they are added automatically).
955 These items are added to both the command index and the unified
958 Both index commands should go in front of the actual material.
960 @@cindex entries should not be capitalized, ie
963 @@cindex time signature
967 is preferred instead of @qq{Time signature}, Only use capital
968 letters for musical terms which demand them, like D.S. al Fine.
970 For scheme functions, only include the final part, i.e.,
973 @@funindex modern-voice-cautionary
975 @@funindex #(set-accidental-style modern-voice-cautionary)
984 In general, use the American spellings. The internal lilypond
985 property names use this spelling.
988 List of specific terms:
992 simultaneous NOT concurrent
993 measure: the unit of music
994 bar line: the symbol delimiting a measure NOT barline
995 note head NOT notehead
996 chord construct NOT chord (when referring to <>)
1004 @node Technical writing style
1005 @subsection Technical writing style
1007 These refer to the NR. The LM uses a more gentle, colloquial
1013 Do not refer to LilyPond in the text. The reader knows what the
1014 manual is about. If you do, capitalization is LilyPond.
1017 If you explicitly refer to @q{lilypond} the program (or any other
1018 command to be executed), write @code{@@command@{lilypond@}}.
1021 Do not explicitly refer to the reader/user. There is no one else
1022 besides the reader and the writer.
1025 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1028 Avoid abbreviations, except for commonly used abbreviations of foreign
1029 language terms such as etc. and i.e.
1032 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1036 The use of the word @q{illegal} is inappropriate in most cases.
1037 Say @q{invalid} instead.
1042 @node Tips for writing docs
1043 @section Tips for writing docs
1045 In the NR, I highly recommend focusing on one subsection at a
1046 time. For each subsection,
1051 check the mundane formatting. Are the headings (@@predefined,
1052 @@seealso, etc.) in the right order?
1055 add any appropriate index entries.
1058 check the links in the @@seealso section -- links to music
1059 glossary, internal references, and other NR sections are the main
1060 concern. Check for potential additions.
1063 move LSR-worthy material into LSR. Add the snippet, delete the
1064 material from the .itely file, and add a @@lilypondfile command.
1067 check the examples and descriptions. Do they still work?
1068 @strong{Do not} assume that the existing text is
1069 accurate/complete; some of the manual is highly out of date.
1072 is the material in the @@knownissues still accurate?
1075 can the examples be improved (made more explanatory), or is there
1076 any missing info? (feel free to ask specific questions on -user;
1077 a couple of people claimed to be interesting in being
1078 @qq{consultants} who would help with such questions)
1082 In general, I favor short text explanations with good examples --
1083 @qq{an example is worth a thousand words}. When I worked on the
1084 docs, I spent about half my time just working on those tiny
1085 lilypond examples. Making easily-understandable examples is much
1086 harder than it looks.
1089 @subsubheading Tweaks
1091 In general, any \set or \override commands should go in the
1092 @qq{select snippets} section, which means that they should go in
1093 LSR and not the .itely file. For some cases, the command
1094 obviously belongs in the @qq{main text} (i.e. not inside
1095 @@predefined or @@seealso or whatever) -- instrument names are a
1096 good example of this.
1099 \set Staff.instrumentName = #"foo"
1102 On the other side of this,
1105 \override Score.Hairpin #'after-line-breaking = ##t
1108 clearly belongs in LSR.
1110 I'm quite willing to discuss specific cases if you think that a
1111 tweaks needs to be in the main text. But items that can go into
1112 LSR are easier to maintain, so I'd like to move as much as
1113 possible into there.
1116 It would be @qq{nice} if you spent a lot of time crafting nice
1117 tweaks for users@dots{} but my recommendation is @strong{not} to do
1118 this. There's a lot of doc work to do without adding examples of
1119 tweaks. Tweak examples can easily be added by normal users by adding
1122 One place where a documentation writer can profitably spend time writing
1123 or upgrading tweaks is creating tweaks to deal with known issues. It
1124 would be ideal if every significant known issue had a workaround to avoid
1128 @ref{Adding and editing snippets}.
1131 @node Scripts to ease doc work
1132 @section Scripts to ease doc work
1134 @subheading Stripping whitespace
1136 @c TODO: should this be documented elsewhere? It's useful for
1137 @c more than just docs.
1138 To remove extra whitespace from the ends of lines, run
1141 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1145 @subheading Sectioning commands
1147 @warning{These commands add whitespace.}
1149 The emacs @code{M-x texinfo-all-menus-update} command will
1150 regenerate @@menu blocks. This can also be run with this
1151 command-line script:
1155 emacs $1 -batch -f texinfo-all-menus-update -f save-buffer
1159 (save the above as something like @command{texinfo-menus.sh}, make
1160 it executable, then run @command{texinfo-menus.sh foo.itely})
1163 @subheading Updating doc with @command{convert-ly}
1165 cd into @file{Documentation/} and run
1168 find . -name '*.itely' | xargs convert-ly -e
1172 This also updates translated documentation.
1176 @node Docstrings in scheme
1177 @section Docstrings in scheme
1179 Material in the Internals reference is generated automatically
1180 from our source code. Any doc work on Internals therefore
1181 requires modifying files in @file{scm/*.scm}. Texinfo is allowed
1182 in these docstrings.
1184 Most documentation writers never touch these, though. If you want
1185 to work on them, please ask for help.
1188 @node Translating the documentation
1189 @section Translating the documentation
1191 The mailing list @code{translations@@lilynet.net} is dedicated to
1192 LilyPond web site and documentation translation; on this list, you will
1193 get support from the Translations Meister and experimented translators,
1194 and we regularly discuss translations issues common to all languagues.
1195 All people interested in LilyPond translations are invited to subscribe
1196 to this list regardless of the amount of their contribution, by sending
1197 an email to @code{translations-request@@lilynet.net} with subject
1198 @code{subscribe} and an empty message body. Unless mentioned explicitly
1199 or except if a translations coordinator contacts you privately, you
1200 should send questions, remarks, patches to this list
1201 @code{translations@@lilynet.net}; especially note that the traffic is so
1202 high on English-speaking list @code{lilypond-user@@gnu.org} that it may
1203 take months before your request or contribution is handled if you send a
1204 email to these lists.
1207 * Getting started with documentation translation::
1208 * Documentation translation details::
1209 * Documentation translation maintenance::
1210 * Translations management policies::
1211 * Technical background::
1214 @node Getting started with documentation translation
1215 @subsection Getting started with documentation translation
1217 First, get the sources of branch @code{lilypond/translation} from the
1218 Git repository, see @ref{Starting with Git}.
1221 * Translation requirements::
1222 * Which documentation can be translated::
1223 * Starting translation in a new language::
1226 @node Translation requirements
1227 @unnumberedsubsubsec Translation requirements
1229 Working on LilyPond documentation translations requires the following
1230 pieces of software, in order to make use of dedicated helper tools:
1233 @item Python 2.4 or higher,
1239 It is not required to build LilyPond and the documentation to
1240 translate the documentation. However, if you have enough time and
1241 motivation and a suitable system, it can be very useful to build at
1242 least the documentation so that you can check the output yourself and
1243 more quickly; if you are interested, see @ref{Compiling from source}.
1246 @node Which documentation can be translated
1247 @unnumberedsubsubsec Which documentation can be translated
1249 The makefiles and scripts infrastructure currently supports translation
1250 of the following documentation:
1253 @item the web site, the Learning Manual, the Notation Reference and
1254 Application Usage -- Texinfo source, PDF and HTML output; Info output
1255 might be added if there is enough demand for it;
1256 @item the Changes document.
1259 Support for translating the following pieces of documentation should be
1260 added soon, by decreasing order of priority:
1263 @item automatically generated documentation: markup commands,
1264 predefined music functions;
1265 @item the Snippets List;
1266 @item the Internals Reference.
1270 @node Starting translation in a new language
1271 @unnumberedsubsubsec Starting translation in a new language
1273 At top of the source directory, do
1280 or (if you want to install your self-compiled LilyPond locally)
1283 ./autogen.sh --prefix=$HOME
1287 If you want to compile LilyPond -- which is almost required to build
1288 the documentation, but is not required to do translation only -- fix
1289 all dependencies and rerun @command{./configure} (with the same
1290 options as for @command{autogen.sh}).
1292 Then @command{cd} into @file{Documentation/} and run
1295 make ISOLANG=@var{MY-LANGUAGE} new-lang
1299 where @var{MY-LANGUAGE} is the ISO 639 language code.
1301 Finally, add a language definition for your language in
1302 @file{python/langdefs.py}.
1305 @node Documentation translation details
1306 @subsection Documentation translation details
1308 Please follow all the instructions with care to ensure quality work.
1310 All files should be encoded in UTF-8.
1313 * Files to be translated::
1314 * Translating the Web site and other Texinfo documentation::
1315 * Adding a Texinfo manual::
1318 @node Files to be translated
1319 @unnumberedsubsubsec Files to be translated
1321 @include contributor/doc-translation-list.itexi
1323 In addition, not listed above, Snippets' titles and descriptions
1324 should be translated; they are a part of the Notation Reference and
1325 therefore their priority is 5.
1327 @node Translating the Web site and other Texinfo documentation
1328 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1330 Every piece of text should be translated in the source file, except
1331 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1334 Node names are translated, but the original node name in English should
1335 be kept as the argument of @code{@@translationof} put after the section
1336 title; that is, every piece in the original file like
1340 @@@var{section_command} Bar baz
1344 should be translated as
1347 @@node @var{translation of Foo bar}
1348 @@@var{section_command} @var{translation of Bar baz}
1349 @@translationof Foo bar
1352 The argument of @code{@@rglos} commands and the first argument of
1353 @code{@@rglosnamed} commands must not be translated, as it is the node
1354 name of an entry in Music Glossary.
1356 Every time you translate a node name in a cross-reference, i.e. the
1357 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1358 @@ruser} or the first argument of their @code{@var{*}named} variants,
1359 you should make sure the target node is defined in the correct source
1360 file; if you do not intend to translate the target node right now, you
1361 should at least write the node definition (that is, the @code{@@node
1362 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1363 expected source file and define all its parent nodes; for each node you
1364 have defined this way but have not translated, insert a line that
1365 contains @code{@@untranslated}. That is, you should end up
1366 for each untranslated node with something like
1369 @@node @var{translation of Foo bar}
1370 @@@var{section_command} @var{translation of Bar baz}
1371 @@translationof Foo bar
1376 @warning{you do not have to translate the node name of a cross-reference
1377 to a node that you do not have translated. If you do, you must define
1378 an @qq{empty} node like explained just above; this will produce a
1379 cross-reference with the translated node name in output, although the
1380 target node will still be in English. On the opposite, if all
1381 cross-references that refer to an untranslated node use the node name in
1382 English, then you do not have to define such an @qq{empty} node, and the
1383 cross-reference text will appear in English in the output. The choice
1384 between these two strategies implies its particular maintenance
1385 requirements and is left to the translators, although the opinion of the
1386 Translation meister leans towards not translating these
1389 Please think of the fact that it may not make sense translating
1390 everything in some Texinfo files, and you may take distance from the
1391 original text; for instance, in the translation of the web site section
1392 Community, you may take this into account depending on what you know the
1393 community in your language is willing to support, which is possible only
1394 if you personnally assume this support, or there exists a public forum
1395 or mailing list listed in Community for LilyPond in your language:
1398 @item @rweb{Bug reports}: this page should be translated only if you
1399 know that every bug report sent on your language's mailing list or forum
1400 will be handled by someone who will translate it to English and send it
1401 on bug-lilypond or add an issue in the tracker, then translate back the
1402 reply from developers.
1404 @item @rweb{Help us}: this page should be translated very freely,
1405 and possibly not at all: ask help for contributing to LilyPond for tasks
1406 that LilyPond community in your language is able and going to handle.
1410 In any case, please mark in your work the sections which do not result
1411 from the direct translation of a piece of English translation, using
1412 comments i.e. lines starting with @q{@code{@@c}}.
1414 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1415 menus. This process should be made easier in the future, when the helper
1416 script @command{texi-langutils.py} and the makefile target are updated.
1418 Some pieces of text manipulated by build scripts that appear in the
1419 output are translated in a @file{.po} file -- just like LilyPond output
1420 messages -- in @file{Documentation/po}. The Gettext domain is named
1421 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1422 through the Free Translation Project.
1425 Take care of using typographic rules for your language, especially in
1426 @file{macros.itexi}.
1428 If you wonder whether a word, phrase or larger piece of text should be
1429 translated, whether it is an argument of a Texinfo command or a small
1430 piece sandwiched between two Texinfo commands, try to track whether and
1431 where it appears in PDF and/or HTML output as visible text. This piece
1432 of advice is especially useful for translating @file{macros.itexi}.
1434 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1435 blocs). However, some music snippets containing text that shows in
1436 the rendered music, and sometimes translating this text really helps
1437 the user to understand the documentation; in this case, and only in
1438 this case, you may as an exception translate text in the music
1439 snippet, and then you must add a line immediately before the
1440 @code{@@lilypond} block, starting with
1447 Otherwise the music snippet would be reset to the same content as the
1448 English version at next @command{make snippet-update} run -- see
1449 @ref{Updating documentation translation}.
1454 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1458 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1459 translate the @code{texidoc} header field it contains, enclose it with
1460 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1461 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}.
1462 Additionnally, you may translate the snippet's title in @code{doctitle}
1463 header field, in case @code{doctitle} is a fragment option used in
1464 @code{@@lilypondfile}; you can do this exactly the same way as
1465 @code{texidoc}. For instance,
1466 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}
1470 doctitlees = "Spanish title baz"
1472 Spanish translation blah
1477 Then, you should get these translated strings into compiled snippets in
1478 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1479 and editing snippets}.
1481 @code{@@example} blocks need not be verbatim copies, e.g. variable
1482 names, file names and comments should be translated.
1484 Finally, please carefully apply every rule exposed in @ref{Texinfo
1485 introduction and usage policy}, and @ref{Documentation policy}. If one
1486 of these rules conflicts with a rule specific to your language, please
1487 ask the Translation meister on @email{translations@@lilynet.net} list
1488 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1492 @node Adding a Texinfo manual
1493 @unnumberedsubsubsec Adding a Texinfo manual
1495 In order to start translating a new manual whose basename is @var{FOO},
1499 cd Documentation/@var{MY-LANGUAGE}
1500 cp ../@var{FOO}.tely .
1502 cp web/GNUmakefile @var{FOO}
1506 then append @var{FOO} to variable @code{SUBDIRS} in
1507 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1508 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1512 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1516 Your are now ready to translate the new manual exactly like the web site
1517 or the Learning Manual.
1520 @node Documentation translation maintenance
1521 @subsection Documentation translation maintenance
1523 Several tools have been developed to make translations maintenance
1524 easier. These helper scripts make use of the power of Git, the
1525 version control system used for LilyPond development.
1527 You should use them whenever you would like to update the translation in
1528 your language, which you may do at the frequency that fits your and your
1529 cotranslators' respective available times. In the case your translation
1530 is up-do-date (which you can discover in the first subsection below), it
1531 is enough to check its state every one or two weeks. If you feel
1532 overwhelmed by the quantity of documentation to be updated, see
1533 @ref{Maintaining without updating translations}.
1536 * Check state of translation::
1537 * Updating documentation translation::
1538 * Updating translation committishes::
1541 @macro seeCommittishesUpdate{}
1542 @warning{do not forget to update the committish in each file you have
1543 completely updated, see @ref{Updating translation committishes}.}
1546 @node Check state of translation
1547 @unnumberedsubsubsec Check state of translation
1549 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1550 unless you are sure to master the translation state checking and
1551 updating system -- then cd into @file{Documentation/} (or at top of the
1552 source tree, replace @command{make} with @command{make -C
1553 Documentation}) and run
1556 make ISOLANG=@var{MY_LANGUAGE} check-translation
1560 This presents a diff of the original files since the most recent
1561 revision of the translation. To check a single file, cd into
1562 @file{Documentation/} and run
1565 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1569 In case this file has been renamed since you last updated the
1570 translation, you should specify both old and new file names, e.g.
1571 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1573 To see only which files need to be updated, do
1576 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1579 To avoid printing terminal colors control characters, which is often
1580 desirable when you redirect output to a file, run
1583 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1586 You can see the diffs generated by the commands above as changes that
1587 you should make in your language to the existing translation, in order
1588 to make your translation up to date.
1590 @seeCommittishesUpdate
1592 @warning{translation status generation is currently broken, so
1593 translation status pages have been removed; it will be regenerated again
1594 as soon as possible, in Texinfo format.}
1596 Global state of the translation is recorded in
1597 @file{Documentation/translations.html.in}, which is used to generate
1598 Translations status page. To update that page, do from
1599 @file{Documentation/}
1602 make translation-status
1605 This will also leave @file{out/translations-status.txt}, which contains
1606 up-to-dateness percentages for each translated file, and update word
1607 counts of documentation files in this Guide.
1610 @ref{Maintaining without updating translations}.
1613 @node Updating documentation translation
1614 @unnumberedsubsubsec Updating documentation translation
1616 Instead of running @code{check-translation}, you may want to run
1617 @code{update-translation}, which will run your favorite text editor to
1618 update files. First, make sure environment variable @code{EDITOR} is
1619 set to a text editor command, then run from @file{Documentation/}
1622 make ISOLANG=@var{MY_LANGUAGE} update-translation
1626 or to update a single file
1629 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1632 For each file to be udpated, @code{update-translation} will open your
1633 text editor with this file and a diff of the file in English; if the
1634 diff cannot be generated or is bigger than the file in English itself,
1635 the full file in English will be opened instead.
1637 @seeCommittishesUpdate
1639 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1640 containing only the first node of the original file in English can be
1641 updated automatically: whenever @command{make check-translation} shows
1642 that such files should be updated, run from @file{Documentation/}
1645 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1648 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1649 by issuing from @file{Documentation/} or @file{Documentation/po/}
1655 @warning{if you run po-update and somebody else does the same and
1656 pushes before you push or send a patch to be applied, there will be a
1657 conflict when you pull. Therefore, it is better that only the
1658 Translation meister runs this command.}
1660 Updating music snippets can quickly become cumbersome, as most
1661 snippets should be identical in all languages. Fortunately, there is
1662 a script that can do this odd job for you (run from
1663 @file{Documentation/}):
1666 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1669 This script overwrites music snippets in
1670 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1671 @file{@var{foo/every.itely}}. It ignores skeleton files, and keeps
1672 intact music snippets preceded with a line starting with @code{@@c
1673 KEEP LY}; it reports an error for each @file{.itely} that has not the
1674 same music snippet count in both languages. Always use this script
1675 with a lot of care, i.e. run it on a clean Git working tree, and check
1676 the changes it made with @command{git diff} before committing; if you
1677 don't do so, some @code{@@lilypond} snippets might be broken or make
1678 no sense in their context.
1680 When you have updated texidocs in
1681 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
1682 changes into compiled snippets in @file{Documentation/snippets}, see
1683 @q{General guidelines} in @ref{Adding and editing snippets}.
1685 Finally, a command runs the three update processes above for all
1686 enabled languages (from @file{Documentation/}):
1689 make all-translations-update
1692 Use this command with caution, and keep in mind it will not be really
1693 useful until translations are stabilized after the end of GDP and GOP.
1696 @ref{Maintaining without updating translations},
1697 @ref{Adding and editing snippets}.
1700 @node Updating translation committishes
1701 @unnumberedsubsubsec Updating translation committishes
1703 At the beginning of each translated file except PO files, there is a
1704 committish which represents the revision of the sources which you have
1705 used to translate this file from the file in English.
1707 When you have pulled and updated a translation, it is very important to
1708 update this committish in the files you have completely updated (and
1709 only these); to do this, first commit possible changes to any
1710 documentation in English which you are sure to have done in your
1711 translation as well, then replace in the up-to-date translated files the
1712 old committish by the committish of latest commit, which can be obtained
1716 git rev-list HEAD |head -1
1719 A special case is updating Snippet documentation strings in
1720 @file{Documentation/@var{MY-LANGUAGE}/texidocs}. For these to be
1721 correctly marked as up-to-date, first run @code{makelsr.py} as
1722 explained in @ref{Adding and editing snippets}, and commit the
1723 resulting compiled snippets left in @file{Documentation/snippets/}.
1724 Say the SHA1 ID code of this commit is <C>. Now edit again your
1725 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
1726 adjusting the 40-digit committish that appears in the text to be <C>;
1727 finally, commit these updated files. Not doing so would result in
1728 changes made both to your updates and original snippets to
1729 persistently appear in the check-translation output as if they were
1732 This two-phase mechanism avoids the (practically) unsolvable problem
1733 of guessing what committish will have our update, and pretending to
1734 put this very committish on the files in the same commit.
1736 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
1737 @c contains a helper script which could be used to perform massive
1738 @c committish updates.
1745 @node Translations management policies
1746 @subsection Translations management policies
1748 These policies show the general intent of how the translations should
1749 be managed, they aim at helping translators, developers and
1750 coordinators work efficiently.
1753 * Maintaining without updating translations::
1754 * Managing documentation translation with Git::
1757 @node Maintaining without updating translations
1758 @unnumberedsubsubsec Maintaining without updating translations
1760 Keeping translations up to date under heavy changes in the documentation
1761 in English may be almost impossible, especially as during the former
1762 Grand Documentation Project (GDP) or the Grand Organization Project
1763 (GOP) when a lot of contributors brings changes. In addition,
1764 translators may be --- and that is a very good thing --- involved in
1767 it is possible --- and even recommended --- to perform some maintenance
1768 that keeps translated documentation usable and eases future translation
1769 updating. The rationale below the tasks list motivates this plan.
1771 The following tasks are listed in decreasing priority order.
1774 @item Update macros.itexi.
1775 For each obsolete macro definition, if it is possible to update macro
1776 usage in documentation with an automatic text or regexp substitution,
1777 do it and delete the macro definition from macros.itexi; otherwise,
1778 mark this macro definition as obsolete with a comment, and keep it in
1779 macros.itexi until the documentation translation has been updated and
1780 no longer uses this macro.
1782 @item Update @file{*.tely} files completely with
1783 @command{make check-translation} -- you may want to redirect ouptput
1784 to a file because of overwhelming output, or call check-translation.py
1785 on individual files, see @ref{Check state of translation}.
1787 @item In @file{.itelys}, match sections and .itely file names with those from
1788 English docs, which possibly involves moving nodes contents in block
1789 between files, without updating contents itself. In other words, the
1790 game is catching where has gone each section. In Learning manual, and
1791 in Notation Reference sections which have been revised in GDP, there may
1792 be completely new sections: in this case, copy @code{@@node} and
1793 @code{@@section}-command from English docs, and add the marker for
1794 untranslated status @code{@@untranslated} on a single line. Note that
1795 it is not possible to exactly match subsections or subsubsections of
1796 documentation in English, when contents has been deeply revised; in this
1797 case, keep obsolete (sub)subsections in the translation, marking them
1798 with a line @code{@@c obsolete} just before the node.
1800 Emacs with Texinfo mode makes this step easier:
1803 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
1804 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
1805 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
1806 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
1807 (e.g. the translated file), copy @code{*Occur*} contents into
1808 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
1810 If you happen to have installed AucTeX, you can either call the macro
1811 by doing @key{M-x texinfo-show-structure} or create a key binding in your
1812 @file{~/.emacs}, by adding the four following lines:
1815 (add-hook 'Texinfo-mode-hook
1817 (define-key Texinfo-mode-map "\C-cs"
1818 'texinfo-show-structure)))
1822 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
1825 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
1826 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
1827 updated all the rest of the file.
1829 @item Moving to next or previous node using incremental search: press
1830 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
1831 contains the word @q{node}) then press @key{C-s} to move to next node
1832 or @key{C-r} to move to previous node. Similar operation can be used
1833 to move to the next/previous section. Note that every cursor move
1834 exits incremental search, and hitting @key{C-s} twice starts
1835 incremental search with the text entered in previous incremental
1838 @item Moving a whole node (or even a sequence of nodes): jump to beginning
1839 of the node (quit incremental search by pressing an arrow), press
1840 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
1841 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
1842 the right place (moving between nodes with the previous hint is often
1843 useful) and paste with @key{C-y} or @key{C-v}.
1846 @item Update sections finished in the English documentation; check
1848 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
1850 @item Update documentation PO. It is recommended not to update
1851 strings which come from documentation that is currently deeply revised
1852 in English, to avoid doing the work more than once.
1854 @item Fix broken cross-references by running (from @file{Documentation/})
1857 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
1861 This step requires a sucessful documentation build (with @command{make
1862 doc}). Some cross-references are broken because they point to a node
1863 that exists in the documentation in English, which has not been added
1864 to the translation; in this case, do not fix the cross-reference but
1865 keep it "broken", so that the resulting HTML link will point to an
1866 existing page of documentation in English.
1869 @subsubheading Rationale
1871 You may wonder if it would not be better to leave translations as-is
1872 until you can really start updating translations. There are several
1873 reasons to do these maintenance tasks right now.
1876 @item This will have to be done sooner or later anyway, before updating
1877 translation of documentation contents, and this can already be done
1878 without needing to be redone later, as sections of documentation in
1879 English are mostly revised once. However, note that not all
1880 documentation sectioning has been revised in one go, so all this
1881 maintenance plan has to be repeated whenever a big reorganization is
1884 @item This just makes translated documentation take advantage of the new
1885 organization, which is better than the old one.
1887 @item Moving and renaming sections to match sectioning of documentation in
1888 English simplify future updating work: it allows updating the
1889 translation by side-by-side comparison, without bothering whether
1890 cross-reference names already exist in the translation.
1892 @item Each maintenance task except @q{Updating PO files} can be done by
1893 the same person for all languages, which saves overall time spent by
1894 translators to achieve this task: the node names and section titles
1895 are in English, so you can do. It is important to take advantage of
1896 this now, as it will be more complicated (but still possible) to do
1897 step 3 in all languages when documentation is compiled with
1898 @command{texi2html} and node names are directly translated in source
1903 @node Managing documentation translation with Git
1904 @unnumberedsubsubsec Managing documentation translation with Git
1906 This policy explains how to manage Git branches and commit
1907 translations to Git.
1910 @item Translation changes matching master branch are preferably made on
1911 @code{lilypond/translation} branch; they may be pushed directly to
1912 @code{master} only if they do not break compilation of LilyPond and
1913 its documentation, and in this case they should be pushed to
1914 @code{lilypond/translation} too. Similarly, changes matching
1915 @code{stable/X.Y} are preferably made on
1916 @code{lilypond/X.Ytranslation}.
1918 @item @code{lilypond/translation} Git branch may be merged into
1919 master only if LilyPond (@command{make all}) and documentation
1920 (@command{make doc}) compile succesfully.
1922 @item @code{master} Git branch may be merged into
1923 @code{lilypond/translation} whenever @command{make} and @command{make
1924 doc} are succesful (in order to ease documentation compilation by
1925 translators), or when significant changes had been made in
1926 documentation in English in master branch.
1928 @item General maintenance may be done by anybody who knows what he does
1929 in documentation in all languages, without informing translators
1930 first. General maintenance include simple text substitutions
1931 (e.g. automated by sed), compilation fixes, updating Texinfo or
1932 lilypond-book commands, updating macros, updating ly code, fixing
1933 cross-references, and operations described in @ref{Maintaining
1934 without updating translations}.
1938 @node Technical background
1939 @subsection Technical background
1941 A number of Python scripts handle a part of the documentation
1942 translation process. All scripts used to maintain the translations
1943 are located in @file{scripts/auxiliar/}.
1946 @item @file{check_translation.py} -- show diff to update a translation,
1947 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
1948 make message catalogs and Texinfo skeleton files,
1949 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
1950 @item @file{update-snippets.py} -- synchronize ly snippets with those
1952 @item @file{translations-status.py} -- update translations status pages and word
1953 counts in the file you are reading,
1954 @item @file{tely-gettext.py} -- gettext node names, section titles and references
1955 in the sources; WARNING only use this script once for each file, when support for
1956 "makeinfo --html" has been dropped.
1959 Other scripts are used in the build process, in @file{scripts/build/}:
1962 @item @file{mass-link.py} -- link or symlink files between English documentation
1963 and documentation in other languages.
1966 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
1967 not by installed Python scripts) are located in @file{python/auxiliar/}:
1969 @item @file{manuals_definitions.py} -- define manual names and name of
1970 cross-reference Texinfo macros,
1971 @item @file{buildlib.py} -- common functions (read piped output
1972 of a shell command, use Git),
1973 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
1974 tweak links in HTML pages.
1979 @item @file{python/langdefs.py} -- language definitions module