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. Here is an example of a
88 perfect documentation report:
91 To: lilypond-devel@gnu.org
92 From: helpful-user@example.net
95 In LM 2.13 (printing lyrics), above the last line ("More options,
96 like..."), please add:
99 To add lyrics to a divided part, use blah blah blah. For example,
102 \notes {blah <<blah>> }
103 \lyrics {blah <<blah>> }
108 In addition, the second sentence of the first paragraph is
109 confusing. Please delete that sentence (it begins "Users
110 often...") and replace it with this:
112 To align lyrics with something, do this thing.
122 @subheading Larger contributions
124 To replace large sections of the documentation, the guidelines are
125 stricter. We cannot remove parts of the current documentation
126 unless we are certain that the new version is an improvement.
131 Ask on the lilypond-devel mailing list if such a rewrite is necessary;
132 somebody else might already be working on this issue!
135 Split your work into small sections; this makes it much easier to
136 compare the new and old documentation.
139 Please prepare a formal git patch.
143 Once you have followed these guidelines, please send a message to
144 lilypond-devel with your documentation submissions. Unfortunately
145 there is a strict “no top-posting” check on the mailing list; to avoid
148 > I'm not top posting.
150 (you must include the > ) to the top of your documentation
153 We may edit your suggestion for spelling, grammar, or style, and
154 we may not place the material exactly where you suggested, but if
155 you give us some material to work with, we can improve the manual
156 much faster. Thanks for your interest!
159 @node Texinfo introduction and usage policy
160 @section Texinfo introduction and usage policy
163 * Texinfo introduction::
164 * Documentation files::
165 * Sectioning commands::
166 * LilyPond formatting::
169 * Other text concerns::
173 @node Texinfo introduction
174 @subsection Texinfo introduction
176 The language is called Texinfo; you can see its manual here:
178 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
180 However, you don't need to read those docs. The most important
181 thing to notice is that text is text. If you see a mistake in the
182 text, you can fix it. If you want to change the order of
183 something, you can cut-and-paste that stuff into a new location.
185 @warning{Rule of thumb: follow the examples in the existing docs.
186 You can learn most of what you need to know from this; if you want
187 to do anything fancy, discuss it on @code{lilypond-devel} first.}
190 @node Documentation files
191 @subsection Documentation files
193 All manuals live in @file{Documentation/}.
195 In particular, there are four user manuals, their respective master
196 source files are @file{learning@/.tely} (LM, Learning Manual),
197 @file{notation@/.tely} (NR, Notation Reference),
198 @file{music@/-glossary@/.tely} (MG, Music Glossary), and
199 @file{lilypond@/-program} (AU). Each chapter is written in a separate
200 file, ending in @file{.itely} for files containing lilypond code, and
201 @file{.itexi} for files without lilypond code, located in a subdirectory
202 associated to the manual (@file{learning/} for @file{learning@/.tely}, and
203 so on); list the subdirectory of each manual to determine the filename
204 of the specific chapter you wish to modify.
206 Developer manuals live in @file{Documentation/} too. Currently there is
207 only one: the Contributor's Guide @file{contrib@/-guide@/.texi} you are
210 Snippet files are part of documentation, and the Snippet List (SL) lives
211 in @file{Documentation/} just like the manuals. For information about
212 how to modify the snippet files and SL, see @ref{LSR work}.
215 @node Sectioning commands
216 @subsection Sectioning commands
218 Most of the manual operates at the
226 level. Sections are created with
235 Please leave two blank lines above a @code{@@node}; this makes it
236 easier to find sections in texinfo.
239 Do not use any @code{@@} commands for a @code{@@node}. They may be
240 used for any @code{@@sub...} sections or headings however.
244 @@node @@code@{Foo@} Bar
245 @@subsection @@code@{Foo@} Bar
249 @@subsection @@code@{Foo@} Bar
253 If a heading is desired without creating a @code{@@node}, please use
261 Sectioning commands (@code{@@node} and @code{@@section}) must not appear
262 inside an @code{@@ignore}. Separate those commands with a space, ie
263 @code{@@n}@tie{}@code{ode}.
267 Nodes must be included inside a
277 construct. These are easily constructed with automatic tools; see
278 @ref{Scripts to ease doc work}.
281 @node LilyPond formatting
282 @subsection LilyPond formatting
287 Use two spaces for indentation in lilypond examples (no tabs).
290 All engravers should have double-quotes around them:
293 \consists "Spans_arpeggio_engraver"
296 LilyPond does not strictly require this, but it is a useful
297 convention to follow.
300 All context or layout object strings should be prefaced with @code{#}.
301 Again, LilyPond does not strictly require this, but it is helpful
302 to get users accustomed to this scheme construct, i.e. @code{\set
303 Staff.instrumentName = #"cello"}
306 Try to avoid using @code{#'} or @code{#`} within when describing
307 context or layout properties outside of an @code{@@example} or @code{@@lilypond}, unless
308 the description explicitly requires it.
310 i.e. @qq{...setting the @code{transparent} property leaves the object where it
311 is, but makes it invisible.}
314 If possible, only write one bar per line.
317 If you only have one bar per line, omit bar checks. If you
318 must put more than one bar per line (not recommended), then include bar
322 Tweaks should, if possible, also occur on their own line.
324 not: \override TextScript #'padding = #3 c1^"hi"
325 but instead: \override TextScript #'padding = #3
330 Most LilyPond input should be produced with:
333 @@lilypond[verbatim,quote,relative=2]
340 @@lilypond[verbatim,quote,relative=1]
343 Please avoid using extra spacing either after or within the
344 @code{@@lilypond} parameters.
347 not: @@lilypond [verbatim, quote, relative=1]
348 but instead: @@lilypond[verbatim,quote,relative=1]
351 If you want to use @code{\layout@{@}} or define variables, use
354 @@lilypond[verbatim,quote]
357 In rare cases, other options may be used (or omitted), but ask first.
360 Inspirational headwords are produced with
363 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
364 @{pitches-headword.ly@}
368 LSR snippets are linked with
371 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
376 excepted in Templates, where `doctitle' may be omitted.
379 Avoid long stretches of input code. Nobody is going to read
380 them in print. Create small examples. However, this does not mean
384 Specify durations for at least the first note of every bar.
387 If possible, end with a complete bar.
390 Comments should go on their own line, and be placed before
391 the line(s) to which they refer.
394 For clarity, always use @{ @} marks even if they are not technically
400 \context Voice \repeat unfold 2 \relative c' @{
416 Add a space around @{ @} marks; i.e.
419 not: \chordmode@{c e g@}
420 but instead: \chordmode @{ c e g @}
424 Use @{ @} marks for additional @code{\markup} format commands; i.e.
427 not: c^\markup \tiny\sharp
428 but instead: c^\markup @{ \tiny \sharp @}
432 Remove any space around @code{<} @code{>} marks; i.e.
436 but instead: <c e g>4
440 Beam, slur and tie marks should begin immediately after the first
441 note with beam and phrase marks ending immediately after the last.
444 a8(\ ais16[ b cis( d] b) cis4~ b' cis,\)
448 If you want to work on an example outside of the manual (for
449 easier/faster processing), use this header:
454 line-width = 160\mm - 2.0 * 0.4\in
456 force-assignment = #""
457 line-width = #(- line-width (* mm 3.000000))
464 You may not change any of these values. If you are making an
465 example demonstrating special @code{\paper@{@}} values, contact the
466 Documentation Editor.
471 @node Text formatting
472 @subsection Text formatting
476 Lines should be less than 72 characters long. (We personally
477 recommend writing with 66-char lines, but do not bother modifying
478 existing material). Also see the recommendations for fixed-width
479 fonts in the @ref{Syntax survey}.
485 Do not use spaces at the beginning of a line (except in
486 @code{@@example} or @code{@@verbatim} environments), and do not
487 use more than a single space between words. @q{makeinfo} copies
488 the input lines verbatim without removing those spaces.
491 Use two spaces after a period.
494 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
498 Don't use @code{@@rinternals@{@}} in the main text. If you're
499 tempted to do so, you're probably getting too close to @qq{talking
500 through the code}. If you really want to refer to a context, use
501 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
502 the @code{@@seealso}.
507 @subsection Syntax survey
517 * Special characters::
523 @unnumberedsubsubsec Comments
527 @code{@@c @dots{}} --- single line comment. @samp{@@c NOTE:} is a
528 comment which should remain in the final version. (gp only
532 @code{@@ignore} --- multi-line comment:
542 @node Cross references
543 @unnumberedsubsubsec Cross references
545 Enter the exact @code{@@node} name of the target reference between
546 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not
547 split a cross-reference across two lines -- this causes the
548 cross-reference to be rendered incorrectly in html documents.
552 @code{@@ref@{@dots{}@}} --- link within current manual.
555 @code{@@rchanges@{@dots{}@}} --- link to Changes.
558 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
561 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
564 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
567 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
570 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
573 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
576 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
579 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
582 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
585 @code{@@rweb@{@dots{}@}} --- link to General Information.
590 @unnumberedsubsubsec External links
594 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
597 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
598 external url. Use within an @code{@@example ... @@end example}.
602 @@uref@{URL [, link text ]@}
608 @node Fixed-width font
609 @unnumberedsubsubsec Fixed-width font
613 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
615 Use the @code{@@code@{@dots{}@}} command when referring to
616 individual language-specific tokens (keywords, commands,
617 engravers, scheme symbols, etc.) in the text. Ideally, a single
618 @code{@@code@{@dots{}@}} block should fit within one line in the
621 Use the @code{@@samp@{@dots{}@}} command when you have a short
622 example of user input, unless it constitutes an entire
623 @code{@@item} by itself, in which case @code{@@code@{@dots{}@}} is
624 preferable. Otherwise, both should only be used when part of a
625 larger sentence within a paragraph or @code{@@item}. Do not use
626 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} inside an
627 @code{@@example} block, and do not use either as a free-standing
628 paragraph; use @code{@@example} instead.
630 A single unindented line in the PDF has space for about 79
631 fixed-width characters (76 if indented). Within an @code{@@item}
632 there is space for about 75 fixed-width characters. Each
633 additional level of @code{@@itemize} or @code{@@enumerate}
634 shortens the line by about 4 columns.
636 However, even short blocks of @code{@@code@{@dots{}@}} and
637 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
638 line-breaking algorithm gets confused. Additionally, blocks that
639 are longer than this may in fact print nicely; it all depends
640 where the line breaks end up. If you compile the docs yourself,
641 check the PDF output to make sure the line breaks are
644 The Texinfo setting @code{@@allowcodebreaks} is set to
645 @code{false} in the manuals, so lines within
646 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
647 only break at spaces, not at hyphens or underscores. If the block
648 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
649 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
651 The Texinfo settings @code{txicodequoteundirected} and
652 @code{txicodequotebacktick} are both set in the manuals, so
653 backticks (@code{`}) and apostrophes (@code{'}) placed within
654 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
655 are not converted to left- and right-angled quotes
656 (@code{@quoteleft{} @quoteright{}}) as they normally are within
657 the text, so the apostrophes in
658 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
659 correctly. However, these settings do not affect the PDF output
660 for anything within a @code{@@samp} block (even if it includes a
661 nested @code{@@code} block), so entering
662 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
663 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
664 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
665 which contains backticks or apostrophes, you should instead use
666 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
667 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
668 contains spaces). Note that backslashes within
669 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
670 so the example above would be coded as
671 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
674 @code{@@command@{@dots{}@}} --- Use when referring to command-line
675 commands within the text (eg. @samp{@@command@{convert-ly@}}). Do
676 not use inside an @code{@@example} block.
679 @code{@@example} --- Use for examples of program code. Do not add
680 extraneous indentation (i.e. don't start every line with
681 whitespace). Use the following layout (notice the use of blank
682 lines). Omit the @code{@@noindent} if the text following the
683 example starts a new paragraph:
686 @var{@dots{}text leading into the example@dots{}}
693 @var{continuation of the text@dots{}}
696 Individual lines within an @code{@@example} block should not
697 exceed 74 characters; otherwise they will run into the margin in
698 the PDF output, and may get clipped. If an @code{@@example} block
699 is part of an @code{@@item}, individual lines in the
700 @code{@@example} block should not exceed 70 columns. Each
701 additional level of @code{@@itemize} or @code{@@enumerate}
702 shortens the line by about 4 columns.
704 For long command line examples, if possible, use a trailing
705 backslash to break up a single line, indenting the next line with
706 2 spaces. If this isn't feasible, use @samp{@@smallexample
707 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
708 fontsize. Use @code{@@example} whenever possible, but if needed,
709 @code{@@smallexample} can fit up to 90 characters per line before
710 running into the PDF margin. Each additional level of
711 @code{@@itemize} or @code{@@enumerate} shortens a
712 @code{@@smallexample} line by about 5 columns.
715 @code{@@file@{@dots{}@}} --- Use when referring to filenames and
716 directories in the text. Do not use inside an @code{@@example}
720 @code{@@option@{@dots{}@}} --- Use when referring to command-line
721 options in the text (eg. @samp{@@option@{--format@}}). Do not use
722 inside an @code{@@example} block.
725 @code{@@verbatim} --- Prints the block exactly as it appears in
726 the source file (including whitespace, etc.). For program code
727 examples, use @code{@@example} instead. @code{@@verbatim} uses
728 the same format as @code{@@example}.
730 Individual lines within an @code{@@verbatim} block should not
731 exceed 74 characters; otherwise they will run into the margin in
732 the PDF output, and may get clipped. If an @code{@@verbatim}
733 block is part of an @code{@@item}, individual lines in the
734 @code{@@verbatim} block should not exceed 70 columns. Each
735 additional level of @code{@@itemize} or @code{@@enumerate}
736 shortens the line by about 4 columns.
741 @unnumberedsubsubsec Indexing
745 @code{@@cindex @dots{}} --- General index. Please add as many as you can.
746 Don't capitalize the first word.
749 @code{@@funindex @dots{}} --- is for a \lilycommand.
754 @unnumberedsubsubsec Lists
758 @code{@@enumerate} --- Create an ordered list (with numbers).
759 Always put @samp{@@item} on its own line. As an exception, if all
760 the items in the list are short enough to fit on single lines, placing
761 them on the @samp{@@item} lines is also permissible. @samp{@@item}
762 and @samp{@@end@tie{}enumerate} should always be preceded by a blank
769 A long multi-line item like this one must begin
770 on a line of its own and all the other items in
771 the list must do so too.
790 @code{@@itemize} --- Create an unordered list (with bullets). Use
791 the same format as @code{@@enumerate}. Do not use
792 @samp{@@itemize@tie{}@@bullet}.
796 @node Special characters
797 @unnumberedsubsubsec Special characters
801 @code{--}, @code{---} --- Create an en dash (--) or an em dash
802 (---) in the text. To print two or three literal hyphens in a
803 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
807 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
808 a left curly bracket (@{), or a right curly bracket (@}).
811 @code{@@bs@{@}} --- Create a backslash within a
812 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
813 @code{@@warning@{@dots{}@}} block. This is a custom LilyPond
814 macro, not a builtin @@-command in Texinfo. Texinfo would also
815 allow @samp{\\}, but this breaks the PDF output.
818 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
819 space in the text (use @w{@samp{@@w@{ @}}} for a single
820 @emph{fixed-width} non-breaking space). Variables or numbers
821 which consist of a single character (probably followed by a
822 punctuation mark) should be tied properly, either to the previous
823 or the next word. Example: @samp{The letter@@tie@{@}@@q@{I@} is
829 @unnumberedsubsubsec Miscellany
833 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
834 @samp{@@notation@{clef@}}. Also use for specific lyrics
835 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
836 Only use once per subsection per term.
839 @code{@@q@{@dots{}@}} --- Single quotes. Used for
840 @quoteleft{}vague@quoteright{} terms. To get a backslash
841 (\), you must use @samp{@@bs@{@}}.
844 @code{@@qq@{@dots{}@}} --- Double quotes. Used for actual quotes
845 (@qq{he said}) or for introducing special input modes. To get a
846 backslash (\), you must use @samp{@@bs@{@}}.
849 @code{@@var@{@dots{}@}} --- Use for metasyntactic variables (such
850 as @code{@var{foo}}, @code{@var{bar}}, @code{@var{arg1}}, etc.).
851 In most cases, when the @code{@@var@{@dots{}@}} command appears in
852 the text (and not in an @code{@@example} block) it should be
853 wrapped with an appropriate texinfo code-highlighting command
854 (such as @code{@@code}, @code{@@samp}, @code{@@file},
855 @code{@@command}, etc.). For example:
856 @samp{@@code@{@@var@{foo@}@}},
857 @samp{@@file@{@@var@{myfile.ly@}@}},
858 @w{@samp{@@samp@{git checkout @@var@{branch@}@}}}, etc. This
859 improves readability in the PDF and HTML output.
862 @code{@@version@{@}} --- Return the current LilyPond version
863 string. Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
864 line (to prevent an ugly line break in PDF); use
865 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
868 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
871 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
872 Use for important messages. To get a backslash (\), you must use
877 @node Other text concerns
878 @subsection Other text concerns
882 References must occur at the end of a sentence, for more
884 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
885 manual}. Ideally this should also be the final sentence of a
886 paragraph, but this is not required. Any link in a doc section
887 must be duplicated in the @code{@@seealso} section at the bottom.
890 Introducing examples must be done with
893 . (i.e. finish the previous sentence/paragraph)
894 : (i.e. `in this example:')
895 , (i.e. `may add foo with the blah construct,')
898 The old @qq{sentence runs directly into the example} method is not
902 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
912 When beginning a quote: @qq{So, he said,...}.
914 This usage is rarer. Americans often just use a comma.
917 When adding a defining example at the end of a sentence.
921 Non-ASCII characters which are in utf-8 should be directly used;
922 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}. This
923 ensures that all such characters appear in all output formats.
927 @node Documentation policy
928 @section Documentation policy
932 * Section organization::
933 * Checking cross-references::
935 * Technical writing style::
941 There are four parts to the documentation: the Learning Manual,
942 the Notation Reference, the Program Reference, and the Music
950 The LM is written in a tutorial style which introduces the most
951 important concepts, structure and syntax of the elements of a
952 LilyPond score in a carefully graded sequence of steps.
953 Explanations of all musical concepts used in the Manual can be
954 found in the Music Glossary, and readers are assumed to have no
955 prior knowledge of LilyPond. The objective is to take readers to
956 a level where the Notation Reference can be understood and
957 employed to both adapt the templates in the Appendix to their
958 needs and to begin to construct their own scores. Commonly used
959 tweaks are introduced and explained. Examples are provided
960 throughout which, while being focussed on the topic being
961 introduced, are long enough to seem real in order to retain the
962 readers' interest. Each example builds on the previous material,
963 and comments are used liberally. Every new aspect is thoroughly
964 explained before it is used.
966 Users are encouraged to read the complete Learning Manual from
971 Notation Reference: a (hopefully complete) description of LilyPond
972 input notation. Some material from here may be duplicated in the
973 Learning Manual (for teaching), but consider the NR to be the
974 "definitive" description of each notation element, with the LM
975 being an "extra". The goal is _not_ to provide a step-by-step
976 learning environment -- do not avoid using notation that has not
977 be introduced previously in the NR (for example, use \break if
978 appropriate). This section is written in formal technical writing
981 Avoid duplication. Although users are not expected to read this
982 manual from start to finish, they should be familiar with the
983 material in the Learning Manual (particularly ``Fundamental
984 Concepts''), so do not repeat that material in each section of
985 this book. Also watch out for common constructs, like ^ - _ for
986 directions -- those are explained in NR 3. In NR 1, you can
987 write: DYNAMICS may be manually placed above or below the staff,
988 see @@ref@{Controlling direction and placement@}.
990 Most tweaks should be added to LSR and not placed directly in the
991 .itely file. In some cases, tweaks may be placed in the main
992 text, but ask about this first.
994 Finally, you should assume that users know what the notation
995 means; explaining musical concepts happens in the Music Glossary.
999 Application Usage: information about using the program lilypond
1000 with other programs (lilypond-book, operating systems, GUIs,
1001 convert-ly, etc). This section is written in formal technical
1004 Users are not expected to read this manual from start to finish.
1008 Music Glossary: information about the music notation itself.
1009 Explanations and translations about notation terms go here.
1011 Users are not expected to read this manual from start to finish.
1014 Internals Reference: not really a documentation book, since it is
1015 automagically generated from the source, but this is its name.
1020 @node Section organization
1021 @subsection Section organization
1026 The order of headings inside documentation sections should
1039 You @emph{must} include a @@seealso.
1043 The order of items inside the @@seealso section is
1052 @@rlearning@{foozle@}.
1065 @@file@{path/to/dir/blahz@}.
1067 Snippets: @@rlsr@{section@}.
1069 Internals Reference:
1070 @@rinternals@{fazzle@},
1071 @@rinternals@{booar@}.
1075 If there are multiple entries, separate them by commas but do not
1079 Always end with a period.
1082 Place each link on a new line as above; this makes it much easier
1083 to add or remove links. In the output, they appear on a single
1086 ("Snippets" is REQUIRED; the others are optional)
1089 Any new concepts or links which require an explanation should go
1090 as a full sentence(s) in the main text.
1093 Don't insert an empty line between @@seealso and the first entry!
1094 Otherwise there is excessive vertical space in the PDF output.
1099 To create links, use @@ref@{@} if the link is within the same
1103 @@predefined ... @@endpredefined is for commands in
1104 @file{ly/@/*-init@/.ly}
1107 Do not include any real info in second-level sections (i.e. 1.1
1108 Pitches). A first-level section may have introductory material,
1109 but other than that all material goes into third-level sections
1110 (i.e. 1.1.1 Writing Pitches).
1113 The @@knownissues should not discuss any issues that are in the
1114 tracker, unless the issue is Priority-Postponed. The goal is to
1115 discuss any overall architecture or syntax decisions which may be
1116 interpreted as bugs. Normal bugs should not be discussed here,
1117 because we have so many bugs that it would be a huge task to keep
1118 the @@knownissues current and accurate all the time.
1123 @node Checking cross-references
1124 @subsection Checking cross-references
1126 Cross-references between different manuals are heavily used in the
1127 documentation, but they are not checked during compilation.
1128 However, if you compile the documentation, a script called
1129 check_texi_refs can help you with checking and fixing these
1130 cross-references; for information on usage, cd into a source tree
1131 where documentation has been built, cd into Documentation and run:
1138 Note that you have to find yourself the source files to fix
1139 cross-references in the generated documentation such as the
1140 Internals Reference; e.g. you can grep scm/ and lily/.
1142 @c temporary? how long will kainhofer be used? -gp
1143 Also of interest may be the linkdoc checks on kainhofer.com. Be
1144 warned that these docs are not completely rebuilt every day, so it
1145 might not accurately reflect the current state of the docs.
1148 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1152 @node General writing
1153 @subsection General writing
1158 Do not forget to create @@cindex entries for new sections of text.
1159 Enter commands with @@funindex, i.e.
1162 @@cindex pitches, writing in different octaves
1163 @@funindex \relative
1167 Do not bother with the @@code@{@} (they are added automatically).
1168 These items are added to both the command index and the unified
1169 index. Both index commands should go in front of the actual material.
1172 @@cindex entries should not be capitalized, i.e.
1175 @@cindex time signature
1179 is preferred instead of @qq{Time signature}. Only use capital
1180 letters for musical terms which demand them, e.g.
1184 For scheme function index entries, only include the final part, i.e.
1187 @@funindex modern-voice-cautionary
1189 @@funindex #(set-accidental-style modern-voice-cautionary)
1193 Use American spelling. LilyPond's internal property
1194 names use this convention.
1197 Here is a list of preferred terms to be used:
1201 @emph{Simultaneous} NOT concurrent.
1204 @emph{Measure}: the unit of music.
1207 @emph{Bar line}: the symbol delimiting a measure NOT barline.
1210 @emph{Note head} NOT notehead.
1213 @emph{Chord construct} NOT just chord (when referring to < ... >)
1216 @emph{Staff} NOT stave.
1219 @emph{Staves} NOT Staffs:
1221 @q{multiple @@internalsref@{Staff@}s}
1222 should be rephrased to
1223 @q{multiple @@internalsref@{Staff@} contexts}.
1231 @node Technical writing style
1232 @subsection Technical writing style
1234 These refer to the NR. The LM uses a more gentle, colloquial
1240 Do not refer to LilyPond in the text. The reader knows what the
1241 manual is about. If you do, capitalization is LilyPond.
1244 If you explicitly refer to @q{lilypond} the program (or any other
1245 command to be executed), write @code{@@command@{lilypond@}}.
1248 Do not explicitly refer to the reader/user. There is no one else
1249 besides the reader and the writer.
1252 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1255 Avoid abbreviations, except for commonly used abbreviations of foreign
1256 language terms such as etc. and i.e.
1259 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1263 The use of the word @q{illegal} is inappropriate in most cases.
1264 Say @q{invalid} instead.
1269 @node Tips for writing docs
1270 @section Tips for writing docs
1272 In the NR, I highly recommend focusing on one subsection at a
1273 time. For each subsection,
1278 check the mundane formatting. Are the headings (@@predefined,
1279 @@seealso, etc.) in the right order?
1282 add any appropriate index entries.
1285 check the links in the @@seealso section -- links to music
1286 glossary, internal references, and other NR sections are the main
1287 concern. Check for potential additions.
1290 move LSR-worthy material into LSR. Add the snippet, delete the
1291 material from the .itely file, and add a @@lilypondfile command.
1294 check the examples and descriptions. Do they still work?
1295 @strong{Do not} assume that the existing text is
1296 accurate/complete; some of the manual is highly out of date.
1299 is the material in the @@knownissues still accurate?
1302 can the examples be improved (made more explanatory), or is there
1303 any missing info? (feel free to ask specific questions on -user;
1304 a couple of people claimed to be interesting in being
1305 @qq{consultants} who would help with such questions)
1309 In general, I favor short text explanations with good examples --
1310 @qq{an example is worth a thousand words}. When I worked on the
1311 docs, I spent about half my time just working on those tiny
1312 lilypond examples. Making easily-understandable examples is much
1313 harder than it looks.
1316 @subsubheading Tweaks
1318 In general, any \set or \override commands should go in the
1319 @qq{select snippets} section, which means that they should go in
1320 LSR and not the .itely file. For some cases, the command
1321 obviously belongs in the @qq{main text} (i.e. not inside
1322 @@predefined or @@seealso or whatever) -- instrument names are a
1323 good example of this.
1326 \set Staff.instrumentName = #"foo"
1329 On the other side of this,
1332 \override Score.Hairpin #'after-line-breaking = ##t
1335 clearly belongs in LSR.
1337 I'm quite willing to discuss specific cases if you think that a
1338 tweaks needs to be in the main text. But items that can go into
1339 LSR are easier to maintain, so I'd like to move as much as
1340 possible into there.
1343 It would be @qq{nice} if you spent a lot of time crafting nice
1344 tweaks for users@dots{} but my recommendation is @strong{not} to do
1345 this. There's a lot of doc work to do without adding examples of
1346 tweaks. Tweak examples can easily be added by normal users by adding
1349 One place where a documentation writer can profitably spend time writing
1350 or upgrading tweaks is creating tweaks to deal with known issues. It
1351 would be ideal if every significant known issue had a workaround to avoid
1355 @ref{Adding and editing snippets}.
1358 @node Scripts to ease doc work
1359 @section Scripts to ease doc work
1361 @subheading Building only one section of the documentation
1363 In order to save build time, a script is available to build only
1364 one section of the documentation in English with a default html
1367 The script is available as:
1370 scripts/auxiliar/doc-section.sh
1373 This script will require customization for your site if your
1374 LilyPond git repository is anyplace but @code{$HOME/lilypond}.
1376 Assuming that no customization is required, you can setup the
1377 single section build with:
1380 mkdir $HOME/lilypond/tempdocs
1381 cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs
1384 You can then build a section of the documentation with:
1387 scripts/auxiliar/doc-section.sh MANUAL SECTION
1391 where @code{SECTION} is the name of the file containing the section
1392 to be built, and @code{MANUAL} is replaced by the name of the directory
1393 containing the section. So, for example, to build section 1.1 of the
1394 Notation Reference, use the command:
1397 scripts/auxiliar/doc-section.sh notation pitches
1400 This script will not work for building sections of the
1401 Contributors' guide. For building sections of the Contributors'
1405 scripts/auxiliar/cg-section.sh SECTION
1409 where @code{SECTION} is the name of the file containing the sections
1410 to be built. For example, to build section 4 of the Contributors' guide,
1414 scripts/auxiliar/cg-section.sh doc-work
1417 Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
1418 for your installation.
1420 @subheading Stripping whitespace and generating menus
1422 @warning{This script assumes that the file conforms to our doc
1423 policy; a few files still need work in this regard.}
1425 To automatically regenerate @code{@@menu} portions and strip
1429 scripts/auxiliar/node-menuify.py @var{FILENAME}
1433 @subheading Stripping whitespace only
1435 @c TODO: should this be documented elsewhere? It's useful for
1436 @c more than just docs.
1437 To remove extra whitespace from the ends of lines, run
1440 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1444 @subheading Updating doc with @command{convert-ly}
1446 Don't. This should be done by programmers when they add new
1447 features. If you notice that it hasn't been done, complain to
1448 @code{lilypond-devel}.
1451 @node Docstrings in scheme
1452 @section Docstrings in scheme
1454 Material in the Internals reference is generated automatically
1455 from our source code. Any doc work on Internals therefore
1456 requires modifying files in @file{scm/@/*.scm}. Texinfo is allowed
1457 in these docstrings.
1459 Most documentation writers never touch these, though. If you want
1460 to work on them, please ask for help.
1463 @node Translating the documentation
1464 @section Translating the documentation
1466 The mailing list @code{translations@@lilynet.net} is dedicated to
1467 LilyPond web site and documentation translation; on this list, you will
1468 get support from the Translations Meister and experienced translators,
1469 and we regularly discuss translation issues common to all languages.
1470 All people interested in LilyPond translations are invited to subscribe
1471 to this list regardless of the amount of their contribution, by sending
1472 an email to @code{translations-request@@lilynet.net} with subject
1473 @code{subscribe} and an empty message body. Unless mentioned explicitly,
1474 or except if a translations coordinator contacts you privately, you
1475 should send questions, remarks and patches to the list
1476 @code{translations@@lilynet.net}. Please note that traffic is high
1477 on the English-speaking list @code{lilypond-user@@gnu.org}, so it may
1478 take some time before your request or contribution is handled.
1481 * Getting started with documentation translation::
1482 * Documentation translation details::
1483 * Documentation translation maintenance::
1484 * Translations management policies::
1485 * Technical background::
1488 @node Getting started with documentation translation
1489 @subsection Getting started with documentation translation
1491 First, get the sources of branch @code{lilypond/translation} from the
1492 Git repository, see @ref{Starting with Git}.
1495 * Translation requirements::
1496 * Which documentation can be translated::
1497 * Starting translation in a new language::
1500 @node Translation requirements
1501 @unnumberedsubsubsec Translation requirements
1503 Working on LilyPond documentation translations requires the following
1504 pieces of software, in order to make use of dedicated helper tools:
1507 @item Python 2.4 or higher,
1513 It is not required to build LilyPond and the documentation to
1514 translate the documentation. However, if you have enough time and
1515 motivation and a suitable system, it can be very useful to build at
1516 least the documentation so that you can check the output yourself and
1517 more quickly; if you are interested, see @ref{Compiling}.
1519 Before undertaking any large translation work, contributors are
1520 encouraged to contact the @ref{Meisters, Translation Meister}.
1523 @node Which documentation can be translated
1524 @unnumberedsubsubsec Which documentation can be translated
1526 The makefiles and scripts infrastructure currently supports translation
1527 of the following documentation:
1530 @item the web site, the Learning Manual, the Notation Reference and
1531 Application Usage -- Texinfo source, PDF and HTML output; Info output
1532 might be added if there is enough demand for it;
1533 @item the Changes document.
1536 Support for translating the following pieces of documentation should be
1537 added soon, by decreasing order of priority:
1540 @item automatically generated documentation: markup commands,
1541 predefined music functions;
1542 @item the Snippets List;
1543 @item the Internals Reference.
1547 @node Starting translation in a new language
1548 @unnumberedsubsubsec Starting translation in a new language
1550 At top of the source directory, do
1557 or (if you want to install your self-compiled LilyPond locally)
1560 ./autogen.sh --prefix=$HOME
1564 If you want to compile LilyPond -- which is almost required to build
1565 the documentation, but is not required to do translation only -- fix
1566 all dependencies and rerun @command{./configure} (with the same
1567 options as for @command{autogen.sh}).
1569 Then @command{cd} into @file{Documentation/} and run
1572 make ISOLANG=@var{MY-LANGUAGE} new-lang
1576 where @var{MY-LANGUAGE} is the ISO 639 language code.
1578 Finally, add a language definition for your language in
1579 @file{python/@/langdefs@/.py}.
1582 @node Documentation translation details
1583 @subsection Documentation translation details
1585 Please follow all the instructions with care to ensure quality work.
1587 All files should be encoded in UTF-8.
1590 * Files to be translated::
1591 * Translating the Web site and other Texinfo documentation::
1592 * Adding a Texinfo manual::
1595 @node Files to be translated
1596 @unnumberedsubsubsec Files to be translated
1598 @include contributor/doc-translation-list.itexi
1600 In addition, not listed above, Snippets' titles and descriptions
1601 should be translated; they are a part of the Notation Reference and
1602 therefore their priority is 5.
1604 @node Translating the Web site and other Texinfo documentation
1605 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1607 Every piece of text should be translated in the source file, except
1608 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1611 Node names are translated, but the original node name in English should
1612 be kept as the argument of @code{@@translationof} put after the section
1613 title; that is, every piece in the original file like
1617 @@@var{section_command} Bar baz
1621 should be translated as
1624 @@node @var{translation of Foo bar}
1625 @@@var{section_command} @var{translation of Bar baz}
1626 @@translationof Foo bar
1629 The argument of @code{@@rglos} commands and the first argument of
1630 @code{@@rglosnamed} commands must not be translated, as it is the node
1631 name of an entry in Music Glossary.
1633 Every time you translate a node name in a cross-reference, i.e. the
1634 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1635 @@ruser} or the first argument of their @code{@var{*}named} variants,
1636 you should make sure the target node is defined in the correct source
1637 file; if you do not intend to translate the target node right now, you
1638 should at least write the node definition (that is, the @code{@@node
1639 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1640 expected source file and define all its parent nodes; for each node you
1641 have defined this way but have not translated, insert a line that
1642 contains @code{@@untranslated}. That is, you should end up
1643 for each untranslated node with something like
1646 @@node @var{translation of Foo bar}
1647 @@@var{section_command} @var{translation of Bar baz}
1648 @@translationof Foo bar
1653 @warning{you do not have to translate the node name of a cross-reference
1654 to a node that you do not have translated. If you do, you must define
1655 an @qq{empty} node like explained just above; this will produce a
1656 cross-reference with the translated node name in output, although the
1657 target node will still be in English. On the opposite, if all
1658 cross-references that refer to an untranslated node use the node name in
1659 English, then you do not have to define such an @qq{empty} node, and the
1660 cross-reference text will appear in English in the output. The choice
1661 between these two strategies implies its particular maintenance
1662 requirements and is left to the translators, although the opinion of the
1663 Translation meister leans towards not translating these
1666 Please think of the fact that it may not make sense translating
1667 everything in some Texinfo files, and you may take distance from the
1668 original text; for instance, in the translation of the web site section
1669 Community, you may take this into account depending on what you know the
1670 community in your language is willing to support, which is possible only
1671 if you personally assume this support, or there exists a public forum
1672 or mailing list listed in Community for LilyPond in your language:
1675 @item @rweb{Bug reports}: this page should be translated only if you
1676 know that every bug report sent on your language's mailing list or forum
1677 will be handled by someone who will translate it to English and send it
1678 on bug-lilypond or add an issue in the tracker, then translate back the
1679 reply from developers.
1681 @item @rweb{Help us}: this page should be translated very freely,
1682 and possibly not at all: ask help for contributing to LilyPond for tasks
1683 that LilyPond community in your language is able and going to handle.
1687 In any case, please mark in your work the sections which do not result
1688 from the direct translation of a piece of English translation, using
1689 comments i.e. lines starting with @q{@code{@@c}}.
1691 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1692 menus. This process should be made easier in the future, when the helper
1693 script @command{texi-langutils.py} and the makefile target are updated.
1695 Some pieces of text manipulated by build scripts that appear in the
1696 output are translated in a @file{.po} file -- just like LilyPond output
1697 messages -- in @file{Documentation/@/po}. The Gettext domain is named
1698 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1699 through the Free Translation Project.
1702 Take care of using typographic rules for your language, especially in
1703 @file{macros@/.itexi}.
1705 If you wonder whether a word, phrase or larger piece of text should be
1706 translated, whether it is an argument of a Texinfo command or a small
1707 piece sandwiched between two Texinfo commands, try to track whether and
1708 where it appears in PDF and/or HTML output as visible text. This piece
1709 of advice is especially useful for translating @file{macros@/.itexi}.
1711 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1712 blocs). However, some music snippets containing text that shows in
1713 the rendered music, and sometimes translating this text really helps
1714 the user to understand the documentation; in this case, and only in
1715 this case, you may as an exception translate text in the music
1716 snippet, and then you must add a line immediately before the
1717 @code{@@lilypond} block, starting with
1724 Otherwise the music snippet would be reset to the same content as the
1725 English version at next @command{make snippet-update} run -- see
1726 @ref{Updating documentation translation}.
1731 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1735 in the source, open @file{Documentation/@/snippets/@/@var{filename}@/.ly},
1736 translate the @code{texidoc} header field it contains, enclose it with
1737 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1738 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs/@/@var{filename}@/.texidoc}.
1739 Additionally, you may translate the snippet's title in @code{doctitle}
1740 header field, in case @code{doctitle} is a fragment option used in
1741 @code{@@lilypondfile}; you can do this exactly the same way as
1742 @code{texidoc}. For instance,
1743 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs/@/@var{filename}@/.texidoc}
1747 doctitlees = "Spanish title baz"
1749 Spanish translation blah
1754 Then, you should get these translated strings into compiled snippets in
1755 @file{Documentation/@/snippets}, see @q{General guidelines} in @ref{Adding
1756 and editing snippets}.
1758 @code{@@example} blocks need not be verbatim copies, e.g. variable
1759 names, file names and comments should be translated.
1761 Finally, please carefully apply every rule exposed in @ref{Texinfo
1762 introduction and usage policy}, and @ref{Documentation policy}. If one
1763 of these rules conflicts with a rule specific to your language, please
1764 ask the Translation meister on @email{translations@@lilynet.net} list
1765 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1769 @node Adding a Texinfo manual
1770 @unnumberedsubsubsec Adding a Texinfo manual
1772 In order to start translating a new manual whose basename is @var{FOO},
1776 cd Documentation/@var{MY-LANGUAGE}
1777 cp ../@var{FOO}.tely .
1779 cp web/GNUmakefile @var{FOO}
1783 then append @var{FOO} to variable @code{SUBDIRS} in
1784 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1785 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1789 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1793 Your are now ready to translate the new manual exactly like the web site
1794 or the Learning Manual.
1797 @node Documentation translation maintenance
1798 @subsection Documentation translation maintenance
1800 Several tools have been developed to make translations maintenance
1801 easier. These helper scripts make use of the power of Git, the
1802 version control system used for LilyPond development.
1804 You should use them whenever you would like to update the translation in
1805 your language, which you may do at the frequency that fits your and your
1806 cotranslators' respective available times. In the case your translation
1807 is up-do-date (which you can discover in the first subsection below), it
1808 is enough to check its state every one or two weeks. If you feel
1809 overwhelmed by the quantity of documentation to be updated, see
1810 @ref{Maintaining without updating translations}.
1813 * Check state of translation::
1814 * Updating documentation translation::
1815 * Updating translation committishes::
1818 @macro seeCommittishesUpdate{}
1819 @warning{do not forget to update the committish in each file you have
1820 completely updated, see @ref{Updating translation committishes}.}
1823 @node Check state of translation
1824 @unnumberedsubsubsec Check state of translation
1826 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1827 unless you are sure to master the translation state checking and
1828 updating system -- then cd into @file{Documentation/} (or at top of the
1829 source tree, replace @command{make} with @command{make -C
1830 Documentation}) and run
1833 make ISOLANG=@var{MY_LANGUAGE} check-translation
1837 This presents a diff of the original files since the most recent
1838 revision of the translation. To check a single file, cd into
1839 @file{Documentation/} and run
1842 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1846 In case this file has been renamed since you last updated the
1847 translation, you should specify both old and new file names, e.g.
1848 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1850 To see only which files need to be updated, do
1853 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1856 To avoid printing terminal colors control characters, which is often
1857 desirable when you redirect output to a file, run
1860 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1863 You can see the diffs generated by the commands above as changes that
1864 you should make in your language to the existing translation, in order
1865 to make your translation up to date.
1867 @seeCommittishesUpdate
1869 Global state of the translation is recorded in
1870 @file{Documentation/@/translations@/.itexi}, which is used to generate
1871 Translations status page. To update that page, do from
1872 @file{Documentation/}
1875 make translation-status
1878 This will also leave @file{out/@/translations@/-status@/.txt}, which contains
1879 up-to-dateness percentages for each translated file, and update word
1880 counts of documentation files in this Guide.
1883 @ref{Maintaining without updating translations}.
1885 @node Updating documentation translation
1886 @unnumberedsubsubsec Updating documentation translation
1888 Instead of running @code{check-translation}, you may want to run
1889 @code{update-translation}, which will run your favorite text editor to
1890 update files. First, make sure environment variable @code{EDITOR} is
1891 set to a text editor command, then run from @file{Documentation/}
1894 make ISOLANG=@var{MY_LANGUAGE} update-translation
1898 or to update a single file
1901 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1904 For each file to be updated, @code{update-translation} will open your
1905 text editor with this file and a diff of the file in English; if the
1906 diff cannot be generated or is bigger than the file in English itself,
1907 the full file in English will be opened instead.
1909 @seeCommittishesUpdate
1911 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1912 containing only the first node of the original file in English can be
1913 updated automatically: whenever @command{make check-translation} shows
1914 that such files should be updated, run from @file{Documentation/}
1917 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1920 @file{.po} message catalogs in @file{Documentation/@/po/} may be updated
1921 by issuing from @file{Documentation/} or @file{Documentation/@/po/}
1927 @warning{if you run po-update and somebody else does the same and
1928 pushes before you push or send a patch to be applied, there will be a
1929 conflict when you pull. Therefore, it is better that only the
1930 Translation meister runs this command.}
1932 Updating music snippets can quickly become cumbersome, as most
1933 snippets should be identical in all languages. Fortunately, there is
1934 a script that can do this odd job for you (run from
1935 @file{Documentation/}):
1938 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1941 This script overwrites music snippets in
1942 @file{@var{MY_LANGUAGE/@/foo/@/every@/.itely}} with music snippets from
1943 @file{@var{foo/@/every@/.itely}}. It ignores skeleton files, and keeps
1944 intact music snippets preceded with a line starting with @code{@@c
1945 KEEP LY}; it reports an error for each @file{.itely} that has not the
1946 same music snippet count in both languages. Always use this script
1947 with a lot of care, i.e. run it on a clean Git working tree, and check
1948 the changes it made with @command{git diff} before committing; if you
1949 don't do so, some @code{@@lilypond} snippets might be broken or make
1950 no sense in their context.
1952 When you have updated texidocs in
1953 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}, you can get these
1954 changes into compiled snippets in @file{Documentation/@/snippets}, see
1955 @q{General guidelines} in @ref{Adding and editing snippets}.
1957 Finally, a command runs the three update processes above for all
1958 enabled languages (from @file{Documentation/}):
1961 make all-translations-update
1964 Use this command with caution, and keep in mind it will not be really
1965 useful until translations are stabilized after the end of GDP and GOP.
1968 @ref{Maintaining without updating translations},
1969 @ref{Adding and editing snippets}.
1972 @node Updating translation committishes
1973 @unnumberedsubsubsec Updating translation committishes
1975 At the beginning of each translated file except PO files, there is a
1976 committish which represents the revision of the sources which you have
1977 used to translate this file from the file in English.
1979 When you have pulled and updated a translation, it is very important to
1980 update this committish in the files you have completely updated (and
1981 only these); to do this, first commit possible changes to any
1982 documentation in English which you are sure to have done in your
1983 translation as well, then replace in the up-to-date translated files the
1984 old committish by the committish of latest commit, which can be obtained
1988 git rev-list HEAD |head -1
1991 A special case is updating Snippet documentation strings in
1992 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}. For these to be
1993 correctly marked as up-to-date, first run @code{makelsr.py} as
1994 explained in @ref{Adding and editing snippets}, and commit the
1995 resulting compiled snippets left in @file{Documentation/@/snippets/}.
1996 Say the SHA1 ID code of this commit is <C>. Now edit again your
1997 translated files in @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}
1998 adjusting the 40-digit committish that appears in the text to be <C>;
1999 finally, commit these updated files. Not doing so would result in
2000 changes made both to your updates and original snippets to
2001 persistently appear in the check-translation output as if they were
2004 This two-phase mechanism avoids the (practically) unsolvable problem
2005 of guessing what committish will have our update, and pretending to
2006 put this very committish on the files in the same commit.
2008 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
2009 @c contains a helper script which could be used to perform massive
2010 @c committish updates.
2016 @node Translations management policies
2017 @subsection Translations management policies
2019 These policies show the general intent of how the translations should
2020 be managed, they aim at helping translators, developers and
2021 coordinators work efficiently.
2024 * Maintaining without updating translations::
2025 * Managing documentation translation with Git::
2028 @node Maintaining without updating translations
2029 @unnumberedsubsubsec Maintaining without updating translations
2031 Keeping translations up to date under heavy changes in the documentation
2032 in English may be almost impossible, especially as during the former
2033 Grand Documentation Project (GDP) or the Grand Organization Project
2034 (GOP) when a lot of contributors brings changes. In addition,
2035 translators may be --- and that is a very good thing --- involved in
2038 it is possible --- and even recommended --- to perform some maintenance
2039 that keeps translated documentation usable and eases future translation
2040 updating. The rationale below the tasks list motivates this plan.
2042 The following tasks are listed in decreasing priority order.
2045 @item Update macros.itexi.
2046 For each obsolete macro definition, if it is possible to update macro
2047 usage in documentation with an automatic text or regexp substitution,
2048 do it and delete the macro definition from macros.itexi; otherwise,
2049 mark this macro definition as obsolete with a comment, and keep it in
2050 macros.itexi until the documentation translation has been updated and
2051 no longer uses this macro.
2053 @item Update @file{*.tely} files completely with
2054 @command{make check-translation} -- you may want to redirect output
2055 to a file because of overwhelming output, or call check-translation.py
2056 on individual files, see @ref{Check state of translation}.
2058 @item In @file{.itelys}, match sections and .itely file names with those from
2059 English docs, which possibly involves moving nodes contents in block
2060 between files, without updating contents itself. In other words, the
2061 game is catching where has gone each section. In Learning manual, and
2062 in Notation Reference sections which have been revised in GDP, there may
2063 be completely new sections: in this case, copy @code{@@node} and
2064 @code{@@section}-command from English docs, and add the marker for
2065 untranslated status @code{@@untranslated} on a single line. Note that
2066 it is not possible to exactly match subsections or subsubsections of
2067 documentation in English, when contents has been deeply revised; in this
2068 case, keep obsolete (sub)subsections in the translation, marking them
2069 with a line @code{@@c obsolete} just before the node.
2071 Emacs with Texinfo mode makes this step easier:
2074 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
2075 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
2076 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
2077 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
2078 (e.g. the translated file), copy @code{*Occur*} contents into
2079 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
2081 If you happen to have installed AucTeX, you can either call the macro
2082 by doing @key{M-x texinfo-show-structure} or create a key binding in your
2083 @file{~/.emacs}, by adding the four following lines:
2086 (add-hook 'Texinfo-mode-hook
2088 (define-key Texinfo-mode-map "\C-cs"
2089 'texinfo-show-structure)))
2093 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
2096 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
2097 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
2098 updated all the rest of the file.
2100 @item Moving to next or previous node using incremental search: press
2101 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
2102 contains the word @q{node}) then press @key{C-s} to move to next node
2103 or @key{C-r} to move to previous node. Similar operation can be used
2104 to move to the next/previous section. Note that every cursor move
2105 exits incremental search, and hitting @key{C-s} twice starts
2106 incremental search with the text entered in previous incremental
2109 @item Moving a whole node (or even a sequence of nodes): jump to beginning
2110 of the node (quit incremental search by pressing an arrow), press
2111 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
2112 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
2113 the right place (moving between nodes with the previous hint is often
2114 useful) and paste with @key{C-y} or @key{C-v}.
2117 @item Update sections finished in the English documentation; check
2119 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
2121 @item Update documentation PO. It is recommended not to update
2122 strings which come from documentation that is currently deeply revised
2123 in English, to avoid doing the work more than once.
2125 @item Fix broken cross-references by running (from @file{Documentation/})
2128 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
2132 This step requires a successful documentation build (with @command{make
2133 doc}). Some cross-references are broken because they point to a node
2134 that exists in the documentation in English, which has not been added
2135 to the translation; in this case, do not fix the cross-reference but
2136 keep it "broken", so that the resulting HTML link will point to an
2137 existing page of documentation in English.
2140 @subsubheading Rationale
2142 You may wonder if it would not be better to leave translations as-is
2143 until you can really start updating translations. There are several
2144 reasons to do these maintenance tasks right now.
2147 @item This will have to be done sooner or later anyway, before updating
2148 translation of documentation contents, and this can already be done
2149 without needing to be redone later, as sections of documentation in
2150 English are mostly revised once. However, note that not all
2151 documentation sectioning has been revised in one go, so all this
2152 maintenance plan has to be repeated whenever a big reorganization is
2155 @item This just makes translated documentation take advantage of the new
2156 organization, which is better than the old one.
2158 @item Moving and renaming sections to match sectioning of documentation in
2159 English simplify future updating work: it allows updating the
2160 translation by side-by-side comparison, without bothering whether
2161 cross-reference names already exist in the translation.
2163 @item Each maintenance task except @q{Updating PO files} can be done by
2164 the same person for all languages, which saves overall time spent by
2165 translators to achieve this task: the node names and section titles
2166 are in English, so you can do. It is important to take advantage of
2167 this now, as it will be more complicated (but still possible) to do
2168 step 3 in all languages when documentation is compiled with
2169 @command{texi2html} and node names are directly translated in source
2174 @node Managing documentation translation with Git
2175 @unnumberedsubsubsec Managing documentation translation with Git
2177 This policy explains how to manage Git branches and commit
2178 translations to Git.
2181 @item Translation changes matching master branch are preferably made on
2182 @code{lilypond/translation} branch; they may be pushed directly to
2183 @code{master} only if they do not break compilation of LilyPond and
2184 its documentation, and in this case they should be pushed to
2185 @code{lilypond/translation} too. Similarly, changes matching
2186 @code{stable/X.Y} are preferably made on
2187 @code{lilypond/X.Ytranslation}.
2189 @item @code{lilypond/translation} Git branch may be merged into
2190 master only if LilyPond (@command{make all}) and documentation
2191 (@command{make doc}) compile successfully.
2193 @item @code{master} Git branch may be merged into
2194 @code{lilypond/translation} whenever @command{make} and @command{make
2195 doc} are successful (in order to ease documentation compilation by
2196 translators), or when significant changes had been made in
2197 documentation in English in master branch.
2199 @item General maintenance may be done by anybody who knows what he does
2200 in documentation in all languages, without informing translators
2201 first. General maintenance include simple text substitutions
2202 (e.g. automated by sed), compilation fixes, updating Texinfo or
2203 lilypond-book commands, updating macros, updating ly code, fixing
2204 cross-references, and operations described in @ref{Maintaining
2205 without updating translations}.
2209 @node Technical background
2210 @subsection Technical background
2212 A number of Python scripts handle a part of the documentation
2213 translation process. All scripts used to maintain the translations
2214 are located in @file{scripts/@/auxiliar/}.
2217 @item @file{check_translation.py} -- show diff to update a translation,
2218 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
2219 make message catalogs and Texinfo skeleton files,
2220 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2221 @item @file{update-snippets.py} -- synchronize ly snippets with those
2223 @item @file{translations-status.py} -- update translations status pages and word
2224 counts in the file you are reading,
2225 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2226 in the sources; WARNING only use this script once for each file, when support for
2227 "makeinfo --html" has been dropped.
2230 Other scripts are used in the build process, in @file{scripts/@/build/}:
2233 @item @file{mass-link.py} -- link or symlink files between English documentation
2234 and documentation in other languages.
2237 Python modules used by scripts in @file{scripts/@/auxiliar/} or @file{scripts/@/build/} (but
2238 not by installed Python scripts) are located in @file{python/@/auxiliar/}:
2240 @item @file{manuals_definitions.py} -- define manual names and name of
2241 cross-reference Texinfo macros,
2242 @item @file{buildlib.py} -- common functions (read piped output
2243 of a shell command, use Git),
2244 @item @file{postprocess_html.py} (module imported by @file{www_post@/.py}) -- add footer and
2245 tweak links in HTML pages.
2250 @item @file{python/langdefs.py} -- language definitions module