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 If you want to use @code{\layout@{@}} or define variables, use
346 @@lilypond[verbatim,quote]
349 In rare cases, other options may be used (or omitted), but ask first.
352 Inspirational headwords are produced with
355 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
356 @{pitches-headword.ly@}
360 LSR snippets are linked with
363 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
368 excepted in Templates, where `doctitle' may be omitted.
371 Avoid long stretches of input code. Nobody is going to read
372 them in print. Create small examples. However, this does not mean
376 Specify durations for at least the first note of every bar.
379 If possible, end with a complete bar.
382 Comments should go on their own line, and be placed before
383 the line(s) to which they refer.
386 For clarity, always use @{ @} marks even if they are not technically
392 \context Voice \repeat unfold 2 \relative c' @{
408 Add a space around @{ @} marks; i.e.
411 not: \chordmode@{c e g@}
412 but instead: \chordmode @{ c e g @}
416 Use @{ @} marks for additional @code{\markup} format commands; i.e.
419 not: c^\markup \tiny\sharp
420 but instead: c^\markup @{ \tiny \sharp @}
424 Remove any space around @code{<} @code{>} marks; i.e.
428 but instead: <c e g>4
432 Beam, slur and tie marks should begin immediately after the first
433 note with beam and phrase marks ending immediately after the last.
436 a8(\ ais16[ b cis( d] b) cis4~ b' cis,\)
440 If you want to work on an example outside of the manual (for
441 easier/faster processing), use this header:
446 line-width = 160\mm - 2.0 * 0.4\in
448 force-assignment = #""
449 line-width = #(- line-width (* mm 3.000000))
456 You may not change any of these values. If you are making an
457 example demonstrating special @code{\paper@{@}} values, contact the
458 Documentation Editor.
463 @node Text formatting
464 @subsection Text formatting
468 Lines should be less than 72 characters long. (We personally
469 recommend writing with 66-char lines, but do not bother modifying
470 existing material). Also see the recommendations for fixed-width
471 fonts in the @ref{Syntax survey}.
477 Do not use spaces at the beginning of a line (except in
478 @code{@@example} or @code{@@verbatim} environments), and do not
479 use more than a single space between words. @q{makeinfo} copies
480 the input lines verbatim without removing those spaces.
483 Use two spaces after a period.
486 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
490 Don't use @code{@@rinternals@{@}} in the main text. If you're
491 tempted to do so, you're probably getting too close to @qq{talking
492 through the code}. If you really want to refer to a context, use
493 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
494 the @code{@@seealso}.
499 @subsection Syntax survey
509 * Special characters::
515 @unnumberedsubsubsec Comments
519 @code{@@c @dots{}} --- single line comment. @samp{@@c NOTE:} is a
520 comment which should remain in the final version. (gp only
524 @code{@@ignore} --- multi-line comment:
534 @node Cross references
535 @unnumberedsubsubsec Cross references
537 Enter the exact @code{@@node} name of the target reference between
538 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not
539 split a cross-reference across two lines -- this causes the
540 cross-reference to be rendered incorrectly in html documents.
544 @code{@@ref@{@dots{}@}} --- link within current manual.
547 @code{@@rchanges@{@dots{}@}} --- link to Changes.
550 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
553 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
556 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
559 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
562 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
565 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
568 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
571 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
574 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
577 @code{@@rweb@{@dots{}@}} --- link to General Information.
582 @unnumberedsubsubsec External links
586 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
589 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
590 external url. Use within an @code{@@example ... @@end example}.
594 @@uref@{URL [, link text ]@}
600 @node Fixed-width font
601 @unnumberedsubsubsec Fixed-width font
605 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
607 Use the @code{@@code@{@dots{}@}} command when referring to
608 individual language-specific tokens (keywords, commands,
609 engravers, scheme symbols, etc.) in the text. Ideally, a single
610 @code{@@code@{@dots{}@}} block should fit within one line in the
613 Use the @code{@@samp@{@dots{}@}} command when you have a short
614 example of user input, unless it constitutes an entire
615 @code{@@item} by itself, in which case @code{@@code@{@dots{}@}} is
616 preferable. Otherwise, both should only be used when part of a
617 larger sentence within a paragraph or @code{@@item}. Do not use
618 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} inside an
619 @code{@@example} block, and do not use either as a free-standing
620 paragraph; use @code{@@example} instead.
622 A single unindented line in the PDF has space for about 79
623 fixed-width characters (76 if indented). Within an @code{@@item}
624 there is space for about 75 fixed-width characters. Each
625 additional level of @code{@@itemize} or @code{@@enumerate}
626 shortens the line by about 4 columns.
628 However, even short blocks of @code{@@code@{@dots{}@}} and
629 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
630 line-breaking algorithm gets confused. Additionally, blocks that
631 are longer than this may in fact print nicely; it all depends
632 where the line breaks end up. If you compile the docs yourself,
633 check the PDF output to make sure the line breaks are
636 The Texinfo setting @code{@@allowcodebreaks} is set to
637 @code{false} in the manuals, so lines within
638 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
639 only break at spaces, not at hyphens or underscores. If the block
640 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
641 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
643 The Texinfo settings @code{txicodequoteundirected} and
644 @code{txicodequotebacktick} are both set in the manuals, so
645 backticks (@code{`}) and apostrophes (@code{'}) placed within
646 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
647 are not converted to left- and right-angled quotes
648 (@code{@quoteleft{} @quoteright{}}) as they normally are within
649 the text, so the apostrophes in
650 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
651 correctly. However, these settings do not affect the PDF output
652 for anything within a @code{@@samp} block (even if it includes a
653 nested @code{@@code} block), so entering
654 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
655 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
656 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
657 which contains backticks or apostrophes, you should instead use
658 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
659 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
660 contains spaces). Note that backslashes within
661 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
662 so the example above would be coded as
663 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
666 @code{@@command@{@dots{}@}} --- Use when referring to command-line
667 commands within the text (eg. @samp{@@command@{convert-ly@}}). Do
668 not use inside an @code{@@example} block.
671 @code{@@example} --- Use for examples of program code. Do not add
672 extraneous indentation (i.e. don't start every line with
673 whitespace). Use the following layout (notice the use of blank
674 lines). Omit the @code{@@noindent} if the text following the
675 example starts a new paragraph:
678 @var{@dots{}text leading into the example@dots{}}
685 @var{continuation of the text@dots{}}
688 Individual lines within an @code{@@example} block should not
689 exceed 74 characters; otherwise they will run into the margin in
690 the PDF output, and may get clipped. If an @code{@@example} block
691 is part of an @code{@@item}, individual lines in the
692 @code{@@example} block should not exceed 70 columns. Each
693 additional level of @code{@@itemize} or @code{@@enumerate}
694 shortens the line by about 4 columns.
696 For long command line examples, if possible, use a trailing
697 backslash to break up a single line, indenting the next line with
698 2 spaces. If this isn't feasible, use @samp{@@smallexample
699 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
700 fontsize. Use @code{@@example} whenever possible, but if needed,
701 @code{@@smallexample} can fit up to 90 characters per line before
702 running into the PDF margin. Each additional level of
703 @code{@@itemize} or @code{@@enumerate} shortens a
704 @code{@@smallexample} line by about 5 columns.
707 @code{@@file@{@dots{}@}} --- Use when referring to filenames and
708 directories in the text. Do not use inside an @code{@@example}
712 @code{@@option@{@dots{}@}} --- Use when referring to command-line
713 options in the text (eg. @samp{@@option@{--format@}}). Do not use
714 inside an @code{@@example} block.
717 @code{@@verbatim} --- Prints the block exactly as it appears in
718 the source file (including whitespace, etc.). For program code
719 examples, use @code{@@example} instead. @code{@@verbatim} uses
720 the same format as @code{@@example}.
722 Individual lines within an @code{@@verbatim} block should not
723 exceed 74 characters; otherwise they will run into the margin in
724 the PDF output, and may get clipped. If an @code{@@verbatim}
725 block is part of an @code{@@item}, individual lines in the
726 @code{@@verbatim} block should not exceed 70 columns. Each
727 additional level of @code{@@itemize} or @code{@@enumerate}
728 shortens the line by about 4 columns.
733 @unnumberedsubsubsec Indexing
737 @code{@@cindex @dots{}} --- General index. Please add as many as you can.
738 Don't capitalize the first word.
741 @code{@@funindex @dots{}} --- is for a \lilycommand.
746 @unnumberedsubsubsec Lists
750 @code{@@enumerate} --- Create an ordered list (with numbers).
751 Always put @samp{@@item} on its own line, and separate consecutive
752 items with a blank line:
765 @code{@@itemize} --- Create an unordered list (with bullets). Use
766 the same format as @code{@@enumerate}. Do not use
767 @samp{@@itemize@tie{}@@bullet}.
771 @node Special characters
772 @unnumberedsubsubsec Special characters
776 @code{--}, @code{---} --- Create an en dash (--) or an em dash
777 (---) in the text. To print two or three literal hyphens in a
778 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
782 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
783 a left curly bracket (@{), or a right curly bracket (@}).
786 @code{@@bs@{@}} --- Create a backslash within a
787 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
788 @code{@@warning@{@dots{}@}} block. This is a custom LilyPond
789 macro, not a builtin @@-command in Texinfo. Texinfo would also
790 allow @samp{\\}, but this breaks the PDF output.
793 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
794 space in the text (use @w{@samp{@@w@{ @}}} for a single
795 @emph{fixed-width} non-breaking space). Variables or numbers
796 which consist of a single character (probably followed by a
797 punctuation mark) should be tied properly, either to the previous
798 or the next word. Example: @samp{The letter@@tie@{@}@@q@{I@} is
804 @unnumberedsubsubsec Miscellany
808 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
809 @samp{@@notation@{clef@}}. Also use for specific lyrics
810 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
811 Only use once per subsection per term.
814 @code{@@q@{@dots{}@}} --- Single quotes. Used for
815 @quoteleft{}vague@quoteright{} terms. To get a backslash
816 (\), you must use @samp{@@bs@{@}}.
819 @code{@@qq@{@dots{}@}} --- Double quotes. Used for actual quotes
820 (@qq{he said}) or for introducing special input modes. To get a
821 backslash (\), you must use @samp{@@bs@{@}}.
824 @code{@@var@{@dots{}@}} --- Use for metasyntactic variables (such
825 as @code{@var{foo}}, @code{@var{bar}}, @code{@var{arg1}}, etc.).
826 In most cases, when the @code{@@var@{@dots{}@}} command appears in
827 the text (and not in an @code{@@example} block) it should be
828 wrapped with an appropriate texinfo code-highlighting command
829 (such as @code{@@code}, @code{@@samp}, @code{@@file},
830 @code{@@command}, etc.). For example:
831 @samp{@@code@{@@var@{foo@}@}},
832 @samp{@@file@{@@var@{myfile.ly@}@}},
833 @w{@samp{@@samp@{git checkout @@var@{branch@}@}}}, etc. This
834 improves readability in the PDF and HTML output.
837 @code{@@version@{@}} --- Return the current LilyPond version
838 string. Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
839 line (to prevent an ugly line break in PDF); use
840 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
843 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
846 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
847 Use for important messages. To get a backslash (\), you must use
852 @node Other text concerns
853 @subsection Other text concerns
857 References must occur at the end of a sentence, for more
859 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
860 manual}. Ideally this should also be the final sentence of a
861 paragraph, but this is not required. Any link in a doc section
862 must be duplicated in the @code{@@seealso} section at the bottom.
865 Introducing examples must be done with
868 . (i.e. finish the previous sentence/paragraph)
869 : (i.e. `in this example:')
870 , (i.e. `may add foo with the blah construct,')
873 The old @qq{sentence runs directly into the example} method is not
877 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
887 When beginning a quote: @qq{So, he said,...}.
889 This usage is rarer. Americans often just use a comma.
892 When adding a defining example at the end of a sentence.
896 Non-ASCII characters which are in utf-8 should be directly used;
897 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}. This
898 ensures that all such characters appear in all output formats.
902 @node Documentation policy
903 @section Documentation policy
907 * Section organization::
908 * Checking cross-references::
910 * Technical writing style::
916 There are four parts to the documentation: the Learning Manual,
917 the Notation Reference, the Program Reference, and the Music
925 The LM is written in a tutorial style which introduces the most
926 important concepts, structure and syntax of the elements of a
927 LilyPond score in a carefully graded sequence of steps.
928 Explanations of all musical concepts used in the Manual can be
929 found in the Music Glossary, and readers are assumed to have no
930 prior knowledge of LilyPond. The objective is to take readers to
931 a level where the Notation Reference can be understood and
932 employed to both adapt the templates in the Appendix to their
933 needs and to begin to construct their own scores. Commonly used
934 tweaks are introduced and explained. Examples are provided
935 throughout which, while being focussed on the topic being
936 introduced, are long enough to seem real in order to retain the
937 readers' interest. Each example builds on the previous material,
938 and comments are used liberally. Every new aspect is thoroughly
939 explained before it is used.
941 Users are encouraged to read the complete Learning Manual from
946 Notation Reference: a (hopefully complete) description of LilyPond
947 input notation. Some material from here may be duplicated in the
948 Learning Manual (for teaching), but consider the NR to be the
949 "definitive" description of each notation element, with the LM
950 being an "extra". The goal is _not_ to provide a step-by-step
951 learning environment -- do not avoid using notation that has not
952 be introduced previously in the NR (for example, use \break if
953 appropriate). This section is written in formal technical writing
956 Avoid duplication. Although users are not expected to read this
957 manual from start to finish, they should be familiar with the
958 material in the Learning Manual (particularly ``Fundamental
959 Concepts''), so do not repeat that material in each section of
960 this book. Also watch out for common constructs, like ^ - _ for
961 directions -- those are explained in NR 3. In NR 1, you can
962 write: DYNAMICS may be manually placed above or below the staff,
963 see @@ref@{Controlling direction and placement@}.
965 Most tweaks should be added to LSR and not placed directly in the
966 .itely file. In some cases, tweaks may be placed in the main
967 text, but ask about this first.
969 Finally, you should assume that users know what the notation
970 means; explaining musical concepts happens in the Music Glossary.
974 Application Usage: information about using the program lilypond
975 with other programs (lilypond-book, operating systems, GUIs,
976 convert-ly, etc). This section is written in formal technical
979 Users are not expected to read this manual from start to finish.
983 Music Glossary: information about the music notation itself.
984 Explanations and translations about notation terms go here.
986 Users are not expected to read this manual from start to finish.
989 Internals Reference: not really a documentation book, since it is
990 automagically generated from the source, but this is its name.
995 @node Section organization
996 @subsection Section organization
1001 The order of headings inside documentation sections should
1014 You @emph{must} include a @@seealso.
1018 The order of items inside the @@seealso section is
1027 @@rlearning@{foozle@}.
1040 @@file@{path/to/dir/blahz@}.
1042 Snippets: @@rlsr@{section@}.
1044 Internals Reference:
1045 @@rinternals@{fazzle@},
1046 @@rinternals@{booar@}.
1050 If there are multiple entries, separate them by commas but do not
1054 Always end with a period.
1057 Place each link on a new line as above; this makes it much easier
1058 to add or remove links. In the output, they appear on a single
1061 ("Snippets" is REQUIRED; the others are optional)
1064 Any new concepts or links which require an explanation should go
1065 as a full sentence(s) in the main text.
1068 Don't insert an empty line between @@seealso and the first entry!
1069 Otherwise there is excessive vertical space in the PDF output.
1074 To create links, use @@ref@{@} if the link is within the same
1078 @@predefined ... @@endpredefined is for commands in
1079 @file{ly/@/*-init@/.ly}
1082 Do not include any real info in second-level sections (i.e. 1.1
1083 Pitches). A first-level section may have introductory material,
1084 but other than that all material goes into third-level sections
1085 (i.e. 1.1.1 Writing Pitches).
1088 The @@knownissues should not discuss any issues that are in the
1089 tracker, unless the issue is Priority-Postponed. The goal is to
1090 discuss any overall architecture or syntax decisions which may be
1091 interpreted as bugs. Normal bugs should not be discussed here,
1092 because we have so many bugs that it would be a huge task to keep
1093 the @@knownissues current and accurate all the time.
1098 @node Checking cross-references
1099 @subsection Checking cross-references
1101 Cross-references between different manuals are heavily used in the
1102 documentation, but they are not checked during compilation.
1103 However, if you compile the documentation, a script called
1104 check_texi_refs can help you with checking and fixing these
1105 cross-references; for information on usage, cd into a source tree
1106 where documentation has been built, cd into Documentation and run:
1113 Note that you have to find yourself the source files to fix
1114 cross-references in the generated documentation such as the
1115 Internals Reference; e.g. you can grep scm/ and lily/.
1117 @c temporary? how long will kainhofer be used? -gp
1118 Also of interest may be the linkdoc checks on kainhofer.com. Be
1119 warned that these docs are not completely rebuilt every day, so it
1120 might not accurately reflect the current state of the docs.
1123 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1127 @node General writing
1128 @subsection General writing
1133 Do not forget to create @@cindex entries for new sections of text.
1134 Enter commands with @@funindex, i.e.
1137 @@cindex pitches, writing in different octaves
1138 @@funindex \relative
1142 do not bother with the @@code@{@} (they are added automatically).
1143 These items are added to both the command index and the unified
1146 Both index commands should go in front of the actual material.
1148 @@cindex entries should not be capitalized, ie
1151 @@cindex time signature
1155 is preferred instead of @qq{Time signature}, Only use capital
1156 letters for musical terms which demand them, like D.S. al Fine.
1158 For scheme functions, only include the final part, i.e.,
1161 @@funindex modern-voice-cautionary
1163 @@funindex #(set-accidental-style modern-voice-cautionary)
1172 In general, use the American spellings. The internal lilypond
1173 property names use this spelling.
1176 List of specific terms:
1180 simultaneous NOT concurrent
1181 measure: the unit of music
1182 bar line: the symbol delimiting a measure NOT barline
1183 note head NOT notehead
1184 chord construct NOT chord (when referring to <>)
1192 @node Technical writing style
1193 @subsection Technical writing style
1195 These refer to the NR. The LM uses a more gentle, colloquial
1201 Do not refer to LilyPond in the text. The reader knows what the
1202 manual is about. If you do, capitalization is LilyPond.
1205 If you explicitly refer to @q{lilypond} the program (or any other
1206 command to be executed), write @code{@@command@{lilypond@}}.
1209 Do not explicitly refer to the reader/user. There is no one else
1210 besides the reader and the writer.
1213 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1216 Avoid abbreviations, except for commonly used abbreviations of foreign
1217 language terms such as etc. and i.e.
1220 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1224 The use of the word @q{illegal} is inappropriate in most cases.
1225 Say @q{invalid} instead.
1230 @node Tips for writing docs
1231 @section Tips for writing docs
1233 In the NR, I highly recommend focusing on one subsection at a
1234 time. For each subsection,
1239 check the mundane formatting. Are the headings (@@predefined,
1240 @@seealso, etc.) in the right order?
1243 add any appropriate index entries.
1246 check the links in the @@seealso section -- links to music
1247 glossary, internal references, and other NR sections are the main
1248 concern. Check for potential additions.
1251 move LSR-worthy material into LSR. Add the snippet, delete the
1252 material from the .itely file, and add a @@lilypondfile command.
1255 check the examples and descriptions. Do they still work?
1256 @strong{Do not} assume that the existing text is
1257 accurate/complete; some of the manual is highly out of date.
1260 is the material in the @@knownissues still accurate?
1263 can the examples be improved (made more explanatory), or is there
1264 any missing info? (feel free to ask specific questions on -user;
1265 a couple of people claimed to be interesting in being
1266 @qq{consultants} who would help with such questions)
1270 In general, I favor short text explanations with good examples --
1271 @qq{an example is worth a thousand words}. When I worked on the
1272 docs, I spent about half my time just working on those tiny
1273 lilypond examples. Making easily-understandable examples is much
1274 harder than it looks.
1277 @subsubheading Tweaks
1279 In general, any \set or \override commands should go in the
1280 @qq{select snippets} section, which means that they should go in
1281 LSR and not the .itely file. For some cases, the command
1282 obviously belongs in the @qq{main text} (i.e. not inside
1283 @@predefined or @@seealso or whatever) -- instrument names are a
1284 good example of this.
1287 \set Staff.instrumentName = #"foo"
1290 On the other side of this,
1293 \override Score.Hairpin #'after-line-breaking = ##t
1296 clearly belongs in LSR.
1298 I'm quite willing to discuss specific cases if you think that a
1299 tweaks needs to be in the main text. But items that can go into
1300 LSR are easier to maintain, so I'd like to move as much as
1301 possible into there.
1304 It would be @qq{nice} if you spent a lot of time crafting nice
1305 tweaks for users@dots{} but my recommendation is @strong{not} to do
1306 this. There's a lot of doc work to do without adding examples of
1307 tweaks. Tweak examples can easily be added by normal users by adding
1310 One place where a documentation writer can profitably spend time writing
1311 or upgrading tweaks is creating tweaks to deal with known issues. It
1312 would be ideal if every significant known issue had a workaround to avoid
1316 @ref{Adding and editing snippets}.
1319 @node Scripts to ease doc work
1320 @section Scripts to ease doc work
1322 @subheading Building only one section of the documentation
1324 In order to save build time, a script is available to build only
1325 one section of the documentation in English with a default html
1328 The script is available as:
1331 scripts/auxiliar/doc-section.sh
1334 This script will require customization for your site if your
1335 LilyPond git repository is anyplace but @code{$HOME/lilypond}.
1337 Assuming that no customization is required, you can setup the
1338 single section build with:
1341 mkdir $HOME/lilypond/tempdocs
1342 cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs
1345 You can then build a section of the documentation with:
1348 scripts/auxiliar/doc-section.sh MANUAL SECTION
1352 where @code{SECTION} is the name of the file containing the section
1353 to be build, and @code{MANUAL} isc replaced by the name of the directory
1354 containing the section. So, for example, to build section 1.1 of the
1355 Notation Reference, use the command:
1358 scripts/auxiliar/doc-section.sh notation pitches
1361 This script will not work for building sections of the
1362 Contributors' guide. For building sections of the Contributors'
1366 scripts/auxiliar/cg-section.sh SECTION
1370 where @code{SECTION} is the name of the file containing the sections
1371 to be built. For example, to build section 4 of the Contributors' guide,
1375 scripts/auxiliar/cg-section.sh doc-work
1378 Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
1379 for your installation.
1381 @subheading Stripping whitespace and generating menus
1383 @warning{This script assumes that the file conforms to our doc
1384 policy; a few files still need work in this regard.}
1386 To automatically regenerate @code{@@menu} portions and strip
1390 scripts/auxiliar/node-menuify.py @var{FILENAME}
1394 @subheading Stripping whitespace only
1396 @c TODO: should this be documented elsewhere? It's useful for
1397 @c more than just docs.
1398 To remove extra whitespace from the ends of lines, run
1401 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1405 @subheading Updating doc with @command{convert-ly}
1407 cd into @file{Documentation/} and run
1410 find . -name '*.itely' | xargs convert-ly -e
1414 This also updates translated documentation.
1418 @node Docstrings in scheme
1419 @section Docstrings in scheme
1421 Material in the Internals reference is generated automatically
1422 from our source code. Any doc work on Internals therefore
1423 requires modifying files in @file{scm/@/*.scm}. Texinfo is allowed
1424 in these docstrings.
1426 Most documentation writers never touch these, though. If you want
1427 to work on them, please ask for help.
1430 @node Translating the documentation
1431 @section Translating the documentation
1433 The mailing list @code{translations@@lilynet.net} is dedicated to
1434 LilyPond web site and documentation translation; on this list, you will
1435 get support from the Translations Meister and experienced translators,
1436 and we regularly discuss translation issues common to all languages.
1437 All people interested in LilyPond translations are invited to subscribe
1438 to this list regardless of the amount of their contribution, by sending
1439 an email to @code{translations-request@@lilynet.net} with subject
1440 @code{subscribe} and an empty message body. Unless mentioned explicitly,
1441 or except if a translations coordinator contacts you privately, you
1442 should send questions, remarks and patches to the list
1443 @code{translations@@lilynet.net}. Please note that traffic is high
1444 on the English-speaking list @code{lilypond-user@@gnu.org}, so it may
1445 take some time before your request or contribution is handled.
1448 * Getting started with documentation translation::
1449 * Documentation translation details::
1450 * Documentation translation maintenance::
1451 * Translations management policies::
1452 * Technical background::
1455 @node Getting started with documentation translation
1456 @subsection Getting started with documentation translation
1458 First, get the sources of branch @code{lilypond/translation} from the
1459 Git repository, see @ref{Starting with Git}.
1462 * Translation requirements::
1463 * Which documentation can be translated::
1464 * Starting translation in a new language::
1467 @node Translation requirements
1468 @unnumberedsubsubsec Translation requirements
1470 Working on LilyPond documentation translations requires the following
1471 pieces of software, in order to make use of dedicated helper tools:
1474 @item Python 2.4 or higher,
1480 It is not required to build LilyPond and the documentation to
1481 translate the documentation. However, if you have enough time and
1482 motivation and a suitable system, it can be very useful to build at
1483 least the documentation so that you can check the output yourself and
1484 more quickly; if you are interested, see @ref{Compiling}.
1486 Before undertaking any large translation work, contributors are
1487 encouraged to contact the @ref{Meisters, Translation Meister}.
1490 @node Which documentation can be translated
1491 @unnumberedsubsubsec Which documentation can be translated
1493 The makefiles and scripts infrastructure currently supports translation
1494 of the following documentation:
1497 @item the web site, the Learning Manual, the Notation Reference and
1498 Application Usage -- Texinfo source, PDF and HTML output; Info output
1499 might be added if there is enough demand for it;
1500 @item the Changes document.
1503 Support for translating the following pieces of documentation should be
1504 added soon, by decreasing order of priority:
1507 @item automatically generated documentation: markup commands,
1508 predefined music functions;
1509 @item the Snippets List;
1510 @item the Internals Reference.
1514 @node Starting translation in a new language
1515 @unnumberedsubsubsec Starting translation in a new language
1517 At top of the source directory, do
1524 or (if you want to install your self-compiled LilyPond locally)
1527 ./autogen.sh --prefix=$HOME
1531 If you want to compile LilyPond -- which is almost required to build
1532 the documentation, but is not required to do translation only -- fix
1533 all dependencies and rerun @command{./configure} (with the same
1534 options as for @command{autogen.sh}).
1536 Then @command{cd} into @file{Documentation/} and run
1539 make ISOLANG=@var{MY-LANGUAGE} new-lang
1543 where @var{MY-LANGUAGE} is the ISO 639 language code.
1545 Finally, add a language definition for your language in
1546 @file{python/@/langdefs@/.py}.
1549 @node Documentation translation details
1550 @subsection Documentation translation details
1552 Please follow all the instructions with care to ensure quality work.
1554 All files should be encoded in UTF-8.
1557 * Files to be translated::
1558 * Translating the Web site and other Texinfo documentation::
1559 * Adding a Texinfo manual::
1562 @node Files to be translated
1563 @unnumberedsubsubsec Files to be translated
1565 @include contributor/doc-translation-list.itexi
1567 In addition, not listed above, Snippets' titles and descriptions
1568 should be translated; they are a part of the Notation Reference and
1569 therefore their priority is 5.
1571 @node Translating the Web site and other Texinfo documentation
1572 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1574 Every piece of text should be translated in the source file, except
1575 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1578 Node names are translated, but the original node name in English should
1579 be kept as the argument of @code{@@translationof} put after the section
1580 title; that is, every piece in the original file like
1584 @@@var{section_command} Bar baz
1588 should be translated as
1591 @@node @var{translation of Foo bar}
1592 @@@var{section_command} @var{translation of Bar baz}
1593 @@translationof Foo bar
1596 The argument of @code{@@rglos} commands and the first argument of
1597 @code{@@rglosnamed} commands must not be translated, as it is the node
1598 name of an entry in Music Glossary.
1600 Every time you translate a node name in a cross-reference, i.e. the
1601 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1602 @@ruser} or the first argument of their @code{@var{*}named} variants,
1603 you should make sure the target node is defined in the correct source
1604 file; if you do not intend to translate the target node right now, you
1605 should at least write the node definition (that is, the @code{@@node
1606 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1607 expected source file and define all its parent nodes; for each node you
1608 have defined this way but have not translated, insert a line that
1609 contains @code{@@untranslated}. That is, you should end up
1610 for each untranslated node with something like
1613 @@node @var{translation of Foo bar}
1614 @@@var{section_command} @var{translation of Bar baz}
1615 @@translationof Foo bar
1620 @warning{you do not have to translate the node name of a cross-reference
1621 to a node that you do not have translated. If you do, you must define
1622 an @qq{empty} node like explained just above; this will produce a
1623 cross-reference with the translated node name in output, although the
1624 target node will still be in English. On the opposite, if all
1625 cross-references that refer to an untranslated node use the node name in
1626 English, then you do not have to define such an @qq{empty} node, and the
1627 cross-reference text will appear in English in the output. The choice
1628 between these two strategies implies its particular maintenance
1629 requirements and is left to the translators, although the opinion of the
1630 Translation meister leans towards not translating these
1633 Please think of the fact that it may not make sense translating
1634 everything in some Texinfo files, and you may take distance from the
1635 original text; for instance, in the translation of the web site section
1636 Community, you may take this into account depending on what you know the
1637 community in your language is willing to support, which is possible only
1638 if you personally assume this support, or there exists a public forum
1639 or mailing list listed in Community for LilyPond in your language:
1642 @item @rweb{Bug reports}: this page should be translated only if you
1643 know that every bug report sent on your language's mailing list or forum
1644 will be handled by someone who will translate it to English and send it
1645 on bug-lilypond or add an issue in the tracker, then translate back the
1646 reply from developers.
1648 @item @rweb{Help us}: this page should be translated very freely,
1649 and possibly not at all: ask help for contributing to LilyPond for tasks
1650 that LilyPond community in your language is able and going to handle.
1654 In any case, please mark in your work the sections which do not result
1655 from the direct translation of a piece of English translation, using
1656 comments i.e. lines starting with @q{@code{@@c}}.
1658 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1659 menus. This process should be made easier in the future, when the helper
1660 script @command{texi-langutils.py} and the makefile target are updated.
1662 Some pieces of text manipulated by build scripts that appear in the
1663 output are translated in a @file{.po} file -- just like LilyPond output
1664 messages -- in @file{Documentation/@/po}. The Gettext domain is named
1665 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1666 through the Free Translation Project.
1669 Take care of using typographic rules for your language, especially in
1670 @file{macros@/.itexi}.
1672 If you wonder whether a word, phrase or larger piece of text should be
1673 translated, whether it is an argument of a Texinfo command or a small
1674 piece sandwiched between two Texinfo commands, try to track whether and
1675 where it appears in PDF and/or HTML output as visible text. This piece
1676 of advice is especially useful for translating @file{macros@/.itexi}.
1678 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1679 blocs). However, some music snippets containing text that shows in
1680 the rendered music, and sometimes translating this text really helps
1681 the user to understand the documentation; in this case, and only in
1682 this case, you may as an exception translate text in the music
1683 snippet, and then you must add a line immediately before the
1684 @code{@@lilypond} block, starting with
1691 Otherwise the music snippet would be reset to the same content as the
1692 English version at next @command{make snippet-update} run -- see
1693 @ref{Updating documentation translation}.
1698 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1702 in the source, open @file{Documentation/@/snippets/@/@var{filename}@/.ly},
1703 translate the @code{texidoc} header field it contains, enclose it with
1704 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1705 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs/@/@var{filename}@/.texidoc}.
1706 Additionally, you may translate the snippet's title in @code{doctitle}
1707 header field, in case @code{doctitle} is a fragment option used in
1708 @code{@@lilypondfile}; you can do this exactly the same way as
1709 @code{texidoc}. For instance,
1710 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs/@/@var{filename}@/.texidoc}
1714 doctitlees = "Spanish title baz"
1716 Spanish translation blah
1721 Then, you should get these translated strings into compiled snippets in
1722 @file{Documentation/@/snippets}, see @q{General guidelines} in @ref{Adding
1723 and editing snippets}.
1725 @code{@@example} blocks need not be verbatim copies, e.g. variable
1726 names, file names and comments should be translated.
1728 Finally, please carefully apply every rule exposed in @ref{Texinfo
1729 introduction and usage policy}, and @ref{Documentation policy}. If one
1730 of these rules conflicts with a rule specific to your language, please
1731 ask the Translation meister on @email{translations@@lilynet.net} list
1732 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1736 @node Adding a Texinfo manual
1737 @unnumberedsubsubsec Adding a Texinfo manual
1739 In order to start translating a new manual whose basename is @var{FOO},
1743 cd Documentation/@var{MY-LANGUAGE}
1744 cp ../@var{FOO}.tely .
1746 cp web/GNUmakefile @var{FOO}
1750 then append @var{FOO} to variable @code{SUBDIRS} in
1751 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1752 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1756 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1760 Your are now ready to translate the new manual exactly like the web site
1761 or the Learning Manual.
1764 @node Documentation translation maintenance
1765 @subsection Documentation translation maintenance
1767 Several tools have been developed to make translations maintenance
1768 easier. These helper scripts make use of the power of Git, the
1769 version control system used for LilyPond development.
1771 You should use them whenever you would like to update the translation in
1772 your language, which you may do at the frequency that fits your and your
1773 cotranslators' respective available times. In the case your translation
1774 is up-do-date (which you can discover in the first subsection below), it
1775 is enough to check its state every one or two weeks. If you feel
1776 overwhelmed by the quantity of documentation to be updated, see
1777 @ref{Maintaining without updating translations}.
1780 * Check state of translation::
1781 * Updating documentation translation::
1782 * Updating translation committishes::
1785 @macro seeCommittishesUpdate{}
1786 @warning{do not forget to update the committish in each file you have
1787 completely updated, see @ref{Updating translation committishes}.}
1790 @node Check state of translation
1791 @unnumberedsubsubsec Check state of translation
1793 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1794 unless you are sure to master the translation state checking and
1795 updating system -- then cd into @file{Documentation/} (or at top of the
1796 source tree, replace @command{make} with @command{make -C
1797 Documentation}) and run
1800 make ISOLANG=@var{MY_LANGUAGE} check-translation
1804 This presents a diff of the original files since the most recent
1805 revision of the translation. To check a single file, cd into
1806 @file{Documentation/} and run
1809 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1813 In case this file has been renamed since you last updated the
1814 translation, you should specify both old and new file names, e.g.
1815 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1817 To see only which files need to be updated, do
1820 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1823 To avoid printing terminal colors control characters, which is often
1824 desirable when you redirect output to a file, run
1827 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1830 You can see the diffs generated by the commands above as changes that
1831 you should make in your language to the existing translation, in order
1832 to make your translation up to date.
1834 @seeCommittishesUpdate
1836 Global state of the translation is recorded in
1837 @file{Documentation/@/translations@/.itexi}, which is used to generate
1838 Translations status page. To update that page, do from
1839 @file{Documentation/}
1842 make translation-status
1845 This will also leave @file{out/@/translations@/-status@/.txt}, which contains
1846 up-to-dateness percentages for each translated file, and update word
1847 counts of documentation files in this Guide.
1850 @ref{Maintaining without updating translations}.
1852 @node Updating documentation translation
1853 @unnumberedsubsubsec Updating documentation translation
1855 Instead of running @code{check-translation}, you may want to run
1856 @code{update-translation}, which will run your favorite text editor to
1857 update files. First, make sure environment variable @code{EDITOR} is
1858 set to a text editor command, then run from @file{Documentation/}
1861 make ISOLANG=@var{MY_LANGUAGE} update-translation
1865 or to update a single file
1868 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1871 For each file to be updated, @code{update-translation} will open your
1872 text editor with this file and a diff of the file in English; if the
1873 diff cannot be generated or is bigger than the file in English itself,
1874 the full file in English will be opened instead.
1876 @seeCommittishesUpdate
1878 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1879 containing only the first node of the original file in English can be
1880 updated automatically: whenever @command{make check-translation} shows
1881 that such files should be updated, run from @file{Documentation/}
1884 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1887 @file{.po} message catalogs in @file{Documentation/@/po/} may be updated
1888 by issuing from @file{Documentation/} or @file{Documentation/@/po/}
1894 @warning{if you run po-update and somebody else does the same and
1895 pushes before you push or send a patch to be applied, there will be a
1896 conflict when you pull. Therefore, it is better that only the
1897 Translation meister runs this command.}
1899 Updating music snippets can quickly become cumbersome, as most
1900 snippets should be identical in all languages. Fortunately, there is
1901 a script that can do this odd job for you (run from
1902 @file{Documentation/}):
1905 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1908 This script overwrites music snippets in
1909 @file{@var{MY_LANGUAGE/@/foo/@/every@/.itely}} with music snippets from
1910 @file{@var{foo/@/every@/.itely}}. It ignores skeleton files, and keeps
1911 intact music snippets preceded with a line starting with @code{@@c
1912 KEEP LY}; it reports an error for each @file{.itely} that has not the
1913 same music snippet count in both languages. Always use this script
1914 with a lot of care, i.e. run it on a clean Git working tree, and check
1915 the changes it made with @command{git diff} before committing; if you
1916 don't do so, some @code{@@lilypond} snippets might be broken or make
1917 no sense in their context.
1919 When you have updated texidocs in
1920 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}, you can get these
1921 changes into compiled snippets in @file{Documentation/@/snippets}, see
1922 @q{General guidelines} in @ref{Adding and editing snippets}.
1924 Finally, a command runs the three update processes above for all
1925 enabled languages (from @file{Documentation/}):
1928 make all-translations-update
1931 Use this command with caution, and keep in mind it will not be really
1932 useful until translations are stabilized after the end of GDP and GOP.
1935 @ref{Maintaining without updating translations},
1936 @ref{Adding and editing snippets}.
1939 @node Updating translation committishes
1940 @unnumberedsubsubsec Updating translation committishes
1942 At the beginning of each translated file except PO files, there is a
1943 committish which represents the revision of the sources which you have
1944 used to translate this file from the file in English.
1946 When you have pulled and updated a translation, it is very important to
1947 update this committish in the files you have completely updated (and
1948 only these); to do this, first commit possible changes to any
1949 documentation in English which you are sure to have done in your
1950 translation as well, then replace in the up-to-date translated files the
1951 old committish by the committish of latest commit, which can be obtained
1955 git rev-list HEAD |head -1
1958 A special case is updating Snippet documentation strings in
1959 @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}. For these to be
1960 correctly marked as up-to-date, first run @code{makelsr.py} as
1961 explained in @ref{Adding and editing snippets}, and commit the
1962 resulting compiled snippets left in @file{Documentation/@/snippets/}.
1963 Say the SHA1 ID code of this commit is <C>. Now edit again your
1964 translated files in @file{Documentation/@/@var{MY-LANGUAGE}/@/texidocs}
1965 adjusting the 40-digit committish that appears in the text to be <C>;
1966 finally, commit these updated files. Not doing so would result in
1967 changes made both to your updates and original snippets to
1968 persistently appear in the check-translation output as if they were
1971 This two-phase mechanism avoids the (practically) unsolvable problem
1972 of guessing what committish will have our update, and pretending to
1973 put this very committish on the files in the same commit.
1975 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
1976 @c contains a helper script which could be used to perform massive
1977 @c committish updates.
1983 @node Translations management policies
1984 @subsection Translations management policies
1986 These policies show the general intent of how the translations should
1987 be managed, they aim at helping translators, developers and
1988 coordinators work efficiently.
1991 * Maintaining without updating translations::
1992 * Managing documentation translation with Git::
1995 @node Maintaining without updating translations
1996 @unnumberedsubsubsec Maintaining without updating translations
1998 Keeping translations up to date under heavy changes in the documentation
1999 in English may be almost impossible, especially as during the former
2000 Grand Documentation Project (GDP) or the Grand Organization Project
2001 (GOP) when a lot of contributors brings changes. In addition,
2002 translators may be --- and that is a very good thing --- involved in
2005 it is possible --- and even recommended --- to perform some maintenance
2006 that keeps translated documentation usable and eases future translation
2007 updating. The rationale below the tasks list motivates this plan.
2009 The following tasks are listed in decreasing priority order.
2012 @item Update macros.itexi.
2013 For each obsolete macro definition, if it is possible to update macro
2014 usage in documentation with an automatic text or regexp substitution,
2015 do it and delete the macro definition from macros.itexi; otherwise,
2016 mark this macro definition as obsolete with a comment, and keep it in
2017 macros.itexi until the documentation translation has been updated and
2018 no longer uses this macro.
2020 @item Update @file{*.tely} files completely with
2021 @command{make check-translation} -- you may want to redirect output
2022 to a file because of overwhelming output, or call check-translation.py
2023 on individual files, see @ref{Check state of translation}.
2025 @item In @file{.itelys}, match sections and .itely file names with those from
2026 English docs, which possibly involves moving nodes contents in block
2027 between files, without updating contents itself. In other words, the
2028 game is catching where has gone each section. In Learning manual, and
2029 in Notation Reference sections which have been revised in GDP, there may
2030 be completely new sections: in this case, copy @code{@@node} and
2031 @code{@@section}-command from English docs, and add the marker for
2032 untranslated status @code{@@untranslated} on a single line. Note that
2033 it is not possible to exactly match subsections or subsubsections of
2034 documentation in English, when contents has been deeply revised; in this
2035 case, keep obsolete (sub)subsections in the translation, marking them
2036 with a line @code{@@c obsolete} just before the node.
2038 Emacs with Texinfo mode makes this step easier:
2041 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
2042 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
2043 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
2044 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
2045 (e.g. the translated file), copy @code{*Occur*} contents into
2046 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
2048 If you happen to have installed AucTeX, you can either call the macro
2049 by doing @key{M-x texinfo-show-structure} or create a key binding in your
2050 @file{~/.emacs}, by adding the four following lines:
2053 (add-hook 'Texinfo-mode-hook
2055 (define-key Texinfo-mode-map "\C-cs"
2056 'texinfo-show-structure)))
2060 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
2063 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
2064 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
2065 updated all the rest of the file.
2067 @item Moving to next or previous node using incremental search: press
2068 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
2069 contains the word @q{node}) then press @key{C-s} to move to next node
2070 or @key{C-r} to move to previous node. Similar operation can be used
2071 to move to the next/previous section. Note that every cursor move
2072 exits incremental search, and hitting @key{C-s} twice starts
2073 incremental search with the text entered in previous incremental
2076 @item Moving a whole node (or even a sequence of nodes): jump to beginning
2077 of the node (quit incremental search by pressing an arrow), press
2078 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
2079 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
2080 the right place (moving between nodes with the previous hint is often
2081 useful) and paste with @key{C-y} or @key{C-v}.
2084 @item Update sections finished in the English documentation; check
2086 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
2088 @item Update documentation PO. It is recommended not to update
2089 strings which come from documentation that is currently deeply revised
2090 in English, to avoid doing the work more than once.
2092 @item Fix broken cross-references by running (from @file{Documentation/})
2095 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
2099 This step requires a successful documentation build (with @command{make
2100 doc}). Some cross-references are broken because they point to a node
2101 that exists in the documentation in English, which has not been added
2102 to the translation; in this case, do not fix the cross-reference but
2103 keep it "broken", so that the resulting HTML link will point to an
2104 existing page of documentation in English.
2107 @subsubheading Rationale
2109 You may wonder if it would not be better to leave translations as-is
2110 until you can really start updating translations. There are several
2111 reasons to do these maintenance tasks right now.
2114 @item This will have to be done sooner or later anyway, before updating
2115 translation of documentation contents, and this can already be done
2116 without needing to be redone later, as sections of documentation in
2117 English are mostly revised once. However, note that not all
2118 documentation sectioning has been revised in one go, so all this
2119 maintenance plan has to be repeated whenever a big reorganization is
2122 @item This just makes translated documentation take advantage of the new
2123 organization, which is better than the old one.
2125 @item Moving and renaming sections to match sectioning of documentation in
2126 English simplify future updating work: it allows updating the
2127 translation by side-by-side comparison, without bothering whether
2128 cross-reference names already exist in the translation.
2130 @item Each maintenance task except @q{Updating PO files} can be done by
2131 the same person for all languages, which saves overall time spent by
2132 translators to achieve this task: the node names and section titles
2133 are in English, so you can do. It is important to take advantage of
2134 this now, as it will be more complicated (but still possible) to do
2135 step 3 in all languages when documentation is compiled with
2136 @command{texi2html} and node names are directly translated in source
2141 @node Managing documentation translation with Git
2142 @unnumberedsubsubsec Managing documentation translation with Git
2144 This policy explains how to manage Git branches and commit
2145 translations to Git.
2148 @item Translation changes matching master branch are preferably made on
2149 @code{lilypond/translation} branch; they may be pushed directly to
2150 @code{master} only if they do not break compilation of LilyPond and
2151 its documentation, and in this case they should be pushed to
2152 @code{lilypond/translation} too. Similarly, changes matching
2153 @code{stable/X.Y} are preferably made on
2154 @code{lilypond/X.Ytranslation}.
2156 @item @code{lilypond/translation} Git branch may be merged into
2157 master only if LilyPond (@command{make all}) and documentation
2158 (@command{make doc}) compile successfully.
2160 @item @code{master} Git branch may be merged into
2161 @code{lilypond/translation} whenever @command{make} and @command{make
2162 doc} are successful (in order to ease documentation compilation by
2163 translators), or when significant changes had been made in
2164 documentation in English in master branch.
2166 @item General maintenance may be done by anybody who knows what he does
2167 in documentation in all languages, without informing translators
2168 first. General maintenance include simple text substitutions
2169 (e.g. automated by sed), compilation fixes, updating Texinfo or
2170 lilypond-book commands, updating macros, updating ly code, fixing
2171 cross-references, and operations described in @ref{Maintaining
2172 without updating translations}.
2176 @node Technical background
2177 @subsection Technical background
2179 A number of Python scripts handle a part of the documentation
2180 translation process. All scripts used to maintain the translations
2181 are located in @file{scripts/@/auxiliar/}.
2184 @item @file{check_translation.py} -- show diff to update a translation,
2185 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
2186 make message catalogs and Texinfo skeleton files,
2187 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2188 @item @file{update-snippets.py} -- synchronize ly snippets with those
2190 @item @file{translations-status.py} -- update translations status pages and word
2191 counts in the file you are reading,
2192 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2193 in the sources; WARNING only use this script once for each file, when support for
2194 "makeinfo --html" has been dropped.
2197 Other scripts are used in the build process, in @file{scripts/@/build/}:
2200 @item @file{mass-link.py} -- link or symlink files between English documentation
2201 and documentation in other languages.
2204 Python modules used by scripts in @file{scripts/@/auxiliar/} or @file{scripts/@/build/} (but
2205 not by installed Python scripts) are located in @file{python/@/auxiliar/}:
2207 @item @file{manuals_definitions.py} -- define manual names and name of
2208 cross-reference Texinfo macros,
2209 @item @file{buildlib.py} -- common functions (read piped output
2210 of a shell command, use Git),
2211 @item @file{postprocess_html.py} (module imported by @file{www_post@/.py}) -- add footer and
2212 tweak links in HTML pages.
2217 @item @file{python/langdefs.py} -- language definitions module