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.
65 Before undertaking any large documentation work, contributors are
66 encouraged to contact the @ref{Meisters, Documentation Meister}.
69 @node Documentation suggestions
70 @section Documentation suggestions
72 @subheading Small additions
74 For additions to the documentation,
79 Tell us where the addition should be placed. Please include both
80 the section number and title (i.e. "LM 2.13 Printing lyrics").
83 Please write exact changes to the text.
86 A formal patch to the source code is @emph{not} required; we can
87 take care of the technical details.
90 Send the suggestions to the @code{bug-lilypond} mailing list as
91 discussed in @rweb{Contact}.
94 Here is an example of a perfect documentation report:
97 To: bug-lilypond@gnu.org
98 From: helpful-user@example.net
101 In LM 2.13 (printing lyrics), above the last line ("More options,
102 like..."), please add:
105 To add lyrics to a divided part, use blah blah blah. For example,
108 \notes {blah <<blah>> }
109 \lyrics {blah <<blah>> }
114 In addition, the second sentence of the first paragraph is
115 confusing. Please delete that sentence (it begins "Users
116 often...") and replace it with this:
118 To align lyrics with something, do this thing.
128 @subheading Larger contributions
130 To replace large sections of the documentation, the guidelines are
131 stricter. We cannot remove parts of the current documentation
132 unless we are certain that the new version is an improvement.
137 Ask on the lilypond-devel mailing list if such a rewrite is necessary;
138 somebody else might already be working on this issue!
141 Split your work into small sections; this makes it much easier to
142 compare the new and old documentation.
145 Please prepare a formal git patch.
149 Once you have followed these guidelines, please send a message to
150 lilypond-devel with your documentation submissions. Unfortunately
151 there is a strict “no top-posting” check on the mailing list; to avoid
154 > I'm not top posting.
156 (you must include the > ) to the top of your documentation
159 We may edit your suggestion for spelling, grammar, or style, and
160 we may not place the material exactly where you suggested, but if
161 you give us some material to work with, we can improve the manual
162 much faster. Thanks for your interest!
165 @node Texinfo introduction and usage policy
166 @section Texinfo introduction and usage policy
169 * Texinfo introduction::
170 * Documentation files::
171 * Sectioning commands::
172 * LilyPond formatting::
175 * Other text concerns::
179 @node Texinfo introduction
180 @subsection Texinfo introduction
182 The language is called Texinfo; you can see its manual here:
184 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
186 However, you don't need to read those docs. The most important
187 thing to notice is that text is text. If you see a mistake in the
188 text, you can fix it. If you want to change the order of
189 something, you can cut-and-paste that stuff into a new location.
191 @warning{Rule of thumb: follow the examples in the existing docs.
192 You can learn most of what you need to know from this; if you want
193 to do anything fancy, discuss it on @code{lilypond-devel} first.}
196 @node Documentation files
197 @subsection Documentation files
199 All manuals live in @file{Documentation/}.
201 In particular, there are four user manuals, their respective master
202 source files are @file{learning.tely} (LM, Learning Manual),
203 @file{notation.tely} (NR, Notation Reference),
204 @file{music-glossary.tely} (MG, Music Glossary), and
205 @file{lilypond-program} (AU). Each chapter is written in a separate
206 file, ending in @file{.itely} for files containing lilypond code, and
207 @file{.itexi} for files without lilypond code, located in a subdirectory
208 associated to the manual (@file{learning/} for @file{learning.tely}, and
209 so on); list the subdirectory of each manual to determine the filename
210 of the specific chapter you wish to modify.
212 Developer manuals live in @file{Documentation/} too. Currently there is
213 only one: the Contributor's Guide @file{contrib-guide.texi} you are
216 Snippet files are part of documentation, and the Snippet List (SL) lives
217 in @file{Documentation/} just like the manuals. For information about
218 how to modify the snippet files and SL, see @ref{LSR work}.
221 @node Sectioning commands
222 @subsection Sectioning commands
224 Most of the manual operates at the
232 level. Sections are created with
241 Please leave two blank lines above a @code{@@node}; this makes it
242 easier to find sections in texinfo.
245 Do not use any @code{@@} commands for a @code{@@node}. They may be
246 used for any @code{@@sub...} sections or headings however.
250 @@node @@code@{Foo@} Bar
251 @@subsection @@code@{Foo@} Bar
255 @@subsection @@code@{Foo@} Bar
259 With the exception of @code{@@} commands, the section name must
260 match the node name exactly.
263 No commas may be used in the node names.
266 If a heading is desired without creating a @code{@@node}, please use
274 Sectioning commands (@code{@@node} and @code{@@section}) must not appear
275 inside an @code{@@ignore}. Separate those commands with a space, ie
276 @code{@@n}@tie{}@code{ode}.
280 Nodes must be included inside a
290 construct. These are easily constructed with automatic tools; see
291 @ref{Scripts to ease doc work}.
294 @node LilyPond formatting
295 @subsection LilyPond formatting
300 Most LilyPond examples throughout the documentation can be produced
304 @@lilypond[verbatim,quote,relative=1]
310 @@lilypond[verbatim,quote,relative=2]
313 If using any combination of @code{\header@{@}}, @code{\score@{@}} or
314 @code{\layout@{@}} in your example, then you must omit the
315 @code{relative} variable and either use absolute entry mode or an
316 explicit @code{\relative@{@}} construction.
318 If using @code{\book@{@}} in your example then you must also omit the
319 @code{relative} variable and either use absolute entry mode or an
320 explicit @code{\relative@{@}} construction. However, you must also
321 include the @code{papersize=X} variable, where @code{X} is a defined
322 paper size from within @file{scm/paper.scm}. This is to avoid the
323 default @code{a4} paper size being used and leaving too much unnecessary
324 whitespace and potentially awkward page breaks in the PDFs.
326 The preferred @code{papersize}s are @code{a5}, @code{a6} or
329 @code{a8landscape} works best for a single measure with a single title
330 and/or single @code{tagline}:
333 @@lilypond[papersize=a8landscape,verbatim]
336 title = "A scale in LilyPond"
345 and can also be used to easily show features that require page breaks
346 (i.e. page numbers) without taking large amounts of space within the
347 documentation. Do not use the @code{quote} option with this paper size.
349 @code{a5} or @code{a6} paper sizes are best used for examples that have
350 more than two measures of music or require multiple staves (i.e. to
351 illustrate cross-staff features, RH and LH parts etc.) and where
352 @code{\book@{@}} constructions are required or where @code{a8landscape}
353 produces an example that is too cramped. Depending on the example the
354 @code{quote} option may need to be omitted.
356 In rare cases, other options may be used (or omitted), but ask first.
359 Please avoid using extra spacing either after or within the
360 @code{@@lilypond} parameters.
363 not: @@lilypond [verbatim, quote, relative=1]
364 but instead: @@lilypond[verbatim,quote,relative=1]
368 Inspirational headwords are produced with:
371 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
372 @{pitches-headword.ly@}
376 LSR snippets are linked with:
379 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
384 Use two spaces for indentation in lilypond examples (no tabs).
387 All engravers should have double-quotes around them:
390 \consists "Spans_arpeggio_engraver"
393 LilyPond does not strictly require this, but it is a useful
394 convention to follow.
397 All context or layout object strings should be prefaced with @code{#}.
398 Again, LilyPond does not strictly require this, but it is helpful
399 to get users accustomed to this scheme construct, i.e. @code{\set
400 Staff.instrumentName = #"cello"}
403 Try to avoid using @code{#'} or @code{#`} within when describing
404 context or layout properties outside of an @code{@@example} or @code{@@lilypond}, unless
405 the description explicitly requires it.
407 i.e. @qq{...setting the @code{transparent} property leaves the object where it
408 is, but makes it invisible.}
411 If possible, only write one bar per line.
414 If you only have one bar per line, omit bar checks. If you
415 must put more than one bar per line (not recommended), then include bar
419 Tweaks should, if possible, also occur on their own line.
421 not: \override TextScript #'padding = #3 c1^"hi"
422 but instead: \override TextScript #'padding = #3
427 excepted in Templates, where `doctitle' may be omitted.
430 Avoid long stretches of input code. Nobody is going to read
431 them in print. Create small examples. However, this does not mean
435 Specify durations for at least the first note of every bar.
438 If possible, end with a complete bar.
441 Comments should go on their own line, and be placed before
442 the line(s) to which they refer.
445 For clarity, always use @{ @} marks even if they are not technically
451 \context Voice \repeat unfold 2 \relative c' @{
467 Add a space around @{ @} marks; i.e.
470 not: \chordmode@{c e g@}
471 but instead: \chordmode @{ c e g @}
475 Use @{ @} marks for additional @code{\markup} format commands; i.e.
478 not: c^\markup \tiny\sharp
479 but instead: c^\markup @{ \tiny \sharp @}
483 Remove any space around @code{<} @code{>} marks; i.e.
487 but instead: <c e g>4
491 Beam, slur and tie marks should begin immediately after the first
492 note with beam and phrase marks ending immediately after the last.
495 a8\( ais16[ b cis( d] b) cis4~ b' cis,\)
499 If you want to work on an example outside of the manual (for
500 easier/faster processing), use this header:
505 line-width = 160\mm - 2.0 * 0.4\in
507 force-assignment = #""
508 line-width = #(- line-width (* mm 3.000000))
515 You may not change any of these values. If you are making an
516 example demonstrating special @code{\paper@{@}} values, contact the
517 Documentation Editor.
522 @node Text formatting
523 @subsection Text formatting
527 Lines should be less than 72 characters long. (We personally
528 recommend writing with 66-char lines, but do not bother modifying
529 existing material). Also see the recommendations for fixed-width
530 fonts in the @ref{Syntax survey}.
536 Do not use spaces at the beginning of a line (except in
537 @code{@@example} or @code{@@verbatim} environments), and do not
538 use more than a single space between words. @q{makeinfo} copies
539 the input lines verbatim without removing those spaces.
542 Use two spaces after a period.
545 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
549 Don't use @code{@@rinternals@{@}} in the main text. If you're
550 tempted to do so, you're probably getting too close to @qq{talking
551 through the code}. If you really want to refer to a context, use
552 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
553 the @code{@@seealso}.
558 @subsection Syntax survey
568 * Special characters::
574 @unnumberedsubsubsec Comments
578 @code{@@c @dots{}} --- single line comment. @samp{@@c NOTE:} is a
579 comment which should remain in the final version. (gp only
583 @code{@@ignore} --- multi-line comment:
593 @node Cross references
594 @unnumberedsubsubsec Cross references
596 Enter the exact @code{@@node} name of the target reference between
597 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not
598 split a cross-reference across two lines -- this causes the
599 cross-reference to be rendered incorrectly in html documents.
603 @code{@@ref@{@dots{}@}} --- link within current manual.
606 @code{@@rchanges@{@dots{}@}} --- link to Changes.
609 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
612 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
615 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
618 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
621 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
624 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
627 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
630 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
633 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
636 @code{@@rweb@{@dots{}@}} --- link to General Information.
641 @unnumberedsubsubsec External links
645 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
648 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
649 external url. Use within an @code{@@example ... @@end example}.
653 @@uref@{URL [, link text ]@}
659 @node Fixed-width font
660 @unnumberedsubsubsec Fixed-width font
664 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
666 Use the @code{@@code@{@dots{}@}} command when referring to
667 individual language-specific tokens (keywords, commands,
668 engravers, scheme symbols, etc.) in the text. Ideally, a single
669 @code{@@code@{@dots{}@}} block should fit within one line in the
672 Use the @code{@@samp@{@dots{}@}} command when you have a short
673 example of user input, unless it constitutes an entire
674 @code{@@item} by itself, in which case @code{@@code@{@dots{}@}} is
675 preferable. Otherwise, both should only be used when part of a
676 larger sentence within a paragraph or @code{@@item}. Do not use
677 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} inside an
678 @code{@@example} block, and do not use either as a free-standing
679 paragraph; use @code{@@example} instead.
681 A single unindented line in the PDF has space for about 79
682 fixed-width characters (76 if indented). Within an @code{@@item}
683 there is space for about 75 fixed-width characters. Each
684 additional level of @code{@@itemize} or @code{@@enumerate}
685 shortens the line by about 4 columns.
687 However, even short blocks of @code{@@code@{@dots{}@}} and
688 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
689 line-breaking algorithm gets confused. Additionally, blocks that
690 are longer than this may in fact print nicely; it all depends
691 where the line breaks end up. If you compile the docs yourself,
692 check the PDF output to make sure the line breaks are
695 The Texinfo setting @code{@@allowcodebreaks} is set to
696 @code{false} in the manuals, so lines within
697 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
698 only break at spaces, not at hyphens or underscores. If the block
699 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
700 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
702 The Texinfo settings @code{txicodequoteundirected} and
703 @code{txicodequotebacktick} are both set in the manuals, so
704 backticks (@code{`}) and apostrophes (@code{'}) placed within
705 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
706 are not converted to left- and right-angled quotes
707 (@code{@quoteleft{} @quoteright{}}) as they normally are within
708 the text, so the apostrophes in
709 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
710 correctly. However, these settings do not affect the PDF output
711 for anything within a @code{@@samp} block (even if it includes a
712 nested @code{@@code} block), so entering
713 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
714 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
715 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
716 which contains backticks or apostrophes, you should instead use
717 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
718 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
719 contains spaces). Note that backslashes within
720 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
721 so the example above would be coded as
722 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
725 @code{@@command@{@dots{}@}} --- Use when referring to command-line
726 commands within the text (eg. @samp{@@command@{convert-ly@}}). Do
727 not use inside an @code{@@example} block.
730 @code{@@example} --- Use for examples of program code. Do not add
731 extraneous indentation (i.e. don't start every line with
732 whitespace). Use the following layout (notice the use of blank
733 lines). Omit the @code{@@noindent} if the text following the
734 example starts a new paragraph:
737 @var{@dots{}text leading into the example@dots{}}
744 @var{continuation of the text@dots{}}
747 Individual lines within an @code{@@example} block should not
748 exceed 74 characters; otherwise they will run into the margin in
749 the PDF output, and may get clipped. If an @code{@@example} block
750 is part of an @code{@@item}, individual lines in the
751 @code{@@example} block should not exceed 70 columns. Each
752 additional level of @code{@@itemize} or @code{@@enumerate}
753 shortens the line by about 4 columns.
755 For long command line examples, if possible, use a trailing
756 backslash to break up a single line, indenting the next line with
757 2 spaces. If this isn't feasible, use @samp{@@smallexample
758 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
759 fontsize. Use @code{@@example} whenever possible, but if needed,
760 @code{@@smallexample} can fit up to 90 characters per line before
761 running into the PDF margin. Each additional level of
762 @code{@@itemize} or @code{@@enumerate} shortens a
763 @code{@@smallexample} line by about 5 columns.
766 @code{@@file@{@dots{}@}} --- Use when referring to filenames and
767 directories in the text. Do not use inside an @code{@@example}
771 @code{@@option@{@dots{}@}} --- Use when referring to command-line
772 options in the text (eg. @samp{@@option@{--format@}}). Do not use
773 inside an @code{@@example} block.
776 @code{@@verbatim} --- Prints the block exactly as it appears in
777 the source file (including whitespace, etc.). For program code
778 examples, use @code{@@example} instead. @code{@@verbatim} uses
779 the same format as @code{@@example}.
781 Individual lines within an @code{@@verbatim} block should not
782 exceed 74 characters; otherwise they will run into the margin in
783 the PDF output, and may get clipped. If an @code{@@verbatim}
784 block is part of an @code{@@item}, individual lines in the
785 @code{@@verbatim} block should not exceed 70 columns. Each
786 additional level of @code{@@itemize} or @code{@@enumerate}
787 shortens the line by about 4 columns.
792 @unnumberedsubsubsec Indexing
796 @code{@@cindex @dots{}} --- General index. Please add as many as you can.
797 Don't capitalize the first word.
800 @code{@@funindex @dots{}} --- is for a \lilycommand.
805 @unnumberedsubsubsec Lists
809 @code{@@enumerate} --- Create an ordered list (with numbers).
810 Always put @samp{@@item} on its own line. As an exception, if all
811 the items in the list are short enough to fit on single lines, placing
812 them on the @samp{@@item} lines is also permissible. @samp{@@item}
813 and @samp{@@end@tie{}enumerate} should always be preceded by a blank
820 A long multi-line item like this one must begin
821 on a line of its own and all the other items in
822 the list must do so too.
841 @code{@@itemize} --- Create an unordered list (with bullets). Use
842 the same format as @code{@@enumerate}. Do not use
843 @samp{@@itemize@tie{}@@bullet}.
847 @node Special characters
848 @unnumberedsubsubsec Special characters
852 @code{--}, @code{---} --- Create an en dash (--) or an em dash
853 (---) in the text. To print two or three literal hyphens in a
854 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
858 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
859 a left curly bracket (@{), or a right curly bracket (@}).
862 @code{@@bs@{@}} --- Create a backslash within a
863 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
864 @code{@@warning@{@dots{}@}} block. This is a custom LilyPond
865 macro, not a builtin @@-command in Texinfo. Texinfo would also
866 allow @samp{\\}, but this breaks the PDF output.
869 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
870 space in the text (use @w{@samp{@@w@{ @}}} for a single
871 @emph{fixed-width} non-breaking space). Variables or numbers
872 which consist of a single character (probably followed by a
873 punctuation mark) should be tied properly, either to the previous
874 or the next word. Example: @samp{The letter@@tie@{@}@@q@{I@} is
880 @unnumberedsubsubsec Miscellany
884 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
885 @samp{@@notation@{clef@}}. Also use for specific lyrics
886 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
887 Only use once per subsection per term.
890 @code{@@q@{@dots{}@}} --- Single quotes. Used for
891 @quoteleft{}vague@quoteright{} terms. To get a backslash
892 (\), you must use @samp{@@bs@{@}}.
895 @code{@@qq@{@dots{}@}} --- Double quotes. Used for actual quotes
896 (@qq{he said}) or for introducing special input modes. To get a
897 backslash (\), you must use @samp{@@bs@{@}}.
900 @code{@@var@{@dots{}@}} --- Use for metasyntactic variables (such
901 as @code{@var{foo}}, @code{@var{bar}}, @code{@var{arg1}}, etc.).
902 In most cases, when the @code{@@var@{@dots{}@}} command appears in
903 the text (and not in an @code{@@example} block) it should be
904 wrapped with an appropriate texinfo code-highlighting command
905 (such as @code{@@code}, @code{@@samp}, @code{@@file},
906 @code{@@command}, etc.). For example:
907 @samp{@@code@{@@var@{foo@}@}},
908 @samp{@@file@{@@var@{myfile.ly@}@}},
909 @w{@samp{@@samp@{git checkout @@var@{branch@}@}}}, etc. This
910 improves readability in the PDF and HTML output.
913 @code{@@version@{@}} --- Return the current LilyPond version
914 string. Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
915 line (to prevent an ugly line break in PDF); use
916 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
919 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
922 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
923 Use for important messages. To get a backslash (\), you must use
928 @node Other text concerns
929 @subsection Other text concerns
933 References must occur at the end of a sentence, for more
935 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
936 manual}. Ideally this should also be the final sentence of a
937 paragraph, but this is not required. Any link in a doc section
938 must be duplicated in the @code{@@seealso} section at the bottom.
941 Introducing examples must be done with
944 . (i.e. finish the previous sentence/paragraph)
945 : (i.e. `in this example:')
946 , (i.e. `may add foo with the blah construct,')
949 The old @qq{sentence runs directly into the example} method is not
953 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
963 When beginning a quote: @qq{So, he said,...}.
965 This usage is rarer. Americans often just use a comma.
968 When adding a defining example at the end of a sentence.
972 Non-ASCII characters which are in utf-8 should be directly used;
973 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}. This
974 ensures that all such characters appear in all output formats.
978 @node Documentation policy
979 @section Documentation policy
983 * Section organization::
984 * Checking cross-references::
986 * Technical writing style::
992 There are four parts to the documentation: the Learning Manual,
993 the Notation Reference, the Program Reference, and the Music
1001 The LM is written in a tutorial style which introduces the most
1002 important concepts, structure and syntax of the elements of a
1003 LilyPond score in a carefully graded sequence of steps.
1004 Explanations of all musical concepts used in the Manual can be
1005 found in the Music Glossary, and readers are assumed to have no
1006 prior knowledge of LilyPond. The objective is to take readers to
1007 a level where the Notation Reference can be understood and
1008 employed to both adapt the templates in the Appendix to their
1009 needs and to begin to construct their own scores. Commonly used
1010 tweaks are introduced and explained. Examples are provided
1011 throughout which, while being focussed on the topic being
1012 introduced, are long enough to seem real in order to retain the
1013 readers' interest. Each example builds on the previous material,
1014 and comments are used liberally. Every new aspect is thoroughly
1015 explained before it is used.
1017 Users are encouraged to read the complete Learning Manual from
1022 Notation Reference: a (hopefully complete) description of LilyPond
1023 input notation. Some material from here may be duplicated in the
1024 Learning Manual (for teaching), but consider the NR to be the
1025 "definitive" description of each notation element, with the LM
1026 being an "extra". The goal is _not_ to provide a step-by-step
1027 learning environment -- do not avoid using notation that has not
1028 be introduced previously in the NR (for example, use \break if
1029 appropriate). This section is written in formal technical writing
1032 Avoid duplication. Although users are not expected to read this
1033 manual from start to finish, they should be familiar with the
1034 material in the Learning Manual (particularly ``Fundamental
1035 Concepts''), so do not repeat that material in each section of
1036 this book. Also watch out for common constructs, like ^ - _ for
1037 directions -- those are explained in NR 3. In NR 1, you can
1038 write: DYNAMICS may be manually placed above or below the staff,
1039 see @@ref@{Controlling direction and placement@}.
1041 Most tweaks should be added to LSR and not placed directly in the
1042 @file{.itely} file. In some cases, tweaks may be placed in the main
1043 text, but ask about this first.
1045 Finally, you should assume that users know what the notation
1046 means; explaining musical concepts happens in the Music Glossary.
1050 Application Usage: information about using the program lilypond
1051 with other programs (lilypond-book, operating systems, GUIs,
1052 convert-ly, etc). This section is written in formal technical
1055 Users are not expected to read this manual from start to finish.
1059 Music Glossary: information about the music notation itself.
1060 Explanations and translations about notation terms go here.
1062 Users are not expected to read this manual from start to finish.
1065 Internals Reference: not really a documentation book, since it is
1066 automagically generated from the source, but this is its name.
1071 @node Section organization
1072 @subsection Section organization
1077 The order of headings inside documentation sections should
1090 You @emph{must} include a @@seealso.
1094 The order of items inside the @@seealso section is
1103 @@rlearning@{foozle@}.
1112 Essay on automated music engraving:
1119 @@file@{path/to/dir/blahz@}.
1121 Snippets: @@rlsr@{section@}.
1123 Internals Reference:
1124 @@rinternals@{fazzle@},
1125 @@rinternals@{booar@}.
1129 If there are multiple entries, separate them by commas but do not
1133 Always end with a period.
1136 Place each link on a new line as above; this makes it much easier
1137 to add or remove links. In the output, they appear on a single
1140 ("Snippets" is REQUIRED; the others are optional)
1143 Any new concepts or links which require an explanation should go
1144 as a full sentence(s) in the main text.
1147 Don't insert an empty line between @@seealso and the first entry!
1148 Otherwise there is excessive vertical space in the PDF output.
1153 To create links, use @@ref@{@} if the link is within the same
1157 @@predefined ... @@endpredefined is for commands in
1161 Do not include any real info in second-level sections (i.e. 1.1
1162 Pitches). A first-level section may have introductory material,
1163 but other than that all material goes into third-level sections
1164 (i.e. 1.1.1 Writing Pitches).
1167 The @@knownissues should not discuss any issues that are in the
1168 tracker, unless the issue is Priority-Postponed. The goal is to
1169 discuss any overall architecture or syntax decisions which may be
1170 interpreted as bugs. Normal bugs should not be discussed here,
1171 because we have so many bugs that it would be a huge task to keep
1172 the @@knownissues current and accurate all the time.
1177 @node Checking cross-references
1178 @subsection Checking cross-references
1180 Cross-references between different manuals are heavily used in the
1181 documentation, but they are not checked during compilation.
1182 However, if you compile the documentation, a script called
1183 check_texi_refs can help you with checking and fixing these
1184 cross-references; for information on usage, cd into a source tree
1185 where documentation has been built, cd into Documentation and run:
1192 Note that you have to find yourself the source files to fix
1193 cross-references in the generated documentation such as the
1194 Internals Reference; e.g. you can grep scm/ and lily/.
1196 @c temporary? how long will kainhofer be used? -gp
1197 Also of interest may be the linkdoc checks on kainhofer.com. Be
1198 warned that these docs are not completely rebuilt every day, so it
1199 might not accurately reflect the current state of the docs.
1202 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1206 @node General writing
1207 @subsection General writing
1212 Do not forget to create @@cindex entries for new sections of text.
1213 Enter commands with @@funindex, i.e.
1216 @@cindex pitches, writing in different octaves
1217 @@funindex \relative
1221 Do not bother with the @@code@{@} (they are added automatically).
1222 These items are added to both the command index and the unified
1223 index. Both index commands should go in front of the actual material.
1226 @@cindex entries should not be capitalized, i.e.
1229 @@cindex time signature
1233 is preferred instead of @qq{Time signature}. Only use capital
1234 letters for musical terms which demand them, e.g.
1238 For scheme function index entries, only include the final part, i.e.
1241 @@funindex modern-voice-cautionary
1243 @@funindex #(set-accidental-style modern-voice-cautionary)
1247 Use American spelling. LilyPond's internal property
1248 names use this convention.
1251 Here is a list of preferred terms to be used:
1255 @emph{Simultaneous} NOT concurrent.
1258 @emph{Measure}: the unit of music.
1261 @emph{Bar line}: the symbol delimiting a measure NOT barline.
1264 @emph{Note head} NOT notehead.
1267 @emph{Chord construct} NOT just chord (when referring to < ... >)
1270 @emph{Staff} NOT stave.
1273 @emph{Staves} NOT Staffs:
1275 @q{multiple @@internalsref@{Staff@}s}
1276 should be rephrased to
1277 @q{multiple @@internalsref@{Staff@} contexts}.
1285 @node Technical writing style
1286 @subsection Technical writing style
1288 These refer to the NR. The LM uses a more gentle, colloquial
1294 Do not refer to LilyPond in the text. The reader knows what the
1295 manual is about. If you do, capitalization is LilyPond.
1298 If you explicitly refer to @q{lilypond} the program (or any other
1299 command to be executed), write @code{@@command@{lilypond@}}.
1302 Do not explicitly refer to the reader/user. There is no one else
1303 besides the reader and the writer.
1306 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1309 Avoid abbreviations, except for commonly used abbreviations of foreign
1310 language terms such as etc. and i.e.
1313 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1317 The use of the word @q{illegal} is inappropriate in most cases.
1318 Say @q{invalid} instead.
1323 @node Tips for writing docs
1324 @section Tips for writing docs
1326 In the NR, I highly recommend focusing on one subsection at a
1327 time. For each subsection,
1332 check the mundane formatting. Are the headings (@@predefined,
1333 @@seealso, etc.) in the right order?
1336 add any appropriate index entries.
1339 check the links in the @@seealso section -- links to music
1340 glossary, internal references, and other NR sections are the main
1341 concern. Check for potential additions.
1344 move LSR-worthy material into LSR. Add the snippet, delete the
1345 material from the @file{.itely} file, and add a @@lilypondfile command.
1348 check the examples and descriptions. Do they still work?
1349 @strong{Do not} assume that the existing text is
1350 accurate/complete; some of the manual is highly out of date.
1353 is the material in the @@knownissues still accurate?
1356 can the examples be improved (made more explanatory), or is there
1357 any missing info? (feel free to ask specific questions on -user;
1358 a couple of people claimed to be interesting in being
1359 @qq{consultants} who would help with such questions)
1363 In general, I favor short text explanations with good examples --
1364 @qq{an example is worth a thousand words}. When I worked on the
1365 docs, I spent about half my time just working on those tiny
1366 lilypond examples. Making easily-understandable examples is much
1367 harder than it looks.
1370 @subsubheading Tweaks
1372 In general, any \set or \override commands should go in the
1373 @qq{select snippets} section, which means that they should go in
1374 LSR and not the @file{.itely} file. For some cases, the command
1375 obviously belongs in the @qq{main text} (i.e. not inside
1376 @@predefined or @@seealso or whatever) -- instrument names are a
1377 good example of this.
1380 \set Staff.instrumentName = #"foo"
1383 On the other side of this,
1386 \override Score.Hairpin #'after-line-breaking = ##t
1389 clearly belongs in LSR.
1391 I'm quite willing to discuss specific cases if you think that a
1392 tweaks needs to be in the main text. But items that can go into
1393 LSR are easier to maintain, so I'd like to move as much as
1394 possible into there.
1397 It would be @qq{nice} if you spent a lot of time crafting nice
1398 tweaks for users@dots{} but my recommendation is @strong{not} to do
1399 this. There's a lot of doc work to do without adding examples of
1400 tweaks. Tweak examples can easily be added by normal users by adding
1403 One place where a documentation writer can profitably spend time writing
1404 or upgrading tweaks is creating tweaks to deal with known issues. It
1405 would be ideal if every significant known issue had a workaround to avoid
1409 @ref{Adding and editing snippets}.
1412 @node Scripts to ease doc work
1413 @section Scripts to ease doc work
1415 @subheading Building only one section of the documentation
1417 In order to save build time, a script is available to build only
1418 one section of the documentation in English with a default html
1421 The script is available as:
1424 scripts/auxiliar/doc-section.sh
1427 This script will require customization for your site if your
1428 LilyPond git repository is anyplace but @code{$HOME/lilypond}.
1430 Assuming that no customization is required, you can setup the
1431 single section build with:
1434 mkdir $HOME/lilypond/tempdocs
1435 cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs
1438 You can then build a section of the documentation with:
1441 scripts/auxiliar/doc-section.sh MANUAL SECTION
1445 where @code{SECTION} is the name of the file containing the section
1446 to be built, and @code{MANUAL} is replaced by the name of the directory
1447 containing the section. So, for example, to build section 1.1 of the
1448 Notation Reference, use the command:
1451 scripts/auxiliar/doc-section.sh notation pitches
1454 This script will not work for building sections of the
1455 Contributors' guide. For building sections of the Contributors'
1459 scripts/auxiliar/cg-section.sh SECTION
1463 where @code{SECTION} is the name of the file containing the sections
1464 to be built. For example, to build section 4 of the Contributors' guide,
1468 scripts/auxiliar/cg-section.sh doc-work
1471 Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
1472 for your installation.
1474 @subheading Stripping whitespace and generating menus
1476 @warning{This script assumes that the file conforms to our doc
1477 policy; a few files still need work in this regard.}
1479 To automatically regenerate @code{@@menu} portions and strip
1483 scripts/auxiliar/node-menuify.py @var{FILENAME}
1487 @subheading Stripping whitespace only
1489 @c TODO: should this be documented elsewhere? It's useful for
1490 @c more than just docs.
1491 To remove extra whitespace from the ends of lines, run
1494 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1498 @subheading Updating doc with @command{convert-ly}
1500 Don't. This should be done by programmers when they add new
1501 features. If you notice that it hasn't been done, complain to
1502 @code{lilypond-devel}.
1505 @node Docstrings in scheme
1506 @section Docstrings in scheme
1508 Material in the Internals reference is generated automatically
1509 from our source code. Any doc work on Internals therefore
1510 requires modifying files in @file{scm/*.scm}. Texinfo is allowed
1511 in these docstrings.
1513 Most documentation writers never touch these, though. If you want
1514 to work on them, please ask for help.
1517 @node Translating the documentation
1518 @section Translating the documentation
1520 The mailing list @code{translations@@lilynet.net} is dedicated to
1521 LilyPond web site and documentation translation; on this list, you will
1522 get support from the Translations Meister and experienced translators,
1523 and we regularly discuss translation issues common to all languages.
1524 All people interested in LilyPond translations are invited to subscribe
1525 to this list regardless of the amount of their contribution, by sending
1526 an email to @code{translations-request@@lilynet.net} with subject
1527 @code{subscribe} and an empty message body. Unless mentioned explicitly,
1528 or except if a translations coordinator contacts you privately, you
1529 should send questions, remarks and patches to the list
1530 @code{translations@@lilynet.net}. Please note that traffic is high
1531 on the English-speaking list @code{lilypond-user@@gnu.org}, so it may
1532 take some time before your request or contribution is handled.
1535 * Getting started with documentation translation::
1536 * Documentation translation details::
1537 * Documentation translation maintenance::
1538 * Translations management policies::
1539 * Technical background::
1542 @node Getting started with documentation translation
1543 @subsection Getting started with documentation translation
1545 First, get the sources of branch @code{lilypond/translation} from the
1546 Git repository, see @ref{Starting with Git}.
1549 * Translation requirements::
1550 * Which documentation can be translated::
1551 * Starting translation in a new language::
1554 @node Translation requirements
1555 @unnumberedsubsubsec Translation requirements
1557 Working on LilyPond documentation translations requires the following
1558 pieces of software, in order to make use of dedicated helper tools:
1561 @item Python 2.4 or higher,
1567 It is not required to build LilyPond and the documentation to
1568 translate the documentation. However, if you have enough time and
1569 motivation and a suitable system, it can be very useful to build at
1570 least the documentation so that you can check the output yourself and
1571 more quickly; if you are interested, see @ref{Compiling}.
1573 Before undertaking any large translation work, contributors are
1574 encouraged to contact the @ref{Meisters, Translation Meister}.
1577 @node Which documentation can be translated
1578 @unnumberedsubsubsec Which documentation can be translated
1580 The makefiles and scripts infrastructure currently supports translation
1581 of the following documentation:
1584 @item the web site, the Learning Manual, the Notation Reference and
1585 Application Usage -- Texinfo source, PDF and HTML output; Info output
1586 might be added if there is enough demand for it;
1587 @item the Changes document.
1590 Support for translating the following pieces of documentation should be
1591 added soon, by decreasing order of priority:
1594 @item automatically generated documentation: markup commands,
1595 predefined music functions;
1596 @item the Snippets List;
1597 @item the Internals Reference.
1601 @node Starting translation in a new language
1602 @unnumberedsubsubsec Starting translation in a new language
1604 At top of the source directory, do
1611 or (if you want to install your self-compiled LilyPond locally)
1614 ./autogen.sh --prefix=$HOME
1618 If you want to compile LilyPond -- which is almost required to build
1619 the documentation, but is not required to do translation only -- fix
1620 all dependencies and rerun @command{./configure} (with the same
1621 options as for @command{autogen.sh}).
1623 Then @command{cd} into @file{Documentation/} and run
1626 make ISOLANG=@var{MY-LANGUAGE} new-lang
1630 where @var{MY-LANGUAGE} is the ISO 639 language code.
1632 Finally, add a language definition for your language in
1633 @file{python/langdefs.py}.
1636 @node Documentation translation details
1637 @subsection Documentation translation details
1639 Please follow all the instructions with care to ensure quality work.
1641 All files should be encoded in UTF-8.
1644 * Files to be translated::
1645 * Translating the Web site and other Texinfo documentation::
1646 * Adding a Texinfo manual::
1649 @node Files to be translated
1650 @unnumberedsubsubsec Files to be translated
1652 @include contributor/doc-translation-list.itexi
1654 In addition, not listed above, Snippets' titles and descriptions
1655 should be translated; they are a part of the Notation Reference and
1656 therefore their priority is 5.
1658 @node Translating the Web site and other Texinfo documentation
1659 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1661 Every piece of text should be translated in the source file, except
1662 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1665 Node names are translated, but the original node name in English should
1666 be kept as the argument of @code{@@translationof} put after the section
1667 title; that is, every piece in the original file like
1671 @@@var{section_command} Bar baz
1675 should be translated as
1678 @@node @var{translation of Foo bar}
1679 @@@var{section_command} @var{translation of Bar baz}
1680 @@translationof Foo bar
1683 The argument of @code{@@rglos} commands and the first argument of
1684 @code{@@rglosnamed} commands must not be translated, as it is the node
1685 name of an entry in Music Glossary.
1687 Every time you translate a node name in a cross-reference, i.e. the
1688 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1689 @@ruser} or the first argument of their @code{@var{*}named} variants,
1690 you should make sure the target node is defined in the correct source
1691 file; if you do not intend to translate the target node right now, you
1692 should at least write the node definition (that is, the @code{@@node
1693 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1694 expected source file and define all its parent nodes; for each node you
1695 have defined this way but have not translated, insert a line that
1696 contains @code{@@untranslated}. That is, you should end up
1697 for each untranslated node with something like
1700 @@node @var{translation of Foo bar}
1701 @@@var{section_command} @var{translation of Bar baz}
1702 @@translationof Foo bar
1707 @warning{you do not have to translate the node name of a cross-reference
1708 to a node that you do not have translated. If you do, you must define
1709 an @qq{empty} node like explained just above; this will produce a
1710 cross-reference with the translated node name in output, although the
1711 target node will still be in English. On the opposite, if all
1712 cross-references that refer to an untranslated node use the node name in
1713 English, then you do not have to define such an @qq{empty} node, and the
1714 cross-reference text will appear in English in the output. The choice
1715 between these two strategies implies its particular maintenance
1716 requirements and is left to the translators, although the opinion of the
1717 Translation meister leans towards not translating these
1720 Please think of the fact that it may not make sense translating
1721 everything in some Texinfo files, and you may take distance from the
1722 original text; for instance, in the translation of the web site section
1723 Community, you may take this into account depending on what you know the
1724 community in your language is willing to support, which is possible only
1725 if you personally assume this support, or there exists a public forum
1726 or mailing list listed in Community for LilyPond in your language:
1729 @item @rweb{Bug reports}: this page should be translated only if you
1730 know that every bug report sent on your language's mailing list or forum
1731 will be handled by someone who will translate it to English and send it
1732 on bug-lilypond or add an issue in the tracker, then translate back the
1733 reply from developers.
1735 @item @rweb{Help us}: this page should be translated very freely,
1736 and possibly not at all: ask help for contributing to LilyPond for tasks
1737 that LilyPond community in your language is able and going to handle.
1741 In any case, please mark in your work the sections which do not result
1742 from the direct translation of a piece of English translation, using
1743 comments i.e. lines starting with @q{@code{@@c}}.
1745 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1746 menus. This process should be made easier in the future, when the helper
1747 script @command{texi-langutils.py} and the makefile target are updated.
1749 Some pieces of text manipulated by build scripts that appear in the
1750 output are translated in a @file{.po} file -- just like LilyPond output
1751 messages -- in @file{Documentation/po}. The Gettext domain is named
1752 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1753 through the Free Translation Project.
1756 Take care of using typographic rules for your language, especially in
1757 @file{macros.itexi}.
1759 If you wonder whether a word, phrase or larger piece of text should be
1760 translated, whether it is an argument of a Texinfo command or a small
1761 piece sandwiched between two Texinfo commands, try to track whether and
1762 where it appears in PDF and/or HTML output as visible text. This piece
1763 of advice is especially useful for translating @file{macros.itexi}.
1765 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1766 blocs). However, some music snippets containing text that shows in
1767 the rendered music, and sometimes translating this text really helps
1768 the user to understand the documentation; in this case, and only in
1769 this case, you may as an exception translate text in the music
1770 snippet, and then you must add a line immediately before the
1771 @code{@@lilypond} block, starting with
1778 Otherwise the music snippet would be reset to the same content as the
1779 English version at next @command{make snippet-update} run -- see
1780 @ref{Updating documentation translation}.
1785 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1789 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1790 translate the @code{texidoc} header field it contains, enclose it with
1791 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1792 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}.
1793 Additionally, you may translate the snippet's title in @code{doctitle}
1794 header field, in case @code{doctitle} is a fragment option used in
1795 @code{@@lilypondfile}; you can do this exactly the same way as
1796 @code{texidoc}. For instance,
1797 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}
1801 doctitlees = "Spanish title baz"
1803 Spanish translation blah
1808 Then, you should get these translated strings into compiled snippets in
1809 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1810 and editing snippets}.
1812 @code{@@example} blocks need not be verbatim copies, e.g. variable
1813 names, file names and comments should be translated.
1815 Finally, please carefully apply every rule exposed in @ref{Texinfo
1816 introduction and usage policy}, and @ref{Documentation policy}. If one
1817 of these rules conflicts with a rule specific to your language, please
1818 ask the Translation meister on @email{translations@@lilynet.net} list
1819 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1823 @node Adding a Texinfo manual
1824 @unnumberedsubsubsec Adding a Texinfo manual
1826 In order to start translating a new manual whose basename is @var{FOO},
1830 cd Documentation/@var{MY-LANGUAGE}
1831 cp ../@var{FOO}.tely .
1833 cp web/GNUmakefile @var{FOO}
1837 then append @var{FOO} to variable @code{SUBDIRS} in
1838 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1839 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1843 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1847 Your are now ready to translate the new manual exactly like the web site
1848 or the Learning Manual.
1851 @node Documentation translation maintenance
1852 @subsection Documentation translation maintenance
1854 Several tools have been developed to make translations maintenance
1855 easier. These helper scripts make use of the power of Git, the
1856 version control system used for LilyPond development.
1858 You should use them whenever you would like to update the translation in
1859 your language, which you may do at the frequency that fits your and your
1860 cotranslators' respective available times. In the case your translation
1861 is up-do-date (which you can discover in the first subsection below), it
1862 is enough to check its state every one or two weeks. If you feel
1863 overwhelmed by the quantity of documentation to be updated, see
1864 @ref{Maintaining without updating translations}.
1867 * Check state of translation::
1868 * Updating documentation translation::
1869 * Updating translation committishes::
1872 @macro seeCommittishesUpdate{}
1873 @warning{do not forget to update the committish in each file you have
1874 completely updated, see @ref{Updating translation committishes}.}
1877 @node Check state of translation
1878 @unnumberedsubsubsec Check state of translation
1880 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1881 unless you are sure to master the translation state checking and
1882 updating system -- then cd into @file{Documentation/} (or at top of the
1883 source tree, replace @command{make} with @command{make -C
1884 Documentation}) and run
1887 make ISOLANG=@var{MY_LANGUAGE} check-translation
1891 This presents a diff of the original files since the most recent
1892 revision of the translation. To check a single file, cd into
1893 @file{Documentation/} and run
1896 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1900 In case this file has been renamed since you last updated the
1901 translation, you should specify both old and new file names, e.g.
1902 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1904 To see only which files need to be updated, do
1907 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1910 To avoid printing terminal colors control characters, which is often
1911 desirable when you redirect output to a file, run
1914 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1917 You can see the diffs generated by the commands above as changes that
1918 you should make in your language to the existing translation, in order
1919 to make your translation up to date.
1921 @seeCommittishesUpdate
1923 Global state of the translation is recorded in
1924 @file{Documentation/translations.itexi}, which is used to generate
1925 Translations status page. To update that page, do from
1926 @file{Documentation/}
1929 make translation-status
1932 This will also leave @file{out/translations-status.txt}, which contains
1933 up-to-dateness percentages for each translated file, and update word
1934 counts of documentation files in this Guide.
1937 @ref{Maintaining without updating translations}.
1939 @node Updating documentation translation
1940 @unnumberedsubsubsec Updating documentation translation
1942 Instead of running @code{check-translation}, you may want to run
1943 @code{update-translation}, which will run your favorite text editor to
1944 update files. First, make sure environment variable @code{EDITOR} is
1945 set to a text editor command, then run from @file{Documentation/}
1948 make ISOLANG=@var{MY_LANGUAGE} update-translation
1952 or to update a single file
1955 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1958 For each file to be updated, @code{update-translation} will open your
1959 text editor with this file and a diff of the file in English; if the
1960 diff cannot be generated or is bigger than the file in English itself,
1961 the full file in English will be opened instead.
1963 @seeCommittishesUpdate
1965 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1966 containing only the first node of the original file in English can be
1967 updated automatically: whenever @command{make check-translation} shows
1968 that such files should be updated, run from @file{Documentation/}
1971 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1974 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1975 by issuing from @file{Documentation/} or @file{Documentation/po/}
1981 @warning{if you run po-update and somebody else does the same and
1982 pushes before you push or send a patch to be applied, there will be a
1983 conflict when you pull. Therefore, it is better that only the
1984 Translation meister runs this command.}
1986 Updating music snippets can quickly become cumbersome, as most
1987 snippets should be identical in all languages. Fortunately, there is
1988 a script that can do this odd job for you (run from
1989 @file{Documentation/}):
1992 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1995 This script overwrites music snippets in
1996 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1997 @file{@var{foo/every.itely}}. It ignores skeleton files, and keeps
1998 intact music snippets preceded with a line starting with @code{@@c
1999 KEEP LY}; it reports an error for each @file{.itely} that has not the
2000 same music snippet count in both languages. Always use this script
2001 with a lot of care, i.e. run it on a clean Git working tree, and check
2002 the changes it made with @command{git diff} before committing; if you
2003 don't do so, some @code{@@lilypond} snippets might be broken or make
2004 no sense in their context.
2006 When you have updated texidocs in
2007 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
2008 changes into compiled snippets in @file{Documentation/snippets}, see
2009 @q{General guidelines} in @ref{Adding and editing snippets}.
2011 Finally, a command runs the three update processes above for all
2012 enabled languages (from @file{Documentation/}):
2015 make all-translations-update
2018 Use this command with caution, and keep in mind it will not be really
2019 useful until translations are stabilized after the end of GDP and GOP.
2022 @ref{Maintaining without updating translations},
2023 @ref{Adding and editing snippets}.
2026 @node Updating translation committishes
2027 @unnumberedsubsubsec Updating translation committishes
2029 At the beginning of each translated file except PO files, there is a
2030 committish which represents the revision of the sources which you have
2031 used to translate this file from the file in English.
2033 When you have pulled and updated a translation, it is very important to
2034 update this committish in the files you have completely updated (and
2035 only these); to do this, first commit possible changes to any
2036 documentation in English which you are sure to have done in your
2037 translation as well, then replace in the up-to-date translated files the
2038 old committish by the committish of latest commit, which can be obtained
2042 git rev-list HEAD |head -1
2045 A special case is updating Snippet documentation strings in
2046 @file{Documentation/@var{MY-LANGUAGE}/texidocs}. For these to be
2047 correctly marked as up-to-date, first run @code{makelsr.py} as
2048 explained in @ref{Adding and editing snippets}, and commit the
2049 resulting compiled snippets left in @file{Documentation/snippets/}.
2050 Say the SHA1 ID code of this commit is <C>. Now edit again your
2051 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
2052 adjusting the 40-digit committish that appears in the text to be <C>;
2053 finally, commit these updated files. Not doing so would result in
2054 changes made both to your updates and original snippets to
2055 persistently appear in the check-translation output as if they were
2058 This two-phase mechanism avoids the (practically) unsolvable problem
2059 of guessing what committish will have our update, and pretending to
2060 put this very committish on the files in the same commit.
2062 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
2063 @c contains a helper script which could be used to perform massive
2064 @c committish updates.
2070 @node Translations management policies
2071 @subsection Translations management policies
2073 These policies show the general intent of how the translations should
2074 be managed, they aim at helping translators, developers and
2075 coordinators work efficiently.
2078 * Maintaining without updating translations::
2079 * Managing documentation translation with Git::
2082 @node Maintaining without updating translations
2083 @unnumberedsubsubsec Maintaining without updating translations
2085 Keeping translations up to date under heavy changes in the documentation
2086 in English may be almost impossible, especially as during the former
2087 Grand Documentation Project (GDP) or the Grand Organization Project
2088 (GOP) when a lot of contributors brings changes. In addition,
2089 translators may be --- and that is a very good thing --- involved in
2092 it is possible --- and even recommended --- to perform some maintenance
2093 that keeps translated documentation usable and eases future translation
2094 updating. The rationale below the tasks list motivates this plan.
2096 The following tasks are listed in decreasing priority order.
2099 @item Update macros.itexi.
2100 For each obsolete macro definition, if it is possible to update macro
2101 usage in documentation with an automatic text or regexp substitution,
2102 do it and delete the macro definition from @file{macros.itexi}; otherwise,
2103 mark this macro definition as obsolete with a comment, and keep it in
2104 @file{macros.itexi} until the documentation translation has been updated and
2105 no longer uses this macro.
2107 @item Update @file{*.tely} files completely with
2108 @command{make check-translation} -- you may want to redirect output
2109 to a file because of overwhelming output, or call check-translation.py
2110 on individual files, see @ref{Check state of translation}.
2112 @item In @file{.itelys}, match sections and .itely file names with those from
2113 English docs, which possibly involves moving nodes contents in block
2114 between files, without updating contents itself. In other words, the
2115 game is catching where has gone each section. In Learning manual, and
2116 in Notation Reference sections which have been revised in GDP, there may
2117 be completely new sections: in this case, copy @code{@@node} and
2118 @code{@@section}-command from English docs, and add the marker for
2119 untranslated status @code{@@untranslated} on a single line. Note that
2120 it is not possible to exactly match subsections or subsubsections of
2121 documentation in English, when contents has been deeply revised; in this
2122 case, keep obsolete (sub)subsections in the translation, marking them
2123 with a line @code{@@c obsolete} just before the node.
2125 Emacs with Texinfo mode makes this step easier:
2128 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
2129 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
2130 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
2131 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
2132 (e.g. the translated file), copy @code{*Occur*} contents into
2133 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
2135 If you happen to have installed AucTeX, you can either call the macro
2136 by doing @key{M-x texinfo-show-structure} or create a key binding in your
2137 @file{~/.emacs}, by adding the four following lines:
2140 (add-hook 'Texinfo-mode-hook
2142 (define-key Texinfo-mode-map "\C-cs"
2143 'texinfo-show-structure)))
2147 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
2150 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
2151 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
2152 updated all the rest of the file.
2154 @item Moving to next or previous node using incremental search: press
2155 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
2156 contains the word @q{node}) then press @key{C-s} to move to next node
2157 or @key{C-r} to move to previous node. Similar operation can be used
2158 to move to the next/previous section. Note that every cursor move
2159 exits incremental search, and hitting @key{C-s} twice starts
2160 incremental search with the text entered in previous incremental
2163 @item Moving a whole node (or even a sequence of nodes): jump to beginning
2164 of the node (quit incremental search by pressing an arrow), press
2165 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
2166 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
2167 the right place (moving between nodes with the previous hint is often
2168 useful) and paste with @key{C-y} or @key{C-v}.
2171 @item Update sections finished in the English documentation; check
2174 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
2177 @item Update documentation PO. It is recommended not to update
2178 strings which come from documentation that is currently deeply revised
2179 in English, to avoid doing the work more than once.
2181 @item Fix broken cross-references by running (from @file{Documentation/})
2184 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
2188 This step requires a successful documentation build (with @command{make
2189 doc}). Some cross-references are broken because they point to a node
2190 that exists in the documentation in English, which has not been added
2191 to the translation; in this case, do not fix the cross-reference but
2192 keep it "broken", so that the resulting HTML link will point to an
2193 existing page of documentation in English.
2196 @subsubheading Rationale
2198 You may wonder if it would not be better to leave translations as-is
2199 until you can really start updating translations. There are several
2200 reasons to do these maintenance tasks right now.
2203 @item This will have to be done sooner or later anyway, before updating
2204 translation of documentation contents, and this can already be done
2205 without needing to be redone later, as sections of documentation in
2206 English are mostly revised once. However, note that not all
2207 documentation sectioning has been revised in one go, so all this
2208 maintenance plan has to be repeated whenever a big reorganization is
2211 @item This just makes translated documentation take advantage of the new
2212 organization, which is better than the old one.
2214 @item Moving and renaming sections to match sectioning of documentation in
2215 English simplify future updating work: it allows updating the
2216 translation by side-by-side comparison, without bothering whether
2217 cross-reference names already exist in the translation.
2219 @item Each maintenance task except @q{Updating PO files} can be done by
2220 the same person for all languages, which saves overall time spent by
2221 translators to achieve this task: the node names and section titles
2222 are in English, so you can do. It is important to take advantage of
2223 this now, as it will be more complicated (but still possible) to do
2224 step 3 in all languages when documentation is compiled with
2225 @command{texi2html} and node names are directly translated in source
2230 @node Managing documentation translation with Git
2231 @unnumberedsubsubsec Managing documentation translation with Git
2233 This policy explains how to manage Git branches and commit
2234 translations to Git.
2237 @item Translation changes matching master branch are preferably made on
2238 @code{lilypond/translation} branch; they may be pushed directly to
2239 @code{master} only if they do not break compilation of LilyPond and
2240 its documentation, and in this case they should be pushed to
2241 @code{lilypond/translation} too. Similarly, changes matching
2242 @code{stable/X.Y} are preferably made on
2243 @code{lilypond/X.Ytranslation}.
2245 @item @code{lilypond/translation} Git branch may be merged into
2246 master only if LilyPond (@command{make all}) and documentation
2247 (@command{make doc}) compile successfully.
2249 @item @code{master} Git branch may be merged into
2250 @code{lilypond/translation} whenever @command{make} and @command{make
2251 doc} are successful (in order to ease documentation compilation by
2252 translators), or when significant changes had been made in
2253 documentation in English in master branch.
2255 @item General maintenance may be done by anybody who knows what he does
2256 in documentation in all languages, without informing translators
2257 first. General maintenance include simple text substitutions
2258 (e.g. automated by sed), compilation fixes, updating Texinfo or
2259 lilypond-book commands, updating macros, updating ly code, fixing
2260 cross-references, and operations described in @ref{Maintaining
2261 without updating translations}.
2265 @node Technical background
2266 @subsection Technical background
2268 A number of Python scripts handle a part of the documentation
2269 translation process. All scripts used to maintain the translations
2270 are located in @file{scripts/auxiliar/}.
2273 @item @file{check_translation.py} -- show diff to update a translation,
2274 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
2275 make message catalogs and Texinfo skeleton files,
2276 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2277 @item @file{update-snippets.py} -- synchronize ly snippets with those
2279 @item @file{translations-status.py} -- update translations status pages and word
2280 counts in the file you are reading,
2281 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2282 in the sources; WARNING only use this script once for each file, when support for
2283 "makeinfo --html" has been dropped.
2286 Other scripts are used in the build process, in @file{scripts/build/}:
2289 @item @file{mass-link.py} -- link or symlink files between English documentation
2290 and documentation in other languages.
2293 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
2294 not by installed Python scripts) are located in @file{python/auxiliar/}:
2296 @item @file{manuals_definitions.py} -- define manual names and name of
2297 cross-reference Texinfo macros,
2298 @item @file{buildlib.py} -- common functions (read piped output
2299 of a shell command, use Git),
2300 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
2301 tweak links in HTML pages.
2306 @item @file{python/langdefs.py} -- language definitions module