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.
300 not: \override TextScript #'padding = #3 c1^"hi"
301 but instead: \override TextScript #'padding = #3
306 Most LilyPond input should be produced with:
309 @@lilypond[verbatim,quote,relative=2]
316 @@lilypond[verbatim,quote,relative=1]
319 If you want to use @code{\layout@{@}} or define variables, use
322 @@lilypond[verbatim,quote]
325 In rare cases, other options may be used (or omitted), but ask first.
328 Inspirational headwords are produced with
331 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
332 @{pitches-headword.ly@}
336 LSR snippets are linked with
339 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
344 excepted in Templates, where `doctitle' may be omitted.
347 Avoid long stretches of input code. Nobody is going to read
348 them in print. Create small examples. However, this does not mean
352 Specify durations for at least the first note of every bar.
355 If possible, end with a complete bar.
358 Comments should go on their own line, and be placed before
359 the line(s) to which they refer.
362 Add extra spaces around @{ @} marks; ie
365 not: \chordmode @{c e g@}
366 but instead: \chordmode @{ c e g @}
370 Use @{ @} marks for additional @code{\markup} format comands; ie
373 not: c^\markup \tiny\sharp
374 but instead: c^\markup @{ \tiny \sharp @}
378 Remove any space around @code{<} @code{>} marks; ie
382 but instead: <c e g>4
386 Beam, slur and tie marks should begin immediately after the first
387 note with beam and phrase marks ending immediately after the last.
390 a8(\ ais16[ b cis( d] b) cis4~ b' cis,\)
394 If you want to work on an example outside of the manual (for
395 easier/faster processing), use this header:
400 line-width = 160\mm - 2.0 * 0.4\in
402 force-assignment = #""
403 line-width = #(- line-width (* mm 3.000000))
410 You may not change any of these values. If you are making an
411 example demonstrating special @code{\paper@{@}} values, contact the
412 Documentation Editor.
417 @node Text formatting
418 @subsection Text formatting
422 Lines should be less than 72 characters long. (We personally
423 recommend writing with 66-char lines, but do not bother modifying
424 existing material). Also see the recommendations for fixed-width
425 fonts in the @ref{Syntax survey}.
431 Do not use spaces at the beginning of a line (except in
432 @code{@@example} or @code{@@verbatim} environments), and do not
433 use more than a single space between words. @q{makeinfo} copies
434 the input lines verbatim without removing those spaces.
437 Use two spaces after a period.
440 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
444 Don't use @code{@@rinternals@{@}} in the main text. If you're
445 tempted to do so, you're probably getting too close to @qq{talking
446 through the code}. If you really want to refer to a context, use
447 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
448 the @code{@@seealso}.
453 @subsection Syntax survey
463 * Special characters::
469 @unnumberedsubsubsec Comments
473 @code{@@c @dots{}} --- single line comment. @samp{@@c NOTE:} is a
474 comment which should remain in the final version. (gp only
478 @code{@@ignore} --- multi-line comment:
488 @node Cross references
489 @unnumberedsubsubsec Cross references
491 Enter the exact @code{@@node} name of the target reference between
492 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}).
496 @code{@@ref@{@dots{}@}} --- link within current manual.
499 @code{@@rchanges@{@dots{}@}} --- link to Changes.
502 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
505 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
508 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
511 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
514 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
517 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
520 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
523 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
526 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
529 @code{@@rweb@{@dots{}@}} --- link to General Informaion.
534 @unnumberedsubsubsec External links
538 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
541 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
542 external url. Use within an @code{@@example ... @@end example}.
546 @@uref@{URL [, link text ]@}
552 @node Fixed-width font
553 @unnumberedsubsubsec Fixed-width font
557 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
559 Use the @code{@@code@{@dots{}@}} command for individual
560 language-specific tokens (keywords, commands, engravers, scheme
561 symbols, etc.). Ideally, a single @code{@@code@{@dots{}@}} block
562 should fit within one line in the PDF output. Use the
563 @code{@@samp@{@dots{}@}} command when you have a short example of
564 user input, unless it constitutes an entire @code{@@item} by
565 itself, in which case @code{@@code@{@dots{}@}} is preferable.
566 Otherwise, both should only be used when part of a larger sentence
567 within a paragraph or @code{@@item}. Never use a
568 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} block as a
569 free-standing paragraph; use @code{@@example} instead.
571 A single unindented line in the PDF has space for about 79
572 fixed-width characters (76 if indented). Within an @code{@@item}
573 there is space for about 75 fixed-width characters. Each
574 additional level of @code{@@itemize} or @code{@@enumerate}
575 shortens the line by about 4 columns.
577 However, even short blocks of @code{@@code@{@dots{}@}} and
578 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
579 line-breaking algorithm gets confused. Additionally, blocks that
580 are longer than this may in fact print nicely; it all depends
581 where the line breaks end up. If you compile the docs yourself,
582 check the PDF output to make sure the line breaks are
585 The Texinfo setting @code{@@allowcodebreaks} is set to
586 @code{false} in the manuals, so lines within
587 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
588 only break at spaces, not at hyphens or underscores. If the block
589 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
590 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
592 The Texinfo settings @code{txicodequoteundirected} and
593 @code{txicodequotebacktick} are both set in the manuals, so
594 backticks (@code{`}) and apostrophes (@code{'}) placed within
595 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
596 are not converted to left- and right-angled quotes
597 (@code{@quoteleft{} @quoteright{}}) as they normally are within
598 the text, so the apostrophes in
599 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
600 correctly. However, these settings do not affect the PDF output
601 for anything within a @code{@@samp} block (even if it includes a
602 nested @code{@@code} block), so entering
603 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
604 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
605 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
606 which contains backticks or apostrophes, you should instead use
607 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
608 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
609 contains spaces). Note that backslashes within
610 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
611 so the example above would be coded as
612 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
615 @code{@@command@{@dots{}@}} --- Use for command-line commands (eg.
616 @samp{@@command@{lilypond-book@}}).
619 @code{@@example} --- Use for examples of program code. Do not add
620 extraneous indentation (ie. don't start every line with
621 whitespace). Use the following layout (notice the use of blank
622 lines). Omit the @code{@@noindent} if the text following the
623 example starts a new paragraph:
626 @var{@dots{}text leading into the example@dots{}}
633 @var{continuation of the text@dots{}}
636 Individual lines within an @code{@@example} block should not
637 exceed 74 characters; otherwise they will run into the margin in
638 the PDF output, and may get clipped. If an @code{@@example} block
639 is part of an @code{@@item}, individual lines in the
640 @code{@@example} block should not exceed 70 columns. Each
641 additional level of @code{@@itemize} or @code{@@enumerate}
642 shortens the line by about 4 columns.
644 For long command line examples, if possible, use a trailing
645 backslash to break up a single line, indenting the next line with
646 2 spaces. If this isn't feasible, use @samp{@@smallexample
647 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
648 fontsize. Use @code{@@example} whenever possible, but if needed,
649 @code{@@smallexample} can fit up to 90 characters per line before
650 running into the PDF margin. Each additional level of
651 @code{@@itemize} or @code{@@enumerate} shortens a
652 @code{@@smallexample} line by about 5 columns.
655 @code{@@file@{@dots{}@}} --- Use for filenames and directories.
658 @code{@@option@{@dots{}@}} --- Use for options to command-line
659 commands (eg. @samp{@@option@{--format@}}).
662 @code{@@verbatim} --- Prints the block exactly as it appears in
663 the source file (including whitespace, etc.). For program code
664 examples, use @code{@@example} instead. @code{@@verbatim} uses
665 the same format as @code{@@example}.
667 Individual lines within an @code{@@verbatim} block should not
668 exceed 74 characters; otherwise they will run into the margin in
669 the PDF output, and may get clipped. If an @code{@@verbatim}
670 block is part of an @code{@@item}, individual lines in the
671 @code{@@verbatim} block should not exceed 70 columns. Each
672 additional level of @code{@@itemize} or @code{@@enumerate}
673 shortens the line by about 4 columns.
678 @unnumberedsubsubsec Indexing
682 @code{@@cindex @dots{}} --- General index. Please add as many as you can.
683 Don't capitalize the first word.
686 @code{@@funindex @dots{}} --- is for a \lilycommand.
691 @unnumberedsubsubsec Lists
695 @code{@@enumerate} --- Create an ordered list (with numbers).
696 Always put @samp{@@item} on its own line, and separate consecutive
697 items with a blank line:
710 @code{@@itemize} --- Create an unordered list (with bullets). Use
711 the same format as @code{@@enumerate}. Do not use
712 @samp{@@itemize@tie{}@@bullet}.
716 @node Special characters
717 @unnumberedsubsubsec Special characters
721 @code{--}, @code{---} --- Create an en dash (--) or an em dash
722 (---) in the text. To print two or three literal hyphens in a
723 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
727 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
728 a left curly bracket (@{), or a right curly bracket (@}).
731 @code{@@bs@{@}} --- Create a backslash within a
732 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
733 @code{@@warning@{@dots{}@}} block. This is a custom LilyPond
734 macro, not a builtin @@-command in Texinfo. Texinfo would also
735 allow @samp{\\}, but this breaks the PDF output.
738 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
739 space in the text (use @w{@samp{@@w@{ @}}} for a single
740 @emph{fixed-width} non-breaking space). Variables or numbers
741 which consist of a single character (probably followed by a
742 punctuation mark) should be tied properly, either to the previous
743 or the next word. Example: @samp{The letter@@tie@{@}@@q@{I@} is
749 @unnumberedsubsubsec Miscellany
753 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
754 @samp{@@notation@{clef@}}. Also use for specific lyrics
755 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
756 Only use once per subsection per term.
759 @code{@@q@{@dots{}@}} --- Single quotes. Used for
760 @quoteleft{}vague@quoteright{} terms. To get a backslash
761 (\), you must use @samp{@@bs@{@}}.
764 @code{@@qq@{@dots{}@}} --- Double quotes. Used for actual quotes
765 (@qq{he said}) or for introducing special input modes. To get a
766 backslash (\), you must use @samp{@@bs@{@}}.
769 @code{@@var@{@dots{}@}} --- Use for variables.
772 @code{@@version@{@}} --- Return the current LilyPond version
773 string. Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
774 line (to prevent an ugly line break in PDF); use
775 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
778 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
781 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
782 Use for important messages. To get a backslash (\), you must use
787 @node Other text concerns
788 @subsection Other text concerns
792 References must occur at the end of a sentence, for more
794 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
795 manual}. Ideally this should also be the final sentence of a
796 paragraph, but this is not required. Any link in a doc section
797 must be duplicated in the @code{@@seealso} section at the bottom.
800 Introducing examples must be done with
803 . (ie finish the previous sentence/paragaph)
804 : (ie `in this example:')
805 , (ie `may add foo with the blah construct,')
808 The old @qq{sentence runs directly into the example} method is not
812 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
822 When beginning a quote: @qq{So, he said,...}.
824 This usage is rarer. Americans often just use a comma.
827 When adding a defining example at the end of a sentence.
831 Non-ASCII characters which are in utf-8 should be directly used;
832 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}. This
833 ensures that all such characters appear in all output formats.
837 @node Documentation policy
838 @section Documentation policy
842 * Section organization::
843 * Checking cross-references::
845 * Technical writing style::
851 There are four parts to the documentation: the Learning Manual,
852 the Notation Reference, the Program Reference, and the Music
860 The LM is written in a tutorial style which introduces the most
861 important concepts, structure and syntax of the elements of a
862 LilyPond score in a carefully graded sequence of steps.
863 Explanations of all musical concepts used in the Manual can be
864 found in the Music Glossary, and readers are assumed to have no
865 prior knowledge of LilyPond. The objective is to take readers to
866 a level where the Notation Reference can be understood and
867 employed to both adapt the templates in the Appendix to their
868 needs and to begin to construct their own scores. Commonly used
869 tweaks are introduced and explained. Examples are provided
870 throughout which, while being focussed on the topic being
871 introduced, are long enough to seem real in order to retain the
872 readers' interest. Each example builds on the previous material,
873 and comments are used liberally. Every new aspect is thoroughly
874 explained before it is used.
876 Users are encouraged to read the complete Learning Manual from
881 Notation Reference: a (hopefully complete) description of LilyPond
882 input notation. Some material from here may be duplicated in the
883 Learning Manual (for teaching), but consider the NR to be the
884 "definitive" description of each notation element, with the LM
885 being an "extra". The goal is _not_ to provide a step-by-step
886 learning environment -- do not avoid using notation that has not
887 be introduced previously in the NR (for example, use \break if
888 appropriate). This section is written in formal technical writing
891 Avoid duplication. Although users are not expected to read this
892 manual from start to finish, they should be familiar with the
893 material in the Learning Manual (particularly ``Fundamental
894 Concepts''), so do not repeat that material in each section of
895 this book. Also watch out for common constructs, like ^ - _ for
896 directions -- those are explained in NR 3. In NR 1, you can
897 write: DYNAMICS may be manually placed above or below the staff,
898 see @@ref@{Controlling direction and placement@}.
900 Most tweaks should be added to LSR and not placed directly in the
901 .itely file. In some cases, tweaks may be placed in the main
902 text, but ask about this first.
904 Finally, you should assume that users know what the notation
905 means; explaining musical concepts happens in the Music Glossary.
909 Application Usage: information about using the program lilypond
910 with other programs (lilypond-book, operating systems, GUIs,
911 convert-ly, etc). This section is written in formal technical
914 Users are not expected to read this manual from start to finish.
918 Music Glossary: information about the music notation itself.
919 Explanations and translations about notation terms go here.
921 Users are not expected to read this manual from start to finish.
924 Internals Reference: not really a documentation book, since it is
925 automagically generated from the source, but this is its name.
930 @node Section organization
931 @subsection Section organization
936 The order of headings inside documentation sections should
949 You @emph{must} include a @@seealso.
953 The order of items inside the @@seealso section is
962 @@rlearning@{foozle@}.
975 @@file@{path/to/dir/blahz@}.
977 Snippets: @@rlsr@{section@}.
980 @@rinternals@{fazzle@},
981 @@rinternals@{booar@}.
985 If there are multiple entries, separate them by commas but do not
989 Always end with a period.
992 Place each link on a new line as above; this makes it much easier
993 to add or remove links. In the output, they appear on a single
996 ("Snippets" is REQUIRED; the others are optional)
999 Any new concepts or links which require an explanation should go
1000 as a full sentence(s) in the main text.
1003 Don't insert an empty line between @@seealso and the first entry!
1004 Otherwise there is excessive vertical space in the PDF output.
1009 To create links, use @@ref@{@} if the link is within the same
1013 @@predefined ... @@endpredefined is for commands in
1017 Do not include any real info in second-level sections (ie 1.1
1018 Pitches). A first-level section may have introductory material,
1019 but other than that all material goes into third-level sections
1020 (ie 1.1.1 Writing Pitches).
1025 @node Checking cross-references
1026 @subsection Checking cross-references
1028 Cross-references between different manuals are heavily used in the
1029 documentation, but they are not checked during compilation.
1030 However, if you compile the documentation, a script called
1031 check_texi_refs can help you with checking and fixing these
1032 cross-references; for information on usage, cd into a source tree
1033 where documentation has been built, cd into Documentation and run:
1040 Note that you have to find yourself the source files to fix
1041 cross-references in the generated documentation such as the
1042 Internals Reference; e.g. you can grep scm/ and lily/.
1044 @c temporary? how long will kainhofer be used? -gp
1045 Also of interest may be the linkdoc checks on kainhofer.com. Be
1046 warned that these docs are not completely rebuilt every day, so it
1047 might not accurately reflect the current state of the docs.
1050 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1054 @node General writing
1055 @subsection General writing
1060 Do not forget to create @@cindex entries for new sections of text.
1061 Enter commands with @@funindex, i.e.
1064 @@cindex pitches, writing in different octaves
1065 @@funindex \relative
1069 do not bother with the @@code@{@} (they are added automatically).
1070 These items are added to both the command index and the unified
1073 Both index commands should go in front of the actual material.
1075 @@cindex entries should not be capitalized, ie
1078 @@cindex time signature
1082 is preferred instead of @qq{Time signature}, Only use capital
1083 letters for musical terms which demand them, like D.S. al Fine.
1085 For scheme functions, only include the final part, i.e.,
1088 @@funindex modern-voice-cautionary
1090 @@funindex #(set-accidental-style modern-voice-cautionary)
1099 In general, use the American spellings. The internal lilypond
1100 property names use this spelling.
1103 List of specific terms:
1107 simultaneous NOT concurrent
1108 measure: the unit of music
1109 bar line: the symbol delimiting a measure NOT barline
1110 note head NOT notehead
1111 chord construct NOT chord (when referring to <>)
1119 @node Technical writing style
1120 @subsection Technical writing style
1122 These refer to the NR. The LM uses a more gentle, colloquial
1128 Do not refer to LilyPond in the text. The reader knows what the
1129 manual is about. If you do, capitalization is LilyPond.
1132 If you explicitly refer to @q{lilypond} the program (or any other
1133 command to be executed), write @code{@@command@{lilypond@}}.
1136 Do not explicitly refer to the reader/user. There is no one else
1137 besides the reader and the writer.
1140 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1143 Avoid abbreviations, except for commonly used abbreviations of foreign
1144 language terms such as etc. and i.e.
1147 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1151 The use of the word @q{illegal} is inappropriate in most cases.
1152 Say @q{invalid} instead.
1157 @node Tips for writing docs
1158 @section Tips for writing docs
1160 In the NR, I highly recommend focusing on one subsection at a
1161 time. For each subsection,
1166 check the mundane formatting. Are the headings (@@predefined,
1167 @@seealso, etc.) in the right order?
1170 add any appropriate index entries.
1173 check the links in the @@seealso section -- links to music
1174 glossary, internal references, and other NR sections are the main
1175 concern. Check for potential additions.
1178 move LSR-worthy material into LSR. Add the snippet, delete the
1179 material from the .itely file, and add a @@lilypondfile command.
1182 check the examples and descriptions. Do they still work?
1183 @strong{Do not} assume that the existing text is
1184 accurate/complete; some of the manual is highly out of date.
1187 is the material in the @@knownissues still accurate?
1190 can the examples be improved (made more explanatory), or is there
1191 any missing info? (feel free to ask specific questions on -user;
1192 a couple of people claimed to be interesting in being
1193 @qq{consultants} who would help with such questions)
1197 In general, I favor short text explanations with good examples --
1198 @qq{an example is worth a thousand words}. When I worked on the
1199 docs, I spent about half my time just working on those tiny
1200 lilypond examples. Making easily-understandable examples is much
1201 harder than it looks.
1204 @subsubheading Tweaks
1206 In general, any \set or \override commands should go in the
1207 @qq{select snippets} section, which means that they should go in
1208 LSR and not the .itely file. For some cases, the command
1209 obviously belongs in the @qq{main text} (i.e. not inside
1210 @@predefined or @@seealso or whatever) -- instrument names are a
1211 good example of this.
1214 \set Staff.instrumentName = #"foo"
1217 On the other side of this,
1220 \override Score.Hairpin #'after-line-breaking = ##t
1223 clearly belongs in LSR.
1225 I'm quite willing to discuss specific cases if you think that a
1226 tweaks needs to be in the main text. But items that can go into
1227 LSR are easier to maintain, so I'd like to move as much as
1228 possible into there.
1231 It would be @qq{nice} if you spent a lot of time crafting nice
1232 tweaks for users@dots{} but my recommendation is @strong{not} to do
1233 this. There's a lot of doc work to do without adding examples of
1234 tweaks. Tweak examples can easily be added by normal users by adding
1237 One place where a documentation writer can profitably spend time writing
1238 or upgrading tweaks is creating tweaks to deal with known issues. It
1239 would be ideal if every significant known issue had a workaround to avoid
1243 @ref{Adding and editing snippets}.
1246 @node Scripts to ease doc work
1247 @section Scripts to ease doc work
1249 @subheading Stripping whitespace
1251 @c TODO: should this be documented elsewhere? It's useful for
1252 @c more than just docs.
1253 To remove extra whitespace from the ends of lines, run
1256 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1260 @subheading Sectioning commands
1262 @warning{These commands add whitespace.}
1264 The emacs @code{M-x texinfo-all-menus-update} command will
1265 regenerate @@menu blocks. This can also be run with this
1266 command-line script:
1270 emacs $1 -batch -f texinfo-all-menus-update -f save-buffer
1274 (save the above as something like @command{texinfo-menus.sh}, make
1275 it executable, then run @command{texinfo-menus.sh foo.itely})
1278 @subheading Updating doc with @command{convert-ly}
1280 cd into @file{Documentation/} and run
1283 find . -name '*.itely' | xargs convert-ly -e
1287 This also updates translated documentation.
1291 @node Docstrings in scheme
1292 @section Docstrings in scheme
1294 Material in the Internals reference is generated automatically
1295 from our source code. Any doc work on Internals therefore
1296 requires modifying files in @file{scm/*.scm}. Texinfo is allowed
1297 in these docstrings.
1299 Most documentation writers never touch these, though. If you want
1300 to work on them, please ask for help.
1303 @node Translating the documentation
1304 @section Translating the documentation
1306 The mailing list @code{translations@@lilynet.net} is dedicated to
1307 LilyPond web site and documentation translation; on this list, you will
1308 get support from the Translations Meister and experimented translators,
1309 and we regularly discuss translations issues common to all languagues.
1310 All people interested in LilyPond translations are invited to subscribe
1311 to this list regardless of the amount of their contribution, by sending
1312 an email to @code{translations-request@@lilynet.net} with subject
1313 @code{subscribe} and an empty message body. Unless mentioned explicitly
1314 or except if a translations coordinator contacts you privately, you
1315 should send questions, remarks, patches to this list
1316 @code{translations@@lilynet.net}; especially note that the traffic is so
1317 high on English-speaking list @code{lilypond-user@@gnu.org} that it may
1318 take months before your request or contribution is handled if you send a
1319 email to these lists.
1322 * Getting started with documentation translation::
1323 * Documentation translation details::
1324 * Documentation translation maintenance::
1325 * Translations management policies::
1326 * Technical background::
1329 @node Getting started with documentation translation
1330 @subsection Getting started with documentation translation
1332 First, get the sources of branch @code{lilypond/translation} from the
1333 Git repository, see @ref{Starting with Git}.
1336 * Translation requirements::
1337 * Which documentation can be translated::
1338 * Starting translation in a new language::
1341 @node Translation requirements
1342 @unnumberedsubsubsec Translation requirements
1344 Working on LilyPond documentation translations requires the following
1345 pieces of software, in order to make use of dedicated helper tools:
1348 @item Python 2.4 or higher,
1354 It is not required to build LilyPond and the documentation to
1355 translate the documentation. However, if you have enough time and
1356 motivation and a suitable system, it can be very useful to build at
1357 least the documentation so that you can check the output yourself and
1358 more quickly; if you are interested, see @ref{Compiling}.
1361 @node Which documentation can be translated
1362 @unnumberedsubsubsec Which documentation can be translated
1364 The makefiles and scripts infrastructure currently supports translation
1365 of the following documentation:
1368 @item the web site, the Learning Manual, the Notation Reference and
1369 Application Usage -- Texinfo source, PDF and HTML output; Info output
1370 might be added if there is enough demand for it;
1371 @item the Changes document.
1374 Support for translating the following pieces of documentation should be
1375 added soon, by decreasing order of priority:
1378 @item automatically generated documentation: markup commands,
1379 predefined music functions;
1380 @item the Snippets List;
1381 @item the Internals Reference.
1385 @node Starting translation in a new language
1386 @unnumberedsubsubsec Starting translation in a new language
1388 At top of the source directory, do
1395 or (if you want to install your self-compiled LilyPond locally)
1398 ./autogen.sh --prefix=$HOME
1402 If you want to compile LilyPond -- which is almost required to build
1403 the documentation, but is not required to do translation only -- fix
1404 all dependencies and rerun @command{./configure} (with the same
1405 options as for @command{autogen.sh}).
1407 Then @command{cd} into @file{Documentation/} and run
1410 make ISOLANG=@var{MY-LANGUAGE} new-lang
1414 where @var{MY-LANGUAGE} is the ISO 639 language code.
1416 Finally, add a language definition for your language in
1417 @file{python/langdefs.py}.
1420 @node Documentation translation details
1421 @subsection Documentation translation details
1423 Please follow all the instructions with care to ensure quality work.
1425 All files should be encoded in UTF-8.
1428 * Files to be translated::
1429 * Translating the Web site and other Texinfo documentation::
1430 * Adding a Texinfo manual::
1433 @node Files to be translated
1434 @unnumberedsubsubsec Files to be translated
1436 @include contributor/doc-translation-list.itexi
1438 In addition, not listed above, Snippets' titles and descriptions
1439 should be translated; they are a part of the Notation Reference and
1440 therefore their priority is 5.
1442 @node Translating the Web site and other Texinfo documentation
1443 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1445 Every piece of text should be translated in the source file, except
1446 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1449 Node names are translated, but the original node name in English should
1450 be kept as the argument of @code{@@translationof} put after the section
1451 title; that is, every piece in the original file like
1455 @@@var{section_command} Bar baz
1459 should be translated as
1462 @@node @var{translation of Foo bar}
1463 @@@var{section_command} @var{translation of Bar baz}
1464 @@translationof Foo bar
1467 The argument of @code{@@rglos} commands and the first argument of
1468 @code{@@rglosnamed} commands must not be translated, as it is the node
1469 name of an entry in Music Glossary.
1471 Every time you translate a node name in a cross-reference, i.e. the
1472 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1473 @@ruser} or the first argument of their @code{@var{*}named} variants,
1474 you should make sure the target node is defined in the correct source
1475 file; if you do not intend to translate the target node right now, you
1476 should at least write the node definition (that is, the @code{@@node
1477 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1478 expected source file and define all its parent nodes; for each node you
1479 have defined this way but have not translated, insert a line that
1480 contains @code{@@untranslated}. That is, you should end up
1481 for each untranslated node with something like
1484 @@node @var{translation of Foo bar}
1485 @@@var{section_command} @var{translation of Bar baz}
1486 @@translationof Foo bar
1491 @warning{you do not have to translate the node name of a cross-reference
1492 to a node that you do not have translated. If you do, you must define
1493 an @qq{empty} node like explained just above; this will produce a
1494 cross-reference with the translated node name in output, although the
1495 target node will still be in English. On the opposite, if all
1496 cross-references that refer to an untranslated node use the node name in
1497 English, then you do not have to define such an @qq{empty} node, and the
1498 cross-reference text will appear in English in the output. The choice
1499 between these two strategies implies its particular maintenance
1500 requirements and is left to the translators, although the opinion of the
1501 Translation meister leans towards not translating these
1504 Please think of the fact that it may not make sense translating
1505 everything in some Texinfo files, and you may take distance from the
1506 original text; for instance, in the translation of the web site section
1507 Community, you may take this into account depending on what you know the
1508 community in your language is willing to support, which is possible only
1509 if you personnally assume this support, or there exists a public forum
1510 or mailing list listed in Community for LilyPond in your language:
1513 @item @rweb{Bug reports}: this page should be translated only if you
1514 know that every bug report sent on your language's mailing list or forum
1515 will be handled by someone who will translate it to English and send it
1516 on bug-lilypond or add an issue in the tracker, then translate back the
1517 reply from developers.
1519 @item @rweb{Help us}: this page should be translated very freely,
1520 and possibly not at all: ask help for contributing to LilyPond for tasks
1521 that LilyPond community in your language is able and going to handle.
1525 In any case, please mark in your work the sections which do not result
1526 from the direct translation of a piece of English translation, using
1527 comments i.e. lines starting with @q{@code{@@c}}.
1529 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1530 menus. This process should be made easier in the future, when the helper
1531 script @command{texi-langutils.py} and the makefile target are updated.
1533 Some pieces of text manipulated by build scripts that appear in the
1534 output are translated in a @file{.po} file -- just like LilyPond output
1535 messages -- in @file{Documentation/po}. The Gettext domain is named
1536 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1537 through the Free Translation Project.
1540 Take care of using typographic rules for your language, especially in
1541 @file{macros.itexi}.
1543 If you wonder whether a word, phrase or larger piece of text should be
1544 translated, whether it is an argument of a Texinfo command or a small
1545 piece sandwiched between two Texinfo commands, try to track whether and
1546 where it appears in PDF and/or HTML output as visible text. This piece
1547 of advice is especially useful for translating @file{macros.itexi}.
1549 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1550 blocs). However, some music snippets containing text that shows in
1551 the rendered music, and sometimes translating this text really helps
1552 the user to understand the documentation; in this case, and only in
1553 this case, you may as an exception translate text in the music
1554 snippet, and then you must add a line immediately before the
1555 @code{@@lilypond} block, starting with
1562 Otherwise the music snippet would be reset to the same content as the
1563 English version at next @command{make snippet-update} run -- see
1564 @ref{Updating documentation translation}.
1569 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1573 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1574 translate the @code{texidoc} header field it contains, enclose it with
1575 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1576 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}.
1577 Additionnally, you may translate the snippet's title in @code{doctitle}
1578 header field, in case @code{doctitle} is a fragment option used in
1579 @code{@@lilypondfile}; you can do this exactly the same way as
1580 @code{texidoc}. For instance,
1581 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}
1585 doctitlees = "Spanish title baz"
1587 Spanish translation blah
1592 Then, you should get these translated strings into compiled snippets in
1593 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1594 and editing snippets}.
1596 @code{@@example} blocks need not be verbatim copies, e.g. variable
1597 names, file names and comments should be translated.
1599 Finally, please carefully apply every rule exposed in @ref{Texinfo
1600 introduction and usage policy}, and @ref{Documentation policy}. If one
1601 of these rules conflicts with a rule specific to your language, please
1602 ask the Translation meister on @email{translations@@lilynet.net} list
1603 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1607 @node Adding a Texinfo manual
1608 @unnumberedsubsubsec Adding a Texinfo manual
1610 In order to start translating a new manual whose basename is @var{FOO},
1614 cd Documentation/@var{MY-LANGUAGE}
1615 cp ../@var{FOO}.tely .
1617 cp web/GNUmakefile @var{FOO}
1621 then append @var{FOO} to variable @code{SUBDIRS} in
1622 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1623 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1627 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1631 Your are now ready to translate the new manual exactly like the web site
1632 or the Learning Manual.
1635 @node Documentation translation maintenance
1636 @subsection Documentation translation maintenance
1638 Several tools have been developed to make translations maintenance
1639 easier. These helper scripts make use of the power of Git, the
1640 version control system used for LilyPond development.
1642 You should use them whenever you would like to update the translation in
1643 your language, which you may do at the frequency that fits your and your
1644 cotranslators' respective available times. In the case your translation
1645 is up-do-date (which you can discover in the first subsection below), it
1646 is enough to check its state every one or two weeks. If you feel
1647 overwhelmed by the quantity of documentation to be updated, see
1648 @ref{Maintaining without updating translations}.
1651 * Check state of translation::
1652 * Updating documentation translation::
1653 * Updating translation committishes::
1656 @macro seeCommittishesUpdate{}
1657 @warning{do not forget to update the committish in each file you have
1658 completely updated, see @ref{Updating translation committishes}.}
1661 @node Check state of translation
1662 @unnumberedsubsubsec Check state of translation
1664 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1665 unless you are sure to master the translation state checking and
1666 updating system -- then cd into @file{Documentation/} (or at top of the
1667 source tree, replace @command{make} with @command{make -C
1668 Documentation}) and run
1671 make ISOLANG=@var{MY_LANGUAGE} check-translation
1675 This presents a diff of the original files since the most recent
1676 revision of the translation. To check a single file, cd into
1677 @file{Documentation/} and run
1680 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1684 In case this file has been renamed since you last updated the
1685 translation, you should specify both old and new file names, e.g.
1686 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1688 To see only which files need to be updated, do
1691 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1694 To avoid printing terminal colors control characters, which is often
1695 desirable when you redirect output to a file, run
1698 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1701 You can see the diffs generated by the commands above as changes that
1702 you should make in your language to the existing translation, in order
1703 to make your translation up to date.
1705 @seeCommittishesUpdate
1707 Global state of the translation is recorded in
1708 @file{Documentation/translations.itexi}, which is used to generate
1709 Translations status page. To update that page, do from
1710 @file{Documentation/}
1713 make translation-status
1716 This will also leave @file{out/translations-status.txt}, which contains
1717 up-to-dateness percentages for each translated file, and update word
1718 counts of documentation files in this Guide.
1721 @ref{Maintaining without updating translations}.
1723 @node Updating documentation translation
1724 @unnumberedsubsubsec Updating documentation translation
1726 Instead of running @code{check-translation}, you may want to run
1727 @code{update-translation}, which will run your favorite text editor to
1728 update files. First, make sure environment variable @code{EDITOR} is
1729 set to a text editor command, then run from @file{Documentation/}
1732 make ISOLANG=@var{MY_LANGUAGE} update-translation
1736 or to update a single file
1739 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1742 For each file to be udpated, @code{update-translation} will open your
1743 text editor with this file and a diff of the file in English; if the
1744 diff cannot be generated or is bigger than the file in English itself,
1745 the full file in English will be opened instead.
1747 @seeCommittishesUpdate
1749 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1750 containing only the first node of the original file in English can be
1751 updated automatically: whenever @command{make check-translation} shows
1752 that such files should be updated, run from @file{Documentation/}
1755 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1758 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1759 by issuing from @file{Documentation/} or @file{Documentation/po/}
1765 @warning{if you run po-update and somebody else does the same and
1766 pushes before you push or send a patch to be applied, there will be a
1767 conflict when you pull. Therefore, it is better that only the
1768 Translation meister runs this command.}
1770 Updating music snippets can quickly become cumbersome, as most
1771 snippets should be identical in all languages. Fortunately, there is
1772 a script that can do this odd job for you (run from
1773 @file{Documentation/}):
1776 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1779 This script overwrites music snippets in
1780 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1781 @file{@var{foo/every.itely}}. It ignores skeleton files, and keeps
1782 intact music snippets preceded with a line starting with @code{@@c
1783 KEEP LY}; it reports an error for each @file{.itely} that has not the
1784 same music snippet count in both languages. Always use this script
1785 with a lot of care, i.e. run it on a clean Git working tree, and check
1786 the changes it made with @command{git diff} before committing; if you
1787 don't do so, some @code{@@lilypond} snippets might be broken or make
1788 no sense in their context.
1790 When you have updated texidocs in
1791 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
1792 changes into compiled snippets in @file{Documentation/snippets}, see
1793 @q{General guidelines} in @ref{Adding and editing snippets}.
1795 Finally, a command runs the three update processes above for all
1796 enabled languages (from @file{Documentation/}):
1799 make all-translations-update
1802 Use this command with caution, and keep in mind it will not be really
1803 useful until translations are stabilized after the end of GDP and GOP.
1806 @ref{Maintaining without updating translations},
1807 @ref{Adding and editing snippets}.
1810 @node Updating translation committishes
1811 @unnumberedsubsubsec Updating translation committishes
1813 At the beginning of each translated file except PO files, there is a
1814 committish which represents the revision of the sources which you have
1815 used to translate this file from the file in English.
1817 When you have pulled and updated a translation, it is very important to
1818 update this committish in the files you have completely updated (and
1819 only these); to do this, first commit possible changes to any
1820 documentation in English which you are sure to have done in your
1821 translation as well, then replace in the up-to-date translated files the
1822 old committish by the committish of latest commit, which can be obtained
1826 git rev-list HEAD |head -1
1829 A special case is updating Snippet documentation strings in
1830 @file{Documentation/@var{MY-LANGUAGE}/texidocs}. For these to be
1831 correctly marked as up-to-date, first run @code{makelsr.py} as
1832 explained in @ref{Adding and editing snippets}, and commit the
1833 resulting compiled snippets left in @file{Documentation/snippets/}.
1834 Say the SHA1 ID code of this commit is <C>. Now edit again your
1835 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
1836 adjusting the 40-digit committish that appears in the text to be <C>;
1837 finally, commit these updated files. Not doing so would result in
1838 changes made both to your updates and original snippets to
1839 persistently appear in the check-translation output as if they were
1842 This two-phase mechanism avoids the (practically) unsolvable problem
1843 of guessing what committish will have our update, and pretending to
1844 put this very committish on the files in the same commit.
1846 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
1847 @c contains a helper script which could be used to perform massive
1848 @c committish updates.
1854 @node Translations management policies
1855 @subsection Translations management policies
1857 These policies show the general intent of how the translations should
1858 be managed, they aim at helping translators, developers and
1859 coordinators work efficiently.
1862 * Maintaining without updating translations::
1863 * Managing documentation translation with Git::
1866 @node Maintaining without updating translations
1867 @unnumberedsubsubsec Maintaining without updating translations
1869 Keeping translations up to date under heavy changes in the documentation
1870 in English may be almost impossible, especially as during the former
1871 Grand Documentation Project (GDP) or the Grand Organization Project
1872 (GOP) when a lot of contributors brings changes. In addition,
1873 translators may be --- and that is a very good thing --- involved in
1876 it is possible --- and even recommended --- to perform some maintenance
1877 that keeps translated documentation usable and eases future translation
1878 updating. The rationale below the tasks list motivates this plan.
1880 The following tasks are listed in decreasing priority order.
1883 @item Update macros.itexi.
1884 For each obsolete macro definition, if it is possible to update macro
1885 usage in documentation with an automatic text or regexp substitution,
1886 do it and delete the macro definition from macros.itexi; otherwise,
1887 mark this macro definition as obsolete with a comment, and keep it in
1888 macros.itexi until the documentation translation has been updated and
1889 no longer uses this macro.
1891 @item Update @file{*.tely} files completely with
1892 @command{make check-translation} -- you may want to redirect ouptput
1893 to a file because of overwhelming output, or call check-translation.py
1894 on individual files, see @ref{Check state of translation}.
1896 @item In @file{.itelys}, match sections and .itely file names with those from
1897 English docs, which possibly involves moving nodes contents in block
1898 between files, without updating contents itself. In other words, the
1899 game is catching where has gone each section. In Learning manual, and
1900 in Notation Reference sections which have been revised in GDP, there may
1901 be completely new sections: in this case, copy @code{@@node} and
1902 @code{@@section}-command from English docs, and add the marker for
1903 untranslated status @code{@@untranslated} on a single line. Note that
1904 it is not possible to exactly match subsections or subsubsections of
1905 documentation in English, when contents has been deeply revised; in this
1906 case, keep obsolete (sub)subsections in the translation, marking them
1907 with a line @code{@@c obsolete} just before the node.
1909 Emacs with Texinfo mode makes this step easier:
1912 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
1913 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
1914 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
1915 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
1916 (e.g. the translated file), copy @code{*Occur*} contents into
1917 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
1919 If you happen to have installed AucTeX, you can either call the macro
1920 by doing @key{M-x texinfo-show-structure} or create a key binding in your
1921 @file{~/.emacs}, by adding the four following lines:
1924 (add-hook 'Texinfo-mode-hook
1926 (define-key Texinfo-mode-map "\C-cs"
1927 'texinfo-show-structure)))
1931 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
1934 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
1935 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
1936 updated all the rest of the file.
1938 @item Moving to next or previous node using incremental search: press
1939 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
1940 contains the word @q{node}) then press @key{C-s} to move to next node
1941 or @key{C-r} to move to previous node. Similar operation can be used
1942 to move to the next/previous section. Note that every cursor move
1943 exits incremental search, and hitting @key{C-s} twice starts
1944 incremental search with the text entered in previous incremental
1947 @item Moving a whole node (or even a sequence of nodes): jump to beginning
1948 of the node (quit incremental search by pressing an arrow), press
1949 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
1950 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
1951 the right place (moving between nodes with the previous hint is often
1952 useful) and paste with @key{C-y} or @key{C-v}.
1955 @item Update sections finished in the English documentation; check
1957 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
1959 @item Update documentation PO. It is recommended not to update
1960 strings which come from documentation that is currently deeply revised
1961 in English, to avoid doing the work more than once.
1963 @item Fix broken cross-references by running (from @file{Documentation/})
1966 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
1970 This step requires a sucessful documentation build (with @command{make
1971 doc}). Some cross-references are broken because they point to a node
1972 that exists in the documentation in English, which has not been added
1973 to the translation; in this case, do not fix the cross-reference but
1974 keep it "broken", so that the resulting HTML link will point to an
1975 existing page of documentation in English.
1978 @subsubheading Rationale
1980 You may wonder if it would not be better to leave translations as-is
1981 until you can really start updating translations. There are several
1982 reasons to do these maintenance tasks right now.
1985 @item This will have to be done sooner or later anyway, before updating
1986 translation of documentation contents, and this can already be done
1987 without needing to be redone later, as sections of documentation in
1988 English are mostly revised once. However, note that not all
1989 documentation sectioning has been revised in one go, so all this
1990 maintenance plan has to be repeated whenever a big reorganization is
1993 @item This just makes translated documentation take advantage of the new
1994 organization, which is better than the old one.
1996 @item Moving and renaming sections to match sectioning of documentation in
1997 English simplify future updating work: it allows updating the
1998 translation by side-by-side comparison, without bothering whether
1999 cross-reference names already exist in the translation.
2001 @item Each maintenance task except @q{Updating PO files} can be done by
2002 the same person for all languages, which saves overall time spent by
2003 translators to achieve this task: the node names and section titles
2004 are in English, so you can do. It is important to take advantage of
2005 this now, as it will be more complicated (but still possible) to do
2006 step 3 in all languages when documentation is compiled with
2007 @command{texi2html} and node names are directly translated in source
2012 @node Managing documentation translation with Git
2013 @unnumberedsubsubsec Managing documentation translation with Git
2015 This policy explains how to manage Git branches and commit
2016 translations to Git.
2019 @item Translation changes matching master branch are preferably made on
2020 @code{lilypond/translation} branch; they may be pushed directly to
2021 @code{master} only if they do not break compilation of LilyPond and
2022 its documentation, and in this case they should be pushed to
2023 @code{lilypond/translation} too. Similarly, changes matching
2024 @code{stable/X.Y} are preferably made on
2025 @code{lilypond/X.Ytranslation}.
2027 @item @code{lilypond/translation} Git branch may be merged into
2028 master only if LilyPond (@command{make all}) and documentation
2029 (@command{make doc}) compile succesfully.
2031 @item @code{master} Git branch may be merged into
2032 @code{lilypond/translation} whenever @command{make} and @command{make
2033 doc} are succesful (in order to ease documentation compilation by
2034 translators), or when significant changes had been made in
2035 documentation in English in master branch.
2037 @item General maintenance may be done by anybody who knows what he does
2038 in documentation in all languages, without informing translators
2039 first. General maintenance include simple text substitutions
2040 (e.g. automated by sed), compilation fixes, updating Texinfo or
2041 lilypond-book commands, updating macros, updating ly code, fixing
2042 cross-references, and operations described in @ref{Maintaining
2043 without updating translations}.
2047 @node Technical background
2048 @subsection Technical background
2050 A number of Python scripts handle a part of the documentation
2051 translation process. All scripts used to maintain the translations
2052 are located in @file{scripts/auxiliar/}.
2055 @item @file{check_translation.py} -- show diff to update a translation,
2056 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
2057 make message catalogs and Texinfo skeleton files,
2058 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2059 @item @file{update-snippets.py} -- synchronize ly snippets with those
2061 @item @file{translations-status.py} -- update translations status pages and word
2062 counts in the file you are reading,
2063 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2064 in the sources; WARNING only use this script once for each file, when support for
2065 "makeinfo --html" has been dropped.
2068 Other scripts are used in the build process, in @file{scripts/build/}:
2071 @item @file{mass-link.py} -- link or symlink files between English documentation
2072 and documentation in other languages.
2075 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
2076 not by installed Python scripts) are located in @file{python/auxiliar/}:
2078 @item @file{manuals_definitions.py} -- define manual names and name of
2079 cross-reference Texinfo macros,
2080 @item @file{buildlib.py} -- common functions (read piped output
2081 of a shell command, use Git),
2082 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
2083 tweak links in HTML pages.
2088 @item @file{python/langdefs.py} -- language definitions module