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 Sectioning commands (@@node and @@section) must not appear
237 inside an @@ignore. Separate those commands with a space, ie @@n
242 Nodes must be included inside a
252 construct. These are easily constructed with automatic tools; see
253 @ref{Scripts to ease doc work}.
256 @node LilyPond formatting
257 @subsection LilyPond formatting
262 Use two spaces for indentation in lilypond examples. (no
266 All text strings should be prefaced with #. LilyPond does
267 not strictly require this, but it is helpful to get users
268 accustomed to this scheme construct. ie @code{\set
269 Staff.instrumentName = #"cello"}
272 All engravers should have double-quotes around them:
275 \consists "Spans_arpeggio_engraver"
278 Again, LilyPond does not strictly require this, but it is a useful
282 If possible, only write one bar per line.
285 If you only have one bar per line, omit bar checks. If you
286 must put more than one bar per line (not recommended), then include bar
290 Tweaks should, if possible, also occur on their own line.
294 \override textscript #'padding = #3 c1^"hi"
300 \override textscript #'padding = #3
305 Most LilyPond input should be produced with:
308 @@lilypond[verbatim,quote,relative=2]
315 @@lilypond[verbatim,quote,relative=1]
318 If you want to use \layout@{@} or define variables, use
321 @@lilypond[verbatim,quote]
324 In rare cases, other options may be used (or omitted), but ask first.
327 Inspirational headwords are produced with
330 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
331 @{pitches-headword.ly@}
335 LSR snippets are linked with
338 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
343 excepted in Templates, where `doctitle' may be omitted.
346 Avoid long stretches of input code. Nobody is going to read
347 them in print. Create small examples. However, this does not mean
351 Specify durations for at least the first note of every bar.
354 If possible, end with a complete bar.
357 Comments should go on their own line, and be placed before
358 the line(s) to which they refer.
361 Add extra spaces around @{ @} marks; ie
364 not: \chordmode @{c e g@}
365 but instead: \chordmode @{ c e g @}
369 If you want to work on an example outside of the manual (for
370 easier/faster processing), use this header:
375 line-width = 160\mm - 2.0 * 0.4\in
377 force-assignment = #""
378 line-width = #(- line-width (* mm 3.000000))
385 You may not change any of these values. If you are making an
386 example demonstrating special \paper@{@} values, contact the
387 Documentation Editor.
392 @node Text formatting
393 @subsection Text formatting
398 Lines should be less than 72 characters long. (We personally
399 recommend writing with 66-char lines, but do not bother modifying
406 Do not use spaces at the beginning of a line (except in
407 @@example or @@verbatim environments), and do not use more than a
408 single space between words. `makeinfo' copies the input lines
409 verbatim without removing those spaces.
412 Use two spaces after a period.
415 In examples of syntax, use @@var@{musicexpr@} for a music
419 Don't use @@rinternals@{@} in the main text. If you're
420 tempted to do so, you're probably getting too close to "talking
421 through the code". If you really want to refer to a context, use
422 @@code@{@} in the main text and @@rinternals@{@} in the @@seealso.
425 Variables or numbers which consist of a single character
426 (probably followed by a punctuation mark) should be tied properly,
427 either to the previous or the next word. Example:
430 The variable@@tie@{@}@@var@{a@} ...
434 To get consistent indentation in the DVI output it is better
435 to avoid the @@verbatim environment. Use the @@example
436 environment instead if possible, but without extraneous
437 indentation. For example, this
448 should be replaced with
459 where `@@example' starts the line (without leading spaces).
462 Do not compress the input vertically; this is, do not use
465 Beginning of logical unit
469 continuation of logical unit
476 Beginning of logical unit
483 continuation of logical unit
486 This makes it easier to avoid forgetting the `@@noindent'. Only
487 use @@noindent if the material is discussing the same material;
488 new material should simply begin without anything special on the
492 in @@itemize use @@item
493 on a separate line like this:
504 Do not use @@itemize @@bullet.
507 To get LilyPond version, use @@version@{@} (this does not work
508 inside LilyPond snippets). If you write "@@version@{@}" (enclosed
509 with quotes), or generally if @@version@{@} is not followed by a
510 space, there will be an ugly line break in PDF output unless you
518 @@w@{"@@version@{@}"@}
525 @subsection Syntax survey
529 @@bs - Generates a backslash inside @@warning.
530 Any `\' used inside @@warning (and @@q or @@qq) must be written as `@@bs@{@}'
531 (texinfo would also allow \\, but this breaks with PDF output).
534 @@c - single line comments
535 "@@c NOTE:" is a comment which should remain in the final
536 version. (gp only command ;)
539 @@cindex - General index. Please add as many as you can. Don't
540 capitalize the first word.
543 @@code@{@} - typeset in a tt-font. Use for actual lilypond code or
544 property/context names. If the name contains a space, wrap
545 the entire thing inside @@w@{@@code@{ @}@}.
548 @@example ... @@end example - example text that should be set as a
549 blockquote. Any @{@} must be escaped with @@@{ @}@@
552 @@funindex - is for a \lilycommand.
555 @@ignore ... @@end ignore - multi-line comment
560 B ... @@end itemize - for bulleted lists.
561 Do not compress vertically like this.
564 @@notation@{@} - refers to pieces of notation, e.g.
565 "@@notation@{cres.@}". Also use to specific lyrics ("the
566 @@notation@{A - men@} is centered"). Only use once per subsection
570 @@q@{@} - Single quotes. Used for `vague' terms.
573 @@qq@{@} - Double quotes. Used for actual quotes ("he said") or for
574 introducing special input modes.
577 @@rchanges@{@} - link to Changes.
580 @@rcontrib@{@} - link to Contributor's Guide.
583 @@ref@{@} - link within current manual (type the exact node name inside the
587 @@ressay@{@} - link to Engraving Essay.
590 @@rextend@{@} - link to Extending LilyPond.
593 @@rglos@{@} - link to the Music Glossary.
596 @@rinternals@{@} - link to the Internals Reference.
599 @@rlearning@{@} - link to Learning Manual.
602 @@rlsr@{@} - link to a Snippet section.
605 @@rprogram@{@} - link to Application Usage.
608 @@ruser@{@} - link to Notation Reference.
611 @@rweb@{@} - link to General Informaion.
614 @@tie@{@} - Variables or numbers which consist of a single character
615 (probably followed by a punctuation mark) should be tied
616 properly, either to the previous or the next word. Example:
617 "The letter@@tie@{@}@@q@{I@} is skipped"
620 @@uref@{@} - link to an external url.
623 @@var - Use for variables.
626 @@version@{@} - Return the current LilyPond version string
629 @@warning@{@} - produces a "Note: " box. Use for important messages.
635 @node Other text concerns
636 @subsection Other text concerns
641 References must occur at the end of a sentence, for more
642 information see @@ref@{the texinfo manual@}. Ideally this should
643 also be the final sentence of a paragraph, but this is not
644 required. Any link in a doc section must be duplicated in the
645 @@seealso section at the bottom.
648 Introducing examples must be done with
651 . (ie finish the previous sentence/paragaph)
652 : (ie `in this example:')
653 , (ie `may add foo with the blah construct,')
656 The old @qq{sentence runs directly into the example} method is not
660 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
671 When beginning a quote: "So, he said,...".
673 This usage is rarer. Americans often just use a comma.
676 When adding a defining example at the end of a sentence.
681 Non-ASCII characters which are in utf-8 should be directly used;
682 this is, don't say `Ba@@ss@{@}tuba' but `Baßtuba'. This ensures
683 that all such characters appear in all output formats.
690 @node Documentation policy
691 @section Documentation policy
695 * Section organization::
696 * Checking cross-references::
698 * Technical writing style::
704 There are four parts to the documentation: the Learning Manual,
705 the Notation Reference, the Program Reference, and the Music
713 The LM is written in a tutorial style which introduces the most
714 important concepts, structure and syntax of the elements of a
715 LilyPond score in a carefully graded sequence of steps.
716 Explanations of all musical concepts used in the Manual can be
717 found in the Music Glossary, and readers are assumed to have no
718 prior knowledge of LilyPond. The objective is to take readers to
719 a level where the Notation Reference can be understood and
720 employed to both adapt the templates in the Appendix to their
721 needs and to begin to construct their own scores. Commonly used
722 tweaks are introduced and explained. Examples are provided
723 throughout which, while being focussed on the topic being
724 introduced, are long enough to seem real in order to retain the
725 readers' interest. Each example builds on the previous material,
726 and comments are used liberally. Every new aspect is thoroughly
727 explained before it is used.
729 Users are encouraged to read the complete Learning Manual from
734 Notation Reference: a (hopefully complete) description of LilyPond
735 input notation. Some material from here may be duplicated in the
736 Learning Manual (for teaching), but consider the NR to be the
737 "definitive" description of each notation element, with the LM
738 being an "extra". The goal is _not_ to provide a step-by-step
739 learning environment -- do not avoid using notation that has not
740 be introduced previously in the NR (for example, use \break if
741 appropriate). This section is written in formal technical writing
744 Avoid duplication. Although users are not expected to read this
745 manual from start to finish, they should be familiar with the
746 material in the Learning Manual (particularly ``Fundamental
747 Concepts''), so do not repeat that material in each section of
748 this book. Also watch out for common constructs, like ^ - _ for
749 directions -- those are explained in NR 3. In NR 1, you can
750 write: DYNAMICS may be manually placed above or below the staff,
751 see @@ref@{Controlling direction and placement@}.
753 Most tweaks should be added to LSR and not placed directly in the
754 .itely file. In some cases, tweaks may be placed in the main
755 text, but ask about this first.
757 Finally, you should assume that users know what the notation
758 means; explaining musical concepts happens in the Music Glossary.
762 Application Usage: information about using the program lilypond
763 with other programs (lilypond-book, operating systems, GUIs,
764 convert-ly, etc). This section is written in formal technical
767 Users are not expected to read this manual from start to finish.
771 Music Glossary: information about the music notation itself.
772 Explanations and translations about notation terms go here.
774 Users are not expected to read this manual from start to finish.
777 Internals Reference: not really a documentation book, since it is
778 automagically generated from the source, but this is its name.
783 @node Section organization
784 @subsection Section organization
789 The order of headings inside documentation sections should
802 You @emph{must} include a @@seealso.
806 The order of items inside the @@seealso section is
815 @@rlearning@{foozle@}.
828 @@file@{path/to/dir/blahz@}.
830 Snippets: @@rlsr@{section@}.
833 @@rinternals@{fazzle@},
834 @@rinternals@{booar@}.
838 If there are multiple entries, separate them by commas but do not
842 Always end with a period.
845 Place each link on a new line as above; this makes it much easier
846 to add or remove links. In the output, they appear on a single
849 ("Snippets" is REQUIRED; the others are optional)
852 Any new concepts or links which require an explanation should go
853 as a full sentence(s) in the main text.
856 Don't insert an empty line between @@seealso and the first entry!
857 Otherwise there is excessive vertical space in the PDF output.
862 To create links, use @@ref@{@} if the link is within the same
866 @@predefined ... @@endpredefined is for commands in ly/*-init.ly
870 Do not include any real info in second-level sections (ie 1.1
871 Pitches). A first-level section may have introductory material,
872 but other than that all material goes into third-level sections
873 (ie 1.1.1 Writing Pitches).
878 @node Checking cross-references
879 @subsection Checking cross-references
881 Cross-references between different manuals are heavily used in the
882 documentation, but they are not checked during compilation.
883 However, if you compile the documentation, a script called
884 check_texi_refs can help you with checking and fixing these
885 cross-references; for information on usage, cd into a source tree
886 where documentation has been built, cd into Documentation and run:
893 Note that you have to find yourself the source files to fix
894 cross-references in the generated documentation such as the
895 Internals Reference; e.g. you can grep scm/ and lily/.
897 @c temporary? how long will kainhofer be used? -gp
898 Also of interest may be the linkdoc checks on kainhofer.com. Be
899 warned that these docs are not completely rebuilt every day, so it
900 might not accurately reflect the current state of the docs.
903 @uref{http://kainhofer.com/~lilypond/linkdoc/}
907 @node General writing
908 @subsection General writing
913 Do not forget to create @@cindex entries for new sections of text.
914 Enter commands with @@funindex, i.e.
917 @@cindex pitches, writing in different octaves
922 do not bother with the @@code@{@} (they are added automatically).
923 These items are added to both the command index and the unified
926 Both index commands should go in front of the actual material.
928 @@cindex entries should not be capitalized, ie
931 @@cindex time signature
935 is preferred instead of @qq{Time signature}, Only use capital
936 letters for musical terms which demand them, like D.S. al Fine.
938 For scheme functions, only include the final part, i.e.,
941 @@funindex modern-voice-cautionary
943 @@funindex #(set-accidental-style modern-voice-cautionary)
952 In general, use the American spellings. The internal lilypond
953 property names use this spelling.
956 List of specific terms:
960 simultaneous NOT concurrent
961 measure: the unit of music
962 bar line: the symbol delimiting a measure NOT barline
963 note head NOT notehead
964 chord construct NOT chord (when referring to <>)
972 @node Technical writing style
973 @subsection Technical writing style
975 These refer to the NR. The LM uses a more gentle, colloquial
981 Do not refer to LilyPond in the text. The reader knows what the
982 manual is about. If you do, capitalization is LilyPond.
985 If you explicitly refer to @q{lilypond} the program (or any other
986 command to be executed), write @code{@@command@{lilypond@}}.
989 Do not explicitly refer to the reader/user. There is no one else
990 besides the reader and the writer.
993 Avoid contractions (don't, won't, etc.). Spell the words out completely.
996 Avoid abbreviations, except for commonly used abbreviations of foreign
997 language terms such as etc. and i.e.
1000 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1004 The use of the word @q{illegal} is inappropriate in most cases.
1005 Say @q{invalid} instead.
1010 @node Tips for writing docs
1011 @section Tips for writing docs
1013 In the NR, I highly recommend focusing on one subsection at a
1014 time. For each subsection,
1019 check the mundane formatting. Are the headings (@@predefined,
1020 @@seealso, etc.) in the right order?
1023 add any appropriate index entries.
1026 check the links in the @@seealso section -- links to music
1027 glossary, internal references, and other NR sections are the main
1028 concern. Check for potential additions.
1031 move LSR-worthy material into LSR. Add the snippet, delete the
1032 material from the .itely file, and add a @@lilypondfile command.
1035 check the examples and descriptions. Do they still work?
1036 @strong{Do not} assume that the existing text is
1037 accurate/complete; some of the manual is highly out of date.
1040 is the material in the @@knownissues still accurate?
1043 can the examples be improved (made more explanatory), or is there
1044 any missing info? (feel free to ask specific questions on -user;
1045 a couple of people claimed to be interesting in being
1046 @qq{consultants} who would help with such questions)
1050 In general, I favor short text explanations with good examples --
1051 @qq{an example is worth a thousand words}. When I worked on the
1052 docs, I spent about half my time just working on those tiny
1053 lilypond examples. Making easily-understandable examples is much
1054 harder than it looks.
1057 @subsubheading Tweaks
1059 In general, any \set or \override commands should go in the
1060 @qq{select snippets} section, which means that they should go in
1061 LSR and not the .itely file. For some cases, the command
1062 obviously belongs in the @qq{main text} (i.e. not inside
1063 @@predefined or @@seealso or whatever) -- instrument names are a
1064 good example of this.
1067 \set Staff.instrumentName = #"foo"
1070 On the other side of this,
1073 \override Score.Hairpin #'after-line-breaking = ##t
1076 clearly belongs in LSR.
1078 I'm quite willing to discuss specific cases if you think that a
1079 tweaks needs to be in the main text. But items that can go into
1080 LSR are easier to maintain, so I'd like to move as much as
1081 possible into there.
1084 It would be @qq{nice} if you spent a lot of time crafting nice
1085 tweaks for users@dots{} but my recommendation is @strong{not} to do
1086 this. There's a lot of doc work to do without adding examples of
1087 tweaks. Tweak examples can easily be added by normal users by adding
1090 One place where a documentation writer can profitably spend time writing
1091 or upgrading tweaks is creating tweaks to deal with known issues. It
1092 would be ideal if every significant known issue had a workaround to avoid
1096 @ref{Adding and editing snippets}.
1099 @node Scripts to ease doc work
1100 @section Scripts to ease doc work
1102 @subheading Stripping whitespace
1104 @c TODO: should this be documented elsewhere? It's useful for
1105 @c more than just docs.
1106 To remove extra whitespace from the ends of lines, run
1109 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1113 @subheading Sectioning commands
1115 @warning{These commands add whitespace.}
1117 The emacs @code{M-x texinfo-all-menus-update} command will
1118 regenerate @@menu blocks. This can also be run with this
1119 command-line script:
1123 emacs $1 -batch -f texinfo-all-menus-update -f save-buffer
1127 (save the above as something like @command{texinfo-menus.sh}, make
1128 it executable, then run @command{texinfo-menus.sh foo.itely})
1131 @subheading Updating doc with @command{convert-ly}
1133 cd into @file{Documentation/} and run
1136 find . -name '*.itely' | xargs convert-ly -e
1140 This also updates translated documentation.
1144 @node Docstrings in scheme
1145 @section Docstrings in scheme
1147 Material in the Internals reference is generated automatically
1148 from our source code. Any doc work on Internals therefore
1149 requires modifying files in @file{scm/*.scm}. Texinfo is allowed
1150 in these docstrings.
1152 Most documentation writers never touch these, though. If you want
1153 to work on them, please ask for help.
1156 @node Translating the documentation
1157 @section Translating the documentation
1159 The mailing list @code{translations@@lilynet.net} is dedicated to
1160 LilyPond web site and documentation translation; on this list, you will
1161 get support from the Translations Meister and experimented translators,
1162 and we regularly discuss translations issues common to all languagues.
1163 All people interested in LilyPond translations are invited to subscribe
1164 to this list regardless of the amount of their contribution, by sending
1165 an email to @code{translations-request@@lilynet.net} with subject
1166 @code{subscribe} and an empty message body. Unless mentioned explicitly
1167 or except if a translations coordinator contacts you privately, you
1168 should send questions, remarks, patches to this list
1169 @code{translations@@lilynet.net}; especially note that the traffic is so
1170 high on English-speaking list @code{lilypond-user@@gnu.org} that it may
1171 take months before your request or contribution is handled if you send a
1172 email to these lists.
1175 * Getting started with documentation translation::
1176 * Documentation translation details::
1177 * Documentation translation maintenance::
1178 * Translations management policies::
1179 * Technical background::
1182 @node Getting started with documentation translation
1183 @subsection Getting started with documentation translation
1185 First, get the sources of branch @code{lilypond/translation} from the
1186 Git repository, see @ref{Starting with Git}.
1189 * Translation requirements::
1190 * Which documentation can be translated::
1191 * Starting translation in a new language::
1194 @node Translation requirements
1195 @unnumberedsubsubsec Translation requirements
1197 Working on LilyPond documentation translations requires the following
1198 pieces of software, in order to make use of dedicated helper tools:
1201 @item Python 2.4 or higher,
1207 It is not required to build LilyPond and the documentation to
1208 translate the documentation. However, if you have enough time and
1209 motivation and a suitable system, it can be very useful to build at
1210 least the documentation so that you can check the output yourself and
1211 more quickly; if you are interested, see @ref{Compiling from source}.
1214 @node Which documentation can be translated
1215 @unnumberedsubsubsec Which documentation can be translated
1217 The makefiles and scripts infrastructure currently supports translation
1218 of the following documentation:
1221 @item the web site, the Learning Manual, the Notation Reference and
1222 Application Usage -- Texinfo source, PDF and HTML output; Info output
1223 might be added if there is enough demand for it;
1224 @item the Changes document.
1227 Support for translating the following pieces of documentation should be
1228 added soon, by decreasing order of priority:
1231 @item automatically generated documentation: markup commands,
1232 predefined music functions;
1233 @item the Snippets List;
1234 @item the Internals Reference.
1238 @node Starting translation in a new language
1239 @unnumberedsubsubsec Starting translation in a new language
1241 At top of the source directory, do
1248 or (if you want to install your self-compiled LilyPond locally)
1251 ./autogen.sh --prefix=$HOME
1255 If you want to compile LilyPond -- which is almost required to build
1256 the documentation, but is not required to do translation only -- fix
1257 all dependencies and rerun @command{./configure} (with the same
1258 options as for @command{autogen.sh}).
1260 Then @command{cd} into @file{Documentation/} and run
1263 make ISOLANG=@var{MY-LANGUAGE} new-lang
1267 where @var{MY-LANGUAGE} is the ISO 639 language code.
1269 Finally, add a language definition for your language in
1270 @file{python/langdefs.py}.
1273 @node Documentation translation details
1274 @subsection Documentation translation details
1276 Please follow all the instructions with care to ensure quality work.
1278 All files should be encoded in UTF-8.
1281 * Files to be translated::
1282 * Translating the Web site and other Texinfo documentation::
1283 * Adding a Texinfo manual::
1286 @node Files to be translated
1287 @unnumberedsubsubsec Files to be translated
1289 @include contributor/doc-translation-list.itexi
1291 In addition, not listed above, Snippets' titles and descriptions
1292 should be translated; they are a part of the Notation Reference and
1293 therefore their priority is 5.
1295 @node Translating the Web site and other Texinfo documentation
1296 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1298 Every piece of text should be translated in the source file, except
1299 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1302 Node names are translated, but the original node name in English should
1303 be kept as the argument of @code{@@translationof} put after the section
1304 title; that is, every piece in the original file like
1308 @@@var{section_command} Bar baz
1312 should be translated as
1315 @@node @var{translation of Foo bar}
1316 @@@var{section_command} @var{translation of Bar baz}
1317 @@translationof Foo bar
1320 The argument of @code{@@rglos} commands and the first argument of
1321 @code{@@rglosnamed} commands must not be translated, as it is the node
1322 name of an entry in Music Glossary.
1324 Every time you translate a node name in a cross-reference, i.e. the
1325 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1326 @@ruser} or the first argument of their @code{@var{*}named} variants,
1327 you should make sure the target node is defined in the correct source
1328 file; if you do not intend to translate the target node right now, you
1329 should at least write the node definition (that is, the @code{@@node
1330 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1331 expected source file and define all its parent nodes; for each node you
1332 have defined this way but have not translated, insert a line that
1333 contains @code{@@untranslated}. That is, you should end up
1334 for each untranslated node with something like
1337 @@node @var{translation of Foo bar}
1338 @@@var{section_command} @var{translation of Bar baz}
1339 @@translationof Foo bar
1344 @warning{you do not have to translate the node name of a cross-reference
1345 to a node that you do not have translated. If you do, you must define
1346 an @qq{empty} node like explained just above; this will produce a
1347 cross-reference with the translated node name in output, although the
1348 target node will still be in English. On the opposite, if all
1349 cross-references that refer to an untranslated node use the node name in
1350 English, then you do not have to define such an @qq{empty} node, and the
1351 cross-reference text will appear in English in the output. The choice
1352 between these two strategies implies its particular maintenance
1353 requirements and is left to the translators, although the opinion of the
1354 Translation meister leans towards not translating these
1357 Please think of the fact that it may not make sense translating
1358 everything in some Texinfo files, and you may take distance from the
1359 original text; for instance, in the translation of the web site section
1360 Community, you may take this into account depending on what you know the
1361 community in your language is willing to support, which is possible only
1362 if you personnally assume this support, or there exists a public forum
1363 or mailing list listed in Community for LilyPond in your language:
1366 @item @rweb{Bug reports}: this page should be translated only if you
1367 know that every bug report sent on your language's mailing list or forum
1368 will be handled by someone who will translate it to English and send it
1369 on bug-lilypond or add an issue in the tracker, then translate back the
1370 reply from developers.
1372 @item @rweb{Help us}: this page should be translated very freely,
1373 and possibly not at all: ask help for contributing to LilyPond for tasks
1374 that LilyPond community in your language is able and going to handle.
1378 In any case, please mark in your work the sections which do not result
1379 from the direct translation of a piece of English translation, using
1380 comments i.e. lines starting with @q{@code{@@c}}.
1382 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1383 menus. This process should be made easier in the future, when the helper
1384 script @command{texi-langutils.py} and the makefile target are updated.
1386 Some pieces of text manipulated by build scripts that appear in the
1387 output are translated in a @file{.po} file -- just like LilyPond output
1388 messages -- in @file{Documentation/po}. The Gettext domain is named
1389 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1390 through the Free Translation Project.
1393 Take care of using typographic rules for your language, especially in
1394 @file{macros.itexi}.
1396 If you wonder whether a word, phrase or larger piece of text should be
1397 translated, whether it is an argument of a Texinfo command or a small
1398 piece sandwiched between two Texinfo commands, try to track whether and
1399 where it appears in PDF and/or HTML output as visible text. This piece
1400 of advice is especially useful for translating @file{macros.itexi}.
1402 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1403 blocs). However, some music snippets containing text that shows in
1404 the rendered music, and sometimes translating this text really helps
1405 the user to understand the documentation; in this case, and only in
1406 this case, you may as an exception translate text in the music
1407 snippet, and then you must add a line immediately before the
1408 @code{@@lilypond} block, starting with
1415 Otherwise the music snippet would be reset to the same content as the
1416 English version at next @command{make snippet-update} run -- see
1417 @ref{Updating documentation translation}.
1422 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1426 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1427 translate the @code{texidoc} header field it contains, enclose it with
1428 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1429 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}.
1430 Additionnally, you may translate the snippet's title in @code{doctitle}
1431 header field, in case @code{doctitle} is a fragment option used in
1432 @code{@@lilypondfile}; you can do this exactly the same way as
1433 @code{texidoc}. For instance,
1434 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}
1438 doctitlees = "Spanish title baz"
1440 Spanish translation blah
1445 Then, you should get these translated strings into compiled snippets in
1446 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1447 and editing snippets}.
1449 @code{@@example} blocks need not be verbatim copies, e.g. variable
1450 names, file names and comments should be translated.
1452 Finally, please carefully apply every rule exposed in @ref{Texinfo
1453 introduction and usage policy}, and @ref{Documentation policy}. If one
1454 of these rules conflicts with a rule specific to your language, please
1455 ask the Translation meister on @email{translations@@lilynet.net} list
1456 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1460 @node Adding a Texinfo manual
1461 @unnumberedsubsubsec Adding a Texinfo manual
1463 In order to start translating a new manual whose basename is @var{FOO},
1467 cd Documentation/@var{MY-LANGUAGE}
1468 cp ../@var{FOO}.tely .
1470 cp web/GNUmakefile @var{FOO}
1474 then append @var{FOO} to variable @code{SUBDIRS} in
1475 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1476 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1480 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1484 Your are now ready to translate the new manual exactly like the web site
1485 or the Learning Manual.
1488 @node Documentation translation maintenance
1489 @subsection Documentation translation maintenance
1491 Several tools have been developed to make translations maintenance
1492 easier. These helper scripts make use of the power of Git, the
1493 version control system used for LilyPond development.
1495 You should use them whenever you would like to update the translation in
1496 your language, which you may do at the frequency that fits your and your
1497 cotranslators' respective available times. In the case your translation
1498 is up-do-date (which you can discover in the first subsection below), it
1499 is enough to check its state every one or two weeks. If you feel
1500 overwhelmed by the quantity of documentation to be updated, see
1501 @ref{Maintaining without updating translations}.
1504 * Check state of translation::
1505 * Updating documentation translation::
1506 * Updating translation committishes::
1509 @macro seeCommittishesUpdate{}
1510 @warning{do not forget to update the committish in each file you have
1511 completely updated, see @ref{Updating translation committishes}.}
1514 @node Check state of translation
1515 @unnumberedsubsubsec Check state of translation
1517 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1518 unless you are sure to master the translation state checking and
1519 updating system -- then cd into @file{Documentation/} (or at top of the
1520 source tree, replace @command{make} with @command{make -C
1521 Documentation}) and run
1524 make ISOLANG=@var{MY_LANGUAGE} check-translation
1528 This presents a diff of the original files since the most recent
1529 revision of the translation. To check a single file, cd into
1530 @file{Documentation/} and run
1533 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1537 In case this file has been renamed since you last updated the
1538 translation, you should specify both old and new file names, e.g.
1539 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1541 To see only which files need to be updated, do
1544 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1547 To avoid printing terminal colors control characters, which is often
1548 desirable when you redirect output to a file, run
1551 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1554 You can see the diffs generated by the commands above as changes that
1555 you should make in your language to the existing translation, in order
1556 to make your translation up to date.
1558 @seeCommittishesUpdate
1560 @warning{translation status generation is currently broken, so
1561 translation status pages have been removed; it will be regenerated again
1562 as soon as possible, in Texinfo format.}
1564 Global state of the translation is recorded in
1565 @file{Documentation/translations.html.in}, which is used to generate
1566 Translations status page. To update that page, do from
1567 @file{Documentation/}
1570 make translation-status
1573 This will also leave @file{out/translations-status.txt}, which contains
1574 up-to-dateness percentages for each translated file, and update word
1575 counts of documentation files in this Guide.
1578 @ref{Maintaining without updating translations}.
1581 @node Updating documentation translation
1582 @unnumberedsubsubsec Updating documentation translation
1584 Instead of running @code{check-translation}, you may want to run
1585 @code{update-translation}, which will run your favorite text editor to
1586 update files. First, make sure environment variable @code{EDITOR} is
1587 set to a text editor command, then run from @file{Documentation/}
1590 make ISOLANG=@var{MY_LANGUAGE} update-translation
1594 or to update a single file
1597 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1600 For each file to be udpated, @code{update-translation} will open your
1601 text editor with this file and a diff of the file in English; if the
1602 diff cannot be generated or is bigger than the file in English itself,
1603 the full file in English will be opened instead.
1605 @seeCommittishesUpdate
1607 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1608 containing only the first node of the original file in English can be
1609 updated automatically: whenever @command{make check-translation} shows
1610 that such files should be updated, run from @file{Documentation/}
1613 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1616 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1617 by issuing from @file{Documentation/} or @file{Documentation/po/}
1623 @warning{if you run po-update and somebody else does the same and
1624 pushes before you push or send a patch to be applied, there will be a
1625 conflict when you pull. Therefore, it is better that only the
1626 Translation meister runs this command.}
1628 Updating music snippets can quickly become cumbersome, as most
1629 snippets should be identical in all languages. Fortunately, there is
1630 a script that can do this odd job for you (run from
1631 @file{Documentation/}):
1634 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1637 This script overwrites music snippets in
1638 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1639 @file{@var{foo/every.itely}}. It ignores skeleton files, and keeps
1640 intact music snippets preceded with a line starting with @code{@@c
1641 KEEP LY}; it reports an error for each @file{.itely} that has not the
1642 same music snippet count in both languages. Always use this script
1643 with a lot of care, i.e. run it on a clean Git working tree, and check
1644 the changes it made with @command{git diff} before committing; if you
1645 don't do so, some @code{@@lilypond} snippets might be broken or make
1646 no sense in their context.
1648 When you have updated texidocs in
1649 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
1650 changes into compiled snippets in @file{Documentation/snippets}, see
1651 @q{General guidelines} in @ref{Adding and editing snippets}.
1653 Finally, a command runs the three update processes above for all
1654 enabled languages (from @file{Documentation/}):
1657 make all-translations-update
1660 Use this command with caution, and keep in mind it will not be really
1661 useful until translations are stabilized after the end of GDP and GOP.
1664 @ref{Maintaining without updating translations},
1665 @ref{Adding and editing snippets}.
1668 @node Updating translation committishes
1669 @unnumberedsubsubsec Updating translation committishes
1671 At the beginning of each translated file except PO files, there is a
1672 committish which represents the revision of the sources which you have
1673 used to translate this file from the file in English.
1675 When you have pulled and updated a translation, it is very important to
1676 update this committish in the files you have completely updated (and
1677 only these); to do this, first commit possible changes to any
1678 documentation in English which you are sure to have done in your
1679 translation as well, then replace in the up-to-date translated files the
1680 old committish by the committish of latest commit, which can be obtained
1684 git rev-list HEAD |head -1
1687 A special case is updating Snippet documentation strings in
1688 @file{Documentation/@var{MY-LANGUAGE}/texidocs}. For these to be
1689 correctly marked as up-to-date, first run @code{makelsr.py} as
1690 explained in @ref{Adding and editing snippets}, and commit the
1691 resulting compiled snippets left in @file{Documentation/snippets/}.
1692 Say the SHA1 ID code of this commit is <C>. Now edit again your
1693 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
1694 adjusting the 40-digit committish that appears in the text to be <C>;
1695 finally, commit these updated files. Not doing so would result in
1696 changes made both to your updates and original snippets to
1697 persistently appear in the check-translation output as if they were
1700 This two-phase mechanism avoids the (practically) unsolvable problem
1701 of guessing what committish will have our update, and pretending to
1702 put this very committish on the files in the same commit.
1704 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
1705 @c contains a helper script which could be used to perform massive
1706 @c committish updates.
1713 @node Translations management policies
1714 @subsection Translations management policies
1716 These policies show the general intent of how the translations should
1717 be managed, they aim at helping translators, developers and
1718 coordinators work efficiently.
1721 * Maintaining without updating translations::
1722 * Managing documentation translation with Git::
1725 @node Maintaining without updating translations
1726 @unnumberedsubsubsec Maintaining without updating translations
1728 Keeping translations up to date under heavy changes in the documentation
1729 in English may be almost impossible, especially as during the former
1730 Grand Documentation Project (GDP) or the Grand Organization Project
1731 (GOP) when a lot of contributors brings changes. In addition,
1732 translators may be --- and that is a very good thing --- involved in
1735 it is possible --- and even recommended --- to perform some maintenance
1736 that keeps translated documentation usable and eases future translation
1737 updating. The rationale below the tasks list motivates this plan.
1739 The following tasks are listed in decreasing priority order.
1742 @item Update macros.itexi.
1743 For each obsolete macro definition, if it is possible to update macro
1744 usage in documentation with an automatic text or regexp substitution,
1745 do it and delete the macro definition from macros.itexi; otherwise,
1746 mark this macro definition as obsolete with a comment, and keep it in
1747 macros.itexi until the documentation translation has been updated and
1748 no longer uses this macro.
1750 @item Update @file{*.tely} files completely with
1751 @command{make check-translation} -- you may want to redirect ouptput
1752 to a file because of overwhelming output, or call check-translation.py
1753 on individual files, see @ref{Check state of translation}.
1755 @item In @file{.itelys}, match sections and .itely file names with those from
1756 English docs, which possibly involves moving nodes contents in block
1757 between files, without updating contents itself. In other words, the
1758 game is catching where has gone each section. In Learning manual, and
1759 in Notation Reference sections which have been revised in GDP, there may
1760 be completely new sections: in this case, copy @code{@@node} and
1761 @code{@@section}-command from English docs, and add the marker for
1762 untranslated status @code{@@untranslated} on a single line. Note that
1763 it is not possible to exactly match subsections or subsubsections of
1764 documentation in English, when contents has been deeply revised; in this
1765 case, keep obsolete (sub)subsections in the translation, marking them
1766 with a line @code{@@c obsolete} just before the node.
1768 Emacs with Texinfo mode makes this step easier:
1771 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
1772 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
1773 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
1774 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
1775 (e.g. the translated file), copy @code{*Occur*} contents into
1776 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
1778 If you happen to have installed AucTeX, you can either call the macro
1779 by doing @key{M-x texinfo-show-structure} or create a key binding in your
1780 @file{~/.emacs}, by adding the four following lines:
1783 (add-hook 'Texinfo-mode-hook
1785 (define-key Texinfo-mode-map "\C-cs"
1786 'texinfo-show-structure)))
1790 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
1793 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
1794 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
1795 updated all the rest of the file.
1797 @item Moving to next or previous node using incremental search: press
1798 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
1799 contains the word @q{node}) then press @key{C-s} to move to next node
1800 or @key{C-r} to move to previous node. Similar operation can be used
1801 to move to the next/previous section. Note that every cursor move
1802 exits incremental search, and hitting @key{C-s} twice starts
1803 incremental search with the text entered in previous incremental
1806 @item Moving a whole node (or even a sequence of nodes): jump to beginning
1807 of the node (quit incremental search by pressing an arrow), press
1808 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
1809 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
1810 the right place (moving between nodes with the previous hint is often
1811 useful) and paste with @key{C-y} or @key{C-v}.
1814 @item Update sections finished in the English documentation; check
1816 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
1818 @item Update documentation PO. It is recommended not to update
1819 strings which come from documentation that is currently deeply revised
1820 in English, to avoid doing the work more than once.
1822 @item Fix broken cross-references by running (from @file{Documentation/})
1825 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
1829 This step requires a sucessful documentation build (with @command{make
1830 doc}). Some cross-references are broken because they point to a node
1831 that exists in the documentation in English, which has not been added
1832 to the translation; in this case, do not fix the cross-reference but
1833 keep it "broken", so that the resulting HTML link will point to an
1834 existing page of documentation in English.
1837 @subsubheading Rationale
1839 You may wonder if it would not be better to leave translations as-is
1840 until you can really start updating translations. There are several
1841 reasons to do these maintenance tasks right now.
1844 @item This will have to be done sooner or later anyway, before updating
1845 translation of documentation contents, and this can already be done
1846 without needing to be redone later, as sections of documentation in
1847 English are mostly revised once. However, note that not all
1848 documentation sectioning has been revised in one go, so all this
1849 maintenance plan has to be repeated whenever a big reorganization is
1852 @item This just makes translated documentation take advantage of the new
1853 organization, which is better than the old one.
1855 @item Moving and renaming sections to match sectioning of documentation in
1856 English simplify future updating work: it allows updating the
1857 translation by side-by-side comparison, without bothering whether
1858 cross-reference names already exist in the translation.
1860 @item Each maintenance task except @q{Updating PO files} can be done by
1861 the same person for all languages, which saves overall time spent by
1862 translators to achieve this task: the node names and section titles
1863 are in English, so you can do. It is important to take advantage of
1864 this now, as it will be more complicated (but still possible) to do
1865 step 3 in all languages when documentation is compiled with
1866 @command{texi2html} and node names are directly translated in source
1871 @node Managing documentation translation with Git
1872 @unnumberedsubsubsec Managing documentation translation with Git
1874 This policy explains how to manage Git branches and commit
1875 translations to Git.
1878 @item Translation changes matching master branch are preferably made on
1879 @code{lilypond/translation} branch; they may be pushed directly to
1880 @code{master} only if they do not break compilation of LilyPond and
1881 its documentation, and in this case they should be pushed to
1882 @code{lilypond/translation} too. Similarly, changes matching
1883 @code{stable/X.Y} are preferably made on
1884 @code{lilypond/X.Ytranslation}.
1886 @item @code{lilypond/translation} Git branch may be merged into
1887 master only if LilyPond (@command{make all}) and documentation
1888 (@command{make doc}) compile succesfully.
1890 @item @code{master} Git branch may be merged into
1891 @code{lilypond/translation} whenever @command{make} and @command{make
1892 doc} are succesful (in order to ease documentation compilation by
1893 translators), or when significant changes had been made in
1894 documentation in English in master branch.
1896 @item General maintenance may be done by anybody who knows what he does
1897 in documentation in all languages, without informing translators
1898 first. General maintenance include simple text substitutions
1899 (e.g. automated by sed), compilation fixes, updating Texinfo or
1900 lilypond-book commands, updating macros, updating ly code, fixing
1901 cross-references, and operations described in @ref{Maintaining
1902 without updating translations}.
1906 @node Technical background
1907 @subsection Technical background
1909 A number of Python scripts handle a part of the documentation
1910 translation process. All scripts used to maintain the translations
1911 are located in @file{scripts/auxiliar/}.
1914 @item @file{check_translation.py} -- show diff to update a translation,
1915 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
1916 make message catalogs and Texinfo skeleton files,
1917 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
1918 @item @file{update-snippets.py} -- synchronize ly snippets with those
1920 @item @file{translations-status.py} -- update translations status pages and word
1921 counts in the file you are reading,
1922 @item @file{tely-gettext.py} -- gettext node names, section titles and references
1923 in the sources; WARNING only use this script once for each file, when support for
1924 "makeinfo --html" has been dropped.
1927 Other scripts are used in the build process, in @file{scripts/build/}:
1930 @item @file{mass-link.py} -- link or symlink files between English documentation
1931 and documentation in other languages.
1934 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
1935 not by installed Python scripts) are located in @file{python/auxiliar/}:
1937 @item @file{manuals_definitions.py} -- define manual names and name of
1938 cross-reference Texinfo macros,
1939 @item @file{buildlib.py} -- common functions (read piped output
1940 of a shell command, use Git),
1941 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
1942 tweak links in HTML pages.
1947 @item @file{python/langdefs.py} -- language definitions module