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 * version in documentation files::
18 * Documentation suggestions::
19 * Texinfo introduction and usage policy::
20 * Documentation policy::
21 * Tips for writing docs::
22 * Scripts to ease doc work::
23 * Docstrings in scheme::
24 * Translating the documentation::
28 @node Introduction to documentation work
29 @section Introduction to documentation work
31 Our documentation tries to adhere to our @ref{Documentation
32 policy}. This policy contains a few items which may seem odd.
33 One policy in particular is often questioned by potential
34 contributors: we do not repeat material in the Notation Reference,
35 and instead provide links to the @qq{definitive} presentation of
36 that information. Some people point out, with good reason, that
37 this makes the documentation harder to read. If we repeated
38 certain information in relevant places, readers would be less
39 likely to miss that information.
41 That reasoning is sound, but we have two counter-arguments.
42 First, the Notation Reference -- one of @emph{five} manuals for
43 users to read -- is already over 500 pages long. If we repeated
44 material, we could easily exceed 1000 pages! Second, and much
45 more importantly, LilyPond is an evolving project. New features
46 are added, bugs are fixed, and bugs are discovered and documented.
47 If features are discussed in multiple places, the documentation
48 team must find every instance. Since the manual is so large, it
49 is impossible for one person to have the location of every piece
50 of information memorized, so any attempt to update the
51 documentation will invariably omit a few places. This second
52 concern is not at all theoretical; the documentation used to be
53 plagued with inconsistent information.
55 If the documentation were targeted for a specific version -- say,
56 LilyPond 2.10.5 -- and we had unlimited resources to spend on
57 documentation, then we could avoid this second problem. But since
58 LilyPond evolves (and that is a very good thing!), and since we
59 have quite limited resources, this policy remains in place.
61 A few other policies (such as not permitting the use of tweaks in
62 the main portion of NR 1+2) may also seem counter-intuitive, but
63 they also stem from attempting to find the most effective use of
64 limited documentation help.
66 Before undertaking any large documentation work, contributors are
67 encouraged to contact the @ref{Meisters, Documentation Meister}.
70 @node version in documentation files
71 @section @code{\version} in documentation files
73 Every documentation file which includes LilyPond code must begin
74 with a @code{\version} statement, since the build procedure
75 explicitly tests for its presence and will not continue otherwise.
76 The @code{\version} statement should reference a version of LilyPond
77 consistent with the syntax of the contained code.
79 Since the @code{\version} statement is not valid Texinfo input it
80 must be commented out like this:
86 So, if you are adding LilyPond code which is not consistent with the
87 current version header, you should
92 run convert-ly on the file using the latest version of LilyPond
93 (which should, if everybody has done proper maintenance, not change
100 modify the version number to match the new code.
105 @node Documentation suggestions
106 @section Documentation suggestions
108 @subheading Small additions
110 For additions to the documentation,
115 Tell us where the addition should be placed. Please include both
116 the section number and title (i.e. "LM 2.13 Printing lyrics").
119 Please write exact changes to the text.
122 A formal patch to the source code is @emph{not} required; we can
123 take care of the technical details.
126 Send the suggestions to the @code{bug-lilypond} mailing list as
127 discussed in @rweb{Contact}.
130 Here is an example of a perfect documentation report:
133 To: bug-lilypond@gnu.org
134 From: helpful-user@example.net
135 Subject: doc addition
137 In LM 2.13 (printing lyrics), above the last line ("More options,
138 like..."), please add:
141 To add lyrics to a divided part, use blah blah blah. For example,
144 \notes {blah <<blah>> }
145 \lyrics {blah <<blah>> }
150 In addition, the second sentence of the first paragraph is
151 confusing. Please delete that sentence (it begins "Users
152 often...") and replace it with this:
154 To align lyrics with something, do this thing.
164 @subheading Larger contributions
166 To replace large sections of the documentation, the guidelines are
167 stricter. We cannot remove parts of the current documentation
168 unless we are certain that the new version is an improvement.
173 Ask on the lilypond-devel mailing list if such a rewrite is necessary;
174 somebody else might already be working on this issue!
177 Split your work into small sections; this makes it much easier to
178 compare the new and old documentation.
181 Please prepare a formal git patch.
185 @subheading Contributions that contain examples using overrides
187 Examples that use overrides, tweaks, customer Scheme functions etc. are
188 (with very few exceptions) not included in the main text of the manuals;
189 as there would be far too many, equally useful, candidates.
191 The correct way is to submit your example, with appropriate explanatory
192 text and tags, to the LilyPond Snippet Repository (LSR). Snippets that
193 have the @qq{docs} tag can then be easily added as a
194 @emph{selected snippet} in the documentation. It will also appear
195 automatically in the Snippets lists. See @ref{Introduction to LSR}.
197 Snippets that @emph{don't} have the @qq{docs} tage will still be
198 searchable and viewable within the LSR, but will be not be included in
199 the Snippets list or be able to be included as part of the main
202 Generally, any new snippets that have the @qq{docs} tag are more
203 carefully checked for syntax and formatting.
205 @subheading Announcing your snippet
207 Once you have followed these guidelines, please send a message to
208 lilypond-devel with your documentation submissions. Unfortunately
209 there is a strict @q{no top-posting} check on the mailing list; to avoid
212 @code{> I'm not top posting}
214 (you must include the > ) to the top of your documentation addition.
216 We may edit your suggestion for spelling, grammar, or style, and we may
217 not place the material exactly where you suggested, but if you give us
218 some material to work with, we can improve the manual much faster.
220 Thanks for your interest!
223 @node Texinfo introduction and usage policy
224 @section Texinfo introduction and usage policy
227 * Texinfo introduction::
228 * Documentation files::
229 * Sectioning commands::
230 * LilyPond formatting::
233 * Other text concerns::
237 @node Texinfo introduction
238 @subsection Texinfo introduction
240 The language is called Texinfo; you can see its manual here:
242 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
244 However, you don't need to read those docs. The most important
245 thing to notice is that text is text. If you see a mistake in the
246 text, you can fix it. If you want to change the order of
247 something, you can cut-and-paste that stuff into a new location.
249 @warning{Rule of thumb: follow the examples in the existing docs.
250 You can learn most of what you need to know from this; if you want
251 to do anything fancy, discuss it on @code{lilypond-devel} first.}
254 @node Documentation files
255 @subsection Documentation files
257 All manuals live in @file{Documentation/}.
259 In particular, there are four user manuals, their respective master
260 source files are @file{learning.tely} (LM, Learning Manual),
261 @file{notation.tely} (NR, Notation Reference),
262 @file{music-glossary.tely} (MG, Music Glossary), and
263 @file{lilypond-program} (AU). Each chapter is written in a separate
264 file, ending in @file{.itely} for files containing lilypond code, and
265 @file{.itexi} for files without lilypond code, located in a subdirectory
266 associated to the manual (@file{learning/} for @file{learning.tely}, and
267 so on); list the subdirectory of each manual to determine the filename
268 of the specific chapter you wish to modify.
270 Developer manuals live in @file{Documentation/} too. Currently there is
271 only one: the Contributor's Guide @file{contrib-guide.texi} you are
274 Snippet files are part of documentation, and the Snippet List (SL) lives
275 in @file{Documentation/} just like the manuals. For information about
276 how to modify the snippet files and SL, see @ref{LSR work}.
279 @node Sectioning commands
280 @subsection Sectioning commands
282 The Notation Reference uses section headings at four, occasionally
287 @item Level 1: @@chapter
288 @item Level 2: @@section
289 @item Level 3: @@subsection
290 @item Level 4: @@unnumberedsubsubsec
291 @item Level 5: @@subsubsubheading
294 The first three levels are numbered in html, the last two are not.
295 Numbered sections correspond to a single html page in the split html
298 The first four levels always have accompanying nodes so they can be
299 referenced and are also included in the ToC in html.
301 Most of the manual is written at level 4 under headings created with
305 @@unnumberedsubsubsec Foo
308 Level 3 subsections are created with
315 Level 4 headings and menus must be preceded by level 3 headings and
316 menus, and so on for level 3 and level 2. If this is not what is
320 @@subsubsubheading Foo
323 Please leave two blank lines above a @code{@@node}; this makes it
324 easier to find sections in texinfo.
326 Do not use any @code{@@} commands for a @code{@@node}. They may be
327 used for any @code{@@sub...} sections or headings however.
331 @@node @@code@{Foo@} Bar
332 @@subsection @@code@{Foo@} Bar
336 @@subsection @@code@{Foo@} Bar
339 No punctuation may be used in the node names. If the heading text
340 uses punctuation (in particular, colons and commas) simply leave
341 this out of the node name and menu.
349 @@subsection Foo: Bar
352 Backslashes must not be used in node names or section headings.
353 If the heading text should include a backslash simply leave this
354 out of the node name and menu and replace it with @code{@@bs@{@}}
362 @@node The set command
363 @@subsection The @@code@{@@bs@{@}set@} command
366 References to such a node may use the third argument of the
367 @code{@@ref} command to display the texually correct heading.
370 @@ref@{The set command,,The @@code@{@@bs@{@}set command@}
373 With the exception of @code{@@} commands, @code{\} commands and
374 punctuation, the section name should match the node name exactly.
376 Sectioning commands (@code{@@node} and @code{@@section}) must not appear
377 inside an @code{@@ignore}. Separate those commands with a space, ie
378 @code{@@n}@tie{}@code{ode}.
380 Nodes must be included inside a
390 construct. These can be constructed with scripts:
391 see @ref{Stripping whitespace and generating menus}.
394 @node LilyPond formatting
395 @subsection LilyPond formatting
400 Most LilyPond examples throughout the documentation can be produced
404 @@lilypond[verbatim,quote,relative=1]
410 @@lilypond[verbatim,quote,relative=2]
413 If using any combination of @code{\header@{@}}, @code{\score@{@}} or
414 @code{\layout@{@}} in your example, then you must omit the
415 @code{relative} variable and either use absolute entry mode or an
416 explicit @code{\relative@{@}} construction.
418 If using @code{\book@{@}} in your example then you must also omit the
419 @code{relative} variable and either use absolute entry mode or an
420 explicit @code{\relative@{@}} construction. However, you must also
421 include the @code{papersize=X} variable, where @code{X} is a defined
422 paper size from within @file{scm/paper.scm}. This is to avoid the
423 default @code{a4} paper size being used and leaving too much unnecessary
424 whitespace and potentially awkward page breaks in the PDFs.
426 The preferred @code{papersize}s are @code{a5}, @code{a6} or
429 @code{a8landscape} works best for a single measure with a single title
430 and/or single @code{tagline}:
433 @@lilypond[papersize=a8landscape,verbatim]
436 title = "A scale in LilyPond"
445 and can also be used to easily show features that require page breaks
446 (i.e. page numbers) without taking large amounts of space within the
447 documentation. Do not use the @code{quote} option with this paper size.
449 @code{a5} or @code{a6} paper sizes are best used for examples that have
450 more than two measures of music or require multiple staves (i.e. to
451 illustrate cross-staff features, RH and LH parts etc.) and where
452 @code{\book@{@}} constructions are required or where @code{a8landscape}
453 produces an example that is too cramped. Depending on the example the
454 @code{quote} option may need to be omitted.
456 In rare cases, other options may be used (or omitted), but ask first.
459 Please avoid using extra spacing either after or within the
460 @code{@@lilypond} parameters.
463 not: @@lilypond [verbatim, quote, relative=1]
464 but instead: @@lilypond[verbatim,quote,relative=1]
468 Inspirational headwords are produced with:
471 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
472 @{pitches-headword.ly@}
476 LSR snippets are linked with:
479 @@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
484 Use two spaces for indentation in lilypond examples (no tabs).
487 All engravers should have double-quotes around them:
490 \consists "Spans_arpeggio_engraver"
493 LilyPond does not strictly require this, but it is a useful
494 convention to follow.
497 All context or layout object strings should be prefaced with @code{#}.
498 Again, LilyPond does not strictly require this, but it is helpful
499 to get users accustomed to this scheme construct, i.e. @code{\set
500 Staff.instrumentName = #"cello"}
503 Try to avoid using @code{#'} or @code{#`} when describing
504 context or layout properties outside of an @code{@@example} or @code{@@lilypond}, unless
505 the description explicitly requires it.
507 i.e. @qq{...setting the @code{transparent} property leaves the object where it
508 is, but makes it invisible.}
511 If possible, only write one bar per line.
514 If you only have one bar per line, omit bar checks. If you
515 must put more than one bar per line (not recommended), then include bar
519 Tweaks should, if possible, also occur on their own line.
521 not: \override TextScript.padding = #3 c1^"hi"
522 but instead: \override TextScript.padding = #3
527 excepted in Templates, where `doctitle' may be omitted.
530 Avoid long stretches of input code. Nobody is going to read
531 them in print. Create small examples. However, this does not mean
535 Specify durations for at least the first note of every bar.
538 If possible, end with a complete bar.
541 Comments should go on their own line, and be placed before
542 the line(s) to which they refer.
545 For clarity, always use @{ @} marks even if they are not technically
551 \context Voice \repeat unfold 2 \relative c' @{
567 Add a space around @{ @} marks; i.e.
570 not: \chordmode@{c e g@}
571 but instead: \chordmode @{ c e g @}
575 Use @{ @} marks for additional @code{\markup} format commands; i.e.
578 not: c^\markup \tiny\sharp
579 but instead: c^\markup @{ \tiny \sharp @}
583 Remove any space around @code{<} @code{>} marks; i.e.
587 but instead: <c e g>4
591 Beam, slur and tie marks should begin immediately after the first
592 note with beam and phrase marks ending immediately after the last.
595 a8\( ais16[ b cis( d] b) cis4~ b' cis,\)
599 If you want to work on an example outside of the manual (for
600 easier/faster processing), use this header:
605 line-width = 160\mm - 2.0 * 0.4\in
606 line-width = #(- line-width (* mm 3.000000))
613 You may not change any of these values. If you are making an
614 example demonstrating special @code{\paper@{@}} values, contact the
615 Documentation Editor.
620 @node Text formatting
621 @subsection Text formatting
625 Lines should be less than 72 characters long. (We personally
626 recommend writing with 66-char lines, but do not bother modifying
627 existing material). Also see the recommendations for fixed-width
628 fonts in the @ref{Syntax survey}.
634 Do not use spaces at the beginning of a line (except in
635 @code{@@example} or @code{@@verbatim} environments), and do not
636 use more than a single space between words. @q{makeinfo} copies
637 the input lines verbatim without removing those spaces.
640 Use two spaces after a period.
643 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
647 Don't use @code{@@rinternals@{@}} in the main text. If you're
648 tempted to do so, you're probably getting too close to @qq{talking
649 through the code}. If you really want to refer to a context, use
650 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
651 the @code{@@seealso}.
656 @subsection Syntax survey
666 * Special characters::
672 @unnumberedsubsubsec Comments
676 @code{@@c @dots{}} --- single line comment. @samp{@@c NOTE:} is a
677 comment which should remain in the final version. (gp only
681 @code{@@ignore} --- multi-line comment:
691 @node Cross references
692 @unnumberedsubsubsec Cross references
694 Enter the exact @code{@@node} name of the target reference between
695 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}). Do not
696 split a cross-reference across two lines -- this causes the
697 cross-reference to be rendered incorrectly in html documents.
701 @code{@@ref@{@dots{}@}} --- link within current manual.
704 @code{@@rchanges@{@dots{}@}} --- link to Changes.
707 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
710 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
713 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
716 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
719 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
722 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
725 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
728 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
731 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
734 @code{@@rweb@{@dots{}@}} --- link to General Information.
739 @unnumberedsubsubsec External links
743 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
746 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
747 external url. Use within an @code{@@example ... @@end example}.
751 @@uref@{URL [, link text ]@}
757 @node Fixed-width font
758 @unnumberedsubsubsec Fixed-width font
762 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
764 Use the @code{@@code@{@dots{}@}} command when referring to
765 individual language-specific tokens (keywords, commands,
766 engravers, scheme symbols, etc.) in the text. Ideally, a single
767 @code{@@code@{@dots{}@}} block should fit within one line in the
770 Use the @code{@@samp@{@dots{}@}} command when you have a short
771 example of user input, unless it constitutes an entire
772 @code{@@item} by itself, in which case @code{@@code@{@dots{}@}} is
773 preferable. Otherwise, both should only be used when part of a
774 larger sentence within a paragraph or @code{@@item}. Do not use
775 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} inside an
776 @code{@@example} block, and do not use either as a free-standing
777 paragraph; use @code{@@example} instead.
779 A single unindented line in the PDF has space for about 79
780 fixed-width characters (76 if indented). Within an @code{@@item}
781 there is space for about 75 fixed-width characters. Each
782 additional level of @code{@@itemize} or @code{@@enumerate}
783 shortens the line by about 4 columns.
785 However, even short blocks of @code{@@code@{@dots{}@}} and
786 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
787 line-breaking algorithm gets confused. Additionally, blocks that
788 are longer than this may in fact print nicely; it all depends
789 where the line breaks end up. If you compile the docs yourself,
790 check the PDF output to make sure the line breaks are
793 The Texinfo setting @code{@@allowcodebreaks} is set to
794 @code{false} in the manuals, so lines within
795 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
796 only break at spaces, not at hyphens or underscores. If the block
797 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
798 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
800 The Texinfo settings @code{txicodequoteundirected} and
801 @code{txicodequotebacktick} are both set in the manuals, so
802 backticks (@code{`}) and apostrophes (@code{'}) placed within
803 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
804 are not converted to left- and right-angled quotes
805 (@code{@quoteleft{} @quoteright{}}) as they normally are within
806 the text, so the apostrophes in
807 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
808 correctly. However, these settings do not affect the PDF output
809 for anything within a @code{@@samp} block (even if it includes a
810 nested @code{@@code} block), so entering
811 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
812 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
813 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
814 which contains backticks or apostrophes, you should instead use
815 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
816 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
817 contains spaces). Note that backslashes within
818 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
819 so the example above would be coded as
820 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
823 @code{@@command@{@dots{}@}} --- Use when referring to command-line
824 commands within the text (eg. @samp{@@command@{convert-ly@}}). Do
825 not use inside an @code{@@example} block.
828 @code{@@example} --- Use for examples of program code. Do not add
829 extraneous indentation (i.e. don't start every line with
830 whitespace). Use the following layout (notice the use of blank
831 lines). Omit the @code{@@noindent} if the text following the
832 example starts a new paragraph:
835 @var{@dots{}text leading into the example@dots{}}
842 @var{continuation of the text@dots{}}
845 Individual lines within an @code{@@example} block should not
846 exceed 74 characters; otherwise they will run into the margin in
847 the PDF output, and may get clipped. If an @code{@@example} block
848 is part of an @code{@@item}, individual lines in the
849 @code{@@example} block should not exceed 70 columns. Each
850 additional level of @code{@@itemize} or @code{@@enumerate}
851 shortens the line by about 4 columns.
853 For long command line examples, if possible, use a trailing
854 backslash to break up a single line, indenting the next line with
855 2 spaces. If this isn't feasible, use @samp{@@smallexample
856 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
857 fontsize. Use @code{@@example} whenever possible, but if needed,
858 @code{@@smallexample} can fit up to 90 characters per line before
859 running into the PDF margin. Each additional level of
860 @code{@@itemize} or @code{@@enumerate} shortens a
861 @code{@@smallexample} line by about 5 columns.
864 @code{@@file@{@dots{}@}} --- Use when referring to filenames and
865 directories in the text. Do not use inside an @code{@@example}
869 @code{@@option@{@dots{}@}} --- Use when referring to command-line
870 options in the text (eg. @samp{@@option@{--format@}}). Do not use
871 inside an @code{@@example} block.
874 @code{@@verbatim} --- Prints the block exactly as it appears in
875 the source file (including whitespace, etc.). For program code
876 examples, use @code{@@example} instead. @code{@@verbatim} uses
877 the same format as @code{@@example}.
879 Individual lines within an @code{@@verbatim} block should not
880 exceed 74 characters; otherwise they will run into the margin in
881 the PDF output, and may get clipped. If an @code{@@verbatim}
882 block is part of an @code{@@item}, individual lines in the
883 @code{@@verbatim} block should not exceed 70 columns. Each
884 additional level of @code{@@itemize} or @code{@@enumerate}
885 shortens the line by about 4 columns.
890 @unnumberedsubsubsec Indexing
894 @code{@@cindex @dots{}} --- General index. Please add as many as you can.
895 Don't capitalize the first word.
898 @code{@@funindex @dots{}} --- is for a \lilycommand.
903 @unnumberedsubsubsec Lists
907 @code{@@enumerate} --- Create an ordered list (with numbers).
908 Always put @samp{@@item} on its own line. As an exception, if all
909 the items in the list are short enough to fit on single lines, placing
910 them on the @samp{@@item} lines is also permissible. @samp{@@item}
911 and @samp{@@end@tie{}enumerate} should always be preceded by a blank
918 A long multi-line item like this one must begin
919 on a line of its own and all the other items in
920 the list must do so too.
939 @code{@@itemize} --- Create an unordered list (with bullets). Use
940 the same format as @code{@@enumerate}. Do not use
941 @samp{@@itemize@tie{}@@bullet}.
945 @node Special characters
946 @unnumberedsubsubsec Special characters
950 @code{--}, @code{---} --- Create an en dash (--) or an em dash
951 (---) in the text. To print two or three literal hyphens in a
952 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
956 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
957 a left curly bracket (@{), or a right curly bracket (@}).
960 @code{@@bs@{@}} --- Create a backslash within a
961 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
962 @code{@@warning@{@dots{}@}} block. This is a custom LilyPond
963 macro, not a builtin @@-command in Texinfo. Texinfo would also
964 allow @samp{\\}, but this breaks the PDF output.
967 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
968 space in the text (use @w{@samp{@@w@{ @}}} for a single
969 @emph{fixed-width} non-breaking space). Variables or numbers
970 which consist of a single character (probably followed by a
971 punctuation mark) should be tied properly, either to the previous
972 or the next word. Example: @samp{The letter@@tie@{@}@@q@{I@} is
978 @unnumberedsubsubsec Miscellany
982 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
983 @samp{@@notation@{clef@}}. Also use for specific lyrics
984 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
985 Only use once per subsection per term.
988 @code{@@q@{@dots{}@}} --- Single quotes. Used for
989 @quoteleft{}vague@quoteright{} terms. To get a backslash
990 (\), you must use @samp{@@bs@{@}}.
993 @code{@@qq@{@dots{}@}} --- Double quotes. Used for actual quotes
994 (@qq{he said}) or for introducing special input modes. To get a
995 backslash (\), you must use @samp{@@bs@{@}}.
998 @code{@@var@{@dots{}@}} --- Use for metasyntactic variables (such
999 as @code{@var{foo}}, @code{@var{bar}}, @code{@var{arg1}}, etc.).
1000 In most cases, when the @code{@@var@{@dots{}@}} command appears in
1001 the text (and not in an @code{@@example} block) it should be
1002 wrapped with an appropriate texinfo code-highlighting command
1003 (such as @code{@@code}, @code{@@samp}, @code{@@file},
1004 @code{@@command}, etc.). For example:
1005 @samp{@@code@{@@var@{foo@}@}},
1006 @samp{@@file@{@@var@{myfile.ly@}@}},
1007 @w{@samp{@@samp@{git checkout @@var@{branch@}@}}}, etc. This
1008 improves readability in the PDF and HTML output.
1011 @code{@@version@{@}} --- Return the current LilyPond version
1012 string. Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
1013 line (to prevent an ugly line break in PDF); use
1014 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
1017 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
1020 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
1021 Use for important messages. To get a backslash (\), you must use
1026 @node Other text concerns
1027 @subsection Other text concerns
1031 References must occur at the end of a sentence, for more
1033 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
1034 manual}. Ideally this should also be the final sentence of a
1035 paragraph, but this is not required. Any link in a doc section
1036 must be duplicated in the @code{@@seealso} section at the bottom.
1039 Introducing examples must be done with
1042 . (i.e. finish the previous sentence/paragraph)
1043 : (i.e. `in this example:')
1044 , (i.e. `may add foo with the blah construct,')
1047 The old @qq{sentence runs directly into the example} method is not
1051 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
1061 When beginning a quote: @qq{So, he said,...}.
1063 This usage is rarer. Americans often just use a comma.
1066 When adding a defining example at the end of a sentence.
1070 Non-ASCII characters which are in utf-8 should be directly used;
1071 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}. This
1072 ensures that all such characters appear in all output formats.
1076 @node Documentation policy
1077 @section Documentation policy
1081 * Section organization::
1082 * Checking cross-references::
1084 * Technical writing style::
1090 There are four parts to the documentation: the Learning Manual,
1091 the Notation Reference, the Program Reference, and the Music
1099 The LM is written in a tutorial style which introduces the most
1100 important concepts, structure and syntax of the elements of a
1101 LilyPond score in a carefully graded sequence of steps.
1102 Explanations of all musical concepts used in the Manual can be
1103 found in the Music Glossary, and readers are assumed to have no
1104 prior knowledge of LilyPond. The objective is to take readers to
1105 a level where the Notation Reference can be understood and
1106 employed to both adapt the templates in the Appendix to their
1107 needs and to begin to construct their own scores. Commonly used
1108 tweaks are introduced and explained. Examples are provided
1109 throughout which, while being focussed on the topic being
1110 introduced, are long enough to seem real in order to retain the
1111 readers' interest. Each example builds on the previous material,
1112 and comments are used liberally. Every new aspect is thoroughly
1113 explained before it is used.
1115 Users are encouraged to read the complete Learning Manual from
1120 Notation Reference: a (hopefully complete) description of LilyPond
1121 input notation. Some material from here may be duplicated in the
1122 Learning Manual (for teaching), but consider the NR to be the
1123 "definitive" description of each notation element, with the LM
1124 being an "extra". The goal is _not_ to provide a step-by-step
1125 learning environment -- do not avoid using notation that has not
1126 be introduced previously in the NR (for example, use \break if
1127 appropriate). This section is written in formal technical writing
1130 Avoid duplication. Although users are not expected to read this
1131 manual from start to finish, they should be familiar with the
1132 material in the Learning Manual (particularly ``Fundamental
1133 Concepts''), so do not repeat that material in each section of
1134 this book. Also watch out for common constructs, like ^ - _ for
1135 directions -- those are explained in NR 3. In NR 1, you can
1136 write: DYNAMICS may be manually placed above or below the staff,
1137 see @@ref@{Controlling direction and placement@}.
1139 Most tweaks should be added to LSR and not placed directly in the
1140 @file{.itely} file. In some cases, tweaks may be placed in the main
1141 text, but ask about this first.
1143 Finally, you should assume that users know what the notation
1144 means; explaining musical concepts happens in the Music Glossary.
1148 Application Usage: information about using the program lilypond
1149 with other programs (lilypond-book, operating systems, GUIs,
1150 convert-ly, etc). This section is written in formal technical
1153 Users are not expected to read this manual from start to finish.
1157 Music Glossary: information about the music notation itself.
1158 Explanations and translations about notation terms go here.
1160 Users are not expected to read this manual from start to finish.
1163 Internals Reference: not really a documentation book, since it is
1164 automagically generated from the source, but this is its name.
1169 @node Section organization
1170 @subsection Section organization
1175 The order of headings inside documentation sections should
1188 You @emph{must} include a @@seealso.
1192 The order of items inside the @@seealso section is
1201 @@rlearning@{foozle@}.
1210 Essay on automated music engraving:
1217 @@file@{path/to/dir/blahz@}.
1219 Snippets: @@rlsr@{section@}.
1221 Internals Reference:
1222 @@rinternals@{fazzle@},
1223 @@rinternals@{booar@}.
1227 If there are multiple entries, separate them by commas but do not
1231 Always end with a period.
1234 Place each link on a new line as above; this makes it much easier
1235 to add or remove links. In the output, they appear on a single
1238 ("Snippets" is REQUIRED; the others are optional)
1241 Any new concepts or links which require an explanation should go
1242 as a full sentence(s) in the main text.
1245 Don't insert an empty line between @@seealso and the first entry!
1246 Otherwise there is excessive vertical space in the PDF output.
1251 To create links, use @@ref@{@} if the link is within the same
1255 @@predefined ... @@endpredefined is for commands in
1259 Do not include any real info in second-level sections (i.e. 1.1
1260 Pitches). A first-level section may have introductory material,
1261 but other than that all material goes into third-level sections
1262 (i.e. 1.1.1 Writing Pitches).
1265 The @@knownissues should not discuss any issues that are in the
1266 tracker, unless the issue is Priority-Postponed. The goal is to
1267 discuss any overall architecture or syntax decisions which may be
1268 interpreted as bugs. Normal bugs should not be discussed here,
1269 because we have so many bugs that it would be a huge task to keep
1270 the @@knownissues current and accurate all the time.
1275 @node Checking cross-references
1276 @subsection Checking cross-references
1278 Cross-references between different manuals are heavily used in the
1279 documentation, but they are not checked during compilation.
1280 However, if you compile the documentation, a script called
1281 check_texi_refs can help you with checking and fixing these
1282 cross-references; for information on usage, cd into a source tree
1283 where documentation has been built, cd into Documentation and run:
1290 Note that you have to find yourself the source files to fix
1291 cross-references in the generated documentation such as the
1292 Internals Reference; e.g. you can grep scm/ and lily/.
1294 @c temporary? how long will kainhofer be used? -gp
1295 Also of interest may be the linkdoc checks on kainhofer.com. Be
1296 warned that these docs are not completely rebuilt every day, so it
1297 might not accurately reflect the current state of the docs.
1300 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1304 @node General writing
1305 @subsection General writing
1310 Do not forget to create @@cindex entries for new sections of text.
1311 Enter commands with @@funindex, i.e.
1314 @@cindex pitches, writing in different octaves
1315 @@funindex \relative
1319 Do not bother with the @@code@{@} (they are added automatically).
1320 These items are added to both the command index and the unified
1321 index. Both index commands should go in front of the actual material.
1324 @@cindex entries should not be capitalized, i.e.
1327 @@cindex time signature
1331 is preferred instead of @qq{Time signature}. Only use capital
1332 letters for musical terms which demand them, e.g.
1336 For scheme function index entries, only include the final part, i.e.
1339 @@funindex modern-voice-cautionary
1341 @@funindex #(set-accidental-style modern-voice-cautionary)
1345 Use American spelling. LilyPond's internal property
1346 names use this convention.
1349 Here is a list of preferred terms to be used:
1353 @emph{Simultaneous} NOT concurrent.
1356 @emph{Measure}: the unit of music.
1359 @emph{Bar line}: the symbol delimiting a measure NOT barline.
1362 @emph{Note head} NOT notehead.
1365 @emph{Chord construct} NOT just chord (when referring to < ... >)
1368 @emph{Staff} NOT stave.
1371 @emph{Staves} NOT Staffs:
1373 @q{multiple @@internalsref@{Staff@}s}
1374 should be rephrased to
1375 @q{multiple @@internalsref@{Staff@} contexts}.
1383 @node Technical writing style
1384 @subsection Technical writing style
1386 These refer to the NR. The LM uses a more gentle, colloquial
1392 Do not refer to LilyPond in the text. The reader knows what the
1393 manual is about. If you do, capitalization is LilyPond.
1396 If you explicitly refer to @q{lilypond} the program (or any other
1397 command to be executed), write @code{@@command@{lilypond@}}.
1400 Do not explicitly refer to the reader/user. There is no one else
1401 besides the reader and the writer.
1404 Avoid contractions (don't, won't, etc.). Spell the words out completely.
1407 Avoid abbreviations, except for commonly used abbreviations of foreign
1408 language terms such as etc. and i.e.
1411 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1415 The use of the word @q{illegal} is inappropriate in most cases.
1416 Say @q{invalid} instead.
1421 @node Tips for writing docs
1422 @section Tips for writing docs
1424 In the NR, I highly recommend focusing on one subsection at a
1425 time. For each subsection,
1430 check the mundane formatting. Are the headings (@@predefined,
1431 @@seealso, etc.) in the right order?
1434 add any appropriate index entries.
1437 check the links in the @@seealso section -- links to music
1438 glossary, internal references, and other NR sections are the main
1439 concern. Check for potential additions.
1442 move LSR-worthy material into LSR. Add the snippet, delete the
1443 material from the @file{.itely} file, and add a @@lilypondfile command.
1446 check the examples and descriptions. Do they still work?
1447 @strong{Do not} assume that the existing text is
1448 accurate/complete; some of the manual is highly out of date.
1451 is the material in the @@knownissues still accurate?
1454 can the examples be improved (made more explanatory), or is there
1455 any missing info? (feel free to ask specific questions on -user;
1456 a couple of people claimed to be interesting in being
1457 @qq{consultants} who would help with such questions)
1461 In general, I favor short text explanations with good examples --
1462 @qq{an example is worth a thousand words}. When I worked on the
1463 docs, I spent about half my time just working on those tiny
1464 lilypond examples. Making easily-understandable examples is much
1465 harder than it looks.
1468 @subsubheading Tweaks
1470 In general, any \set or \override commands should go in the
1471 @qq{select snippets} section, which means that they should go in
1472 LSR and not the @file{.itely} file. For some cases, the command
1473 obviously belongs in the @qq{main text} (i.e. not inside
1474 @@predefined or @@seealso or whatever) -- instrument names are a
1475 good example of this.
1478 \set Staff.instrumentName = #"foo"
1481 On the other side of this,
1484 \override Score.Hairpin.after-line-breaking = ##t
1487 clearly belongs in LSR.
1489 I'm quite willing to discuss specific cases if you think that a
1490 tweaks needs to be in the main text. But items that can go into
1491 LSR are easier to maintain, so I'd like to move as much as
1492 possible into there.
1495 It would be @qq{nice} if you spent a lot of time crafting nice
1496 tweaks for users@dots{} but my recommendation is @strong{not} to do
1497 this. There's a lot of doc work to do without adding examples of
1498 tweaks. Tweak examples can easily be added by normal users by adding
1501 One place where a documentation writer can profitably spend time writing
1502 or upgrading tweaks is creating tweaks to deal with known issues. It
1503 would be ideal if every significant known issue had a workaround to avoid
1507 @ref{Adding and editing snippets}.
1510 @node Scripts to ease doc work
1511 @section Scripts to ease doc work
1514 * Scripts to test the documentation::
1515 * Scripts to create documentation::
1518 @node Scripts to test the documentation
1519 @subsection Scripts to test the documentation
1522 * Building only one section of the documentation::
1525 @node Building only one section of the documentation
1526 @unnumberedsubsubsec Building only one section of the documentation
1528 In order to save build time, a script is available to build only
1529 one section of the documentation in English with a default html
1532 You can build a section of the documentation with:
1535 scripts/auxiliar/doc-section.sh MANUAL SECTION
1539 where @code{SECTION} is the name of the file containing the section
1540 to be built, and @code{MANUAL} is replaced by the name of the directory
1541 containing the section. So, for example, to build section 1.1 of the
1542 Notation Reference, use the command:
1545 scripts/auxiliar/doc-section.sh notation pitches
1548 You can then see the generated document for the section at
1551 tempdocs/pitches/out/pitches.html
1555 @uref{http://code.google.com/p/lilypond/issues/detail?id=1236,Lilypond issue 1236},
1556 the location of the lilypond git tree is taken from @code{$LILYPOND_GIT}
1557 if specified, otherwise it is auto-detected.
1559 It is assumed that compilation takes place in the @file{build/}
1560 subdirectory, but this can be overridden by setting the environment
1561 variable @code{LILYPOND_BUILD_DIR}.
1563 Similarly, output defaults to @file{build/tempdocs/} but this can be
1564 overridden by setting the environment variable
1565 @code{LILYPOND_TEMPDOCS}.
1567 This script will not work for building sections of the
1568 Contributors' guide. For building sections of the Contributors'
1572 scripts/auxiliar/cg-section.sh SECTION
1576 where @code{SECTION} is the name of the file containing the sections
1577 to be built. For example, to build section 4 of the Contributors' guide,
1581 scripts/auxiliar/cg-section.sh doc-work
1584 @code{cg-section.sh} uses the same environment variables and
1585 corresponding default values as @code{doc-section.sh}.
1587 @node Scripts to create documentation
1588 @subsection Scripts to create documentation
1591 * Stripping whitespace and generating menus::
1592 * Stripping whitespace only::
1593 * Updating doc with convert-ly::
1596 @node Stripping whitespace and generating menus
1597 @unnumberedsubsubsec Stripping whitespace and generating menus
1599 @warning{This script assumes that the file conforms to our doc
1600 policy, in particular with regard to @ref{Sectioning commands};
1601 a few files still need work in this regard.}
1603 To automatically regenerate @code{@@menu} portions and strip
1607 scripts/auxiliar/node-menuify.py @var{FILENAME}
1610 If you are adding documentation that requires new menus,
1611 you will need to add a blank @code{@@menu} section:
1618 @node Stripping whitespace only
1619 @unnumberedsubsubsec Stripping whitespace only
1621 @c TODO: should this be documented elsewhere? It's useful for
1622 @c more than just docs.
1623 To remove extra whitespace from the ends of lines, run
1626 scripts/auxiliar/strip-whitespace.py @var{FILENAME}
1630 @node Updating doc with convert-ly
1631 @unnumberedsubsubsec Updating doc with @command{convert-ly}
1633 Don't. This should be done by programmers when they add new
1634 features. If you notice that it hasn't been done, complain to
1635 @code{lilypond-devel}.
1638 @node Docstrings in scheme
1639 @section Docstrings in scheme
1641 Material in the Internals reference is generated automatically
1642 from our source code. Any doc work on Internals therefore
1643 requires modifying files in @file{scm/*.scm}. Texinfo is allowed
1644 in these docstrings.
1646 Most documentation writers never touch these, though. If you want
1647 to work on them, please ask for help.
1650 @node Translating the documentation
1651 @section Translating the documentation
1653 The mailing list @code{translations@@lilynet.net} is dedicated to
1654 LilyPond web site and documentation translation; on this list, you will
1655 get support from the Translations Meister and experienced translators,
1656 and we regularly discuss translation issues common to all languages.
1657 All people interested in LilyPond translations are invited to subscribe
1658 to this list regardless of the amount of their contribution, by sending
1659 an email to @code{translations-request@@lilynet.net} with subject
1660 @code{subscribe} and an empty message body. Unless mentioned explicitly,
1661 or except if a translations coordinator contacts you privately, you
1662 should send questions, remarks and patches to the list
1663 @code{translations@@lilynet.net}. Please note that traffic is high
1664 on the English-speaking list @code{lilypond-user@@gnu.org}, so it may
1665 take some time before your request or contribution is handled.
1668 * Getting started with documentation translation::
1669 * Documentation translation details::
1670 * Documentation translation maintenance::
1671 * Translations management policies::
1672 * Technical background::
1675 @node Getting started with documentation translation
1676 @subsection Getting started with documentation translation
1678 First, get the sources of branch @code{translation} from the
1679 Git repository, see @ref{Starting with Git}.
1682 * Translation requirements::
1683 * Which documentation can be translated::
1684 * Starting translation in a new language::
1687 @node Translation requirements
1688 @unnumberedsubsubsec Translation requirements
1690 Working on LilyPond documentation translations requires the following
1691 pieces of software, in order to make use of dedicated helper tools:
1694 @item Python 2.4 or higher,
1700 It is not required to build LilyPond and the documentation to
1701 translate the documentation. However, if you have enough time and
1702 motivation and a suitable system, it can be very useful to build at
1703 least the documentation so that you can check the output yourself and
1704 more quickly; if you are interested, see @ref{Compiling}.
1706 Before undertaking any large translation work, contributors are
1707 encouraged to contact the @ref{Meisters, Translation Meister}.
1710 @node Which documentation can be translated
1711 @unnumberedsubsubsec Which documentation can be translated
1713 The makefiles and scripts infrastructure currently supports translation
1714 of the following documentation:
1717 @item the web site, the Learning Manual, the Notation Reference and
1718 Application Usage -- Texinfo source, PDF and HTML output; Info output
1719 might be added if there is enough demand for it;
1720 @item the Changes document.
1723 Support for translating the following pieces of documentation should be
1724 added soon, by decreasing order of priority:
1727 @item automatically generated documentation: markup commands,
1728 predefined music functions;
1729 @item the Snippets List;
1730 @item the Internals Reference.
1734 @node Starting translation in a new language
1735 @unnumberedsubsubsec Starting translation in a new language
1737 At top of the source directory, do
1744 or (if you want to install your self-compiled LilyPond locally)
1747 ./autogen.sh --prefix=$HOME
1751 If you want to compile LilyPond -- which is almost required to build
1752 the documentation, but is not required to do translation only -- fix
1753 all dependencies and rerun @command{./configure} (with the same
1754 options as for @command{autogen.sh}).
1756 Then @command{cd} into @file{Documentation/} and run
1759 make ISOLANG=@var{MY-LANGUAGE} new-lang
1763 where @var{MY-LANGUAGE} is the ISO 639 language code.
1765 Finally, add a language definition for your language in
1766 @file{python/langdefs.py}.
1769 @node Documentation translation details
1770 @subsection Documentation translation details
1772 Please follow all the instructions with care to ensure quality work.
1774 All files should be encoded in UTF-8.
1777 * Files to be translated::
1778 * Translating the Web site and other Texinfo documentation::
1779 * Adding a Texinfo manual::
1782 @node Files to be translated
1783 @unnumberedsubsubsec Files to be translated
1785 @include contributor/doc-translation-list.itexi
1787 In addition, not listed above, Snippets' titles and descriptions
1788 should be translated; they are a part of the Notation Reference and
1789 therefore their priority is 5.
1791 @node Translating the Web site and other Texinfo documentation
1792 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1794 Every piece of text should be translated in the source file, except
1795 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1798 Node names are translated, but the original node name in English should
1799 be kept as the argument of @code{@@translationof} put after the section
1800 title; that is, every piece in the original file like
1804 @@@var{section_command} Bar baz
1808 should be translated as
1811 @@node @var{translation of Foo bar}
1812 @@@var{section_command} @var{translation of Bar baz}
1813 @@translationof Foo bar
1816 The argument of @code{@@rglos} commands and the first argument of
1817 @code{@@rglosnamed} commands must not be translated, as it is the node
1818 name of an entry in Music Glossary.
1820 Every time you translate a node name in a cross-reference, i.e. the
1821 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1822 @@ruser} or the first argument of their @code{@var{*}named} variants,
1823 you should make sure the target node is defined in the correct source
1824 file; if you do not intend to translate the target node right now, you
1825 should at least write the node definition (that is, the @code{@@node
1826 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1827 expected source file and define all its parent nodes; for each node you
1828 have defined this way but have not translated, insert a line that
1829 contains @code{@@untranslated}. That is, you should end up
1830 for each untranslated node with something like
1833 @@node @var{translation of Foo bar}
1834 @@@var{section_command} @var{translation of Bar baz}
1835 @@translationof Foo bar
1840 @warning{you do not have to translate the node name of a cross-reference
1841 to a node that you do not have translated. If you do, you must define
1842 an @qq{empty} node like explained just above; this will produce a
1843 cross-reference with the translated node name in output, although the
1844 target node will still be in English. On the opposite, if all
1845 cross-references that refer to an untranslated node use the node name in
1846 English, then you do not have to define such an @qq{empty} node, and the
1847 cross-reference text will appear in English in the output. The choice
1848 between these two strategies implies its particular maintenance
1849 requirements and is left to the translators, although the opinion of the
1850 Translation meister leans towards not translating these
1853 Please think of the fact that it may not make sense translating
1854 everything in some Texinfo files, and you may take distance from the
1855 original text; for instance, in the translation of the web site section
1856 Community, you may take this into account depending on what you know the
1857 community in your language is willing to support, which is possible only
1858 if you personally assume this support, or there exists a public forum
1859 or mailing list listed in Community for LilyPond in your language:
1862 @item @rweb{Bug reports}: this page should be translated only if you
1863 know that every bug report sent on your language's mailing list or forum
1864 will be handled by someone who will translate it to English and send it
1865 on bug-lilypond or add an issue in the tracker, then translate back the
1866 reply from developers.
1868 @item @rweb{Help us}: this page should be translated very freely,
1869 and possibly not at all: ask help for contributing to LilyPond for tasks
1870 that LilyPond community in your language is able and going to handle.
1874 In any case, please mark in your work the sections which do not result
1875 from the direct translation of a piece of English translation, using
1876 comments i.e. lines starting with @q{@code{@@c}}.
1878 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1879 menus. This process should be made easier in the future, when the helper
1880 script @command{texi-langutils.py} and the makefile target are updated.
1882 Some pieces of text manipulated by build scripts that appear in the
1883 output are translated in a @file{.po} file -- just like LilyPond output
1884 messages -- in @file{Documentation/po}. The Gettext domain is named
1885 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1886 through the Free Translation Project.
1889 Take care of using typographic rules for your language, especially in
1890 @file{macros.itexi}.
1892 If you wonder whether a word, phrase or larger piece of text should be
1893 translated, whether it is an argument of a Texinfo command or a small
1894 piece sandwiched between two Texinfo commands, try to track whether and
1895 where it appears in PDF and/or HTML output as visible text. This piece
1896 of advice is especially useful for translating @file{macros.itexi}.
1898 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1899 blocs). However, some music snippets containing text that shows in
1900 the rendered music, and sometimes translating this text really helps
1901 the user to understand the documentation; in this case, and only in
1902 this case, you may as an exception translate text in the music
1903 snippet, and then you must add a line immediately before the
1904 @code{@@lilypond} block, starting with
1911 Otherwise the music snippet would be reset to the same content as the
1912 English version at next @command{make snippet-update} run -- see
1913 @ref{Updating documentation translation}.
1918 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1922 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1923 translate the @code{texidoc} header field it contains, enclose it with
1924 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1925 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}.
1926 Additionally, you may translate the snippet's title in @code{doctitle}
1927 header field, in case @code{doctitle} is a fragment option used in
1928 @code{@@lilypondfile}; you can do this exactly the same way as
1929 @code{texidoc}. For instance,
1930 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}
1934 doctitlees = "Spanish title baz"
1936 Spanish translation blah
1940 @code{@@example} blocks need not be verbatim copies, e.g. variable
1941 names, file names and comments should be translated.
1943 Finally, please carefully apply every rule exposed in @ref{Texinfo
1944 introduction and usage policy}, and @ref{Documentation policy}. If one
1945 of these rules conflicts with a rule specific to your language, please
1946 ask the Translation meister on @email{translations@@lilynet.net} list
1947 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1951 @node Adding a Texinfo manual
1952 @unnumberedsubsubsec Adding a Texinfo manual
1954 In order to start translating a new manual whose basename is @var{FOO},
1958 cd Documentation/@var{MY-LANGUAGE}
1959 cp ../@var{FOO}.tely .
1961 cp web/GNUmakefile @var{FOO}
1965 then append @var{FOO} to variable @code{SUBDIRS} in
1966 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1967 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1971 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1975 Your are now ready to translate the new manual exactly like the web site
1976 or the Learning Manual.
1979 @node Documentation translation maintenance
1980 @subsection Documentation translation maintenance
1982 Several tools have been developed to make translations maintenance
1983 easier. These helper scripts make use of the power of Git, the
1984 version control system used for LilyPond development.
1986 You should use them whenever you would like to update the translation in
1987 your language, which you may do at the frequency that fits your and your
1988 cotranslators' respective available times. In the case your translation
1989 is up-do-date (which you can discover in the first subsection below), it
1990 is enough to check its state every one or two weeks. If you feel
1991 overwhelmed by the quantity of documentation to be updated, see
1992 @ref{Maintaining without updating translations}.
1995 * Check state of translation::
1996 * Updating documentation translation::
1997 * Updating translation committishes::
2000 @macro seeCommittishesUpdate{}
2001 @warning{do not forget to update the committish in each file you have
2002 completely updated, see @ref{Updating translation committishes}.}
2005 @node Check state of translation
2006 @unnumberedsubsubsec Check state of translation
2008 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
2009 unless you are sure to master the translation state checking and
2010 updating system -- then cd into @file{Documentation/} (or at top of the
2011 source tree, replace @command{make} with @command{make -C
2012 Documentation}) and run
2015 make ISOLANG=@var{MY_LANGUAGE} check-translation
2019 This presents a diff of the original files since the most recent
2020 revision of the translation. To check a single file, cd into
2021 @file{Documentation/} and run
2024 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
2028 In case this file has been renamed since you last updated the
2029 translation, you should specify both old and new file names, e.g.
2030 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
2032 To see only which files need to be updated, do
2035 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
2038 To avoid printing terminal colors control characters, which is often
2039 desirable when you redirect output to a file, run
2042 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
2045 You can see the diffs generated by the commands above as changes that
2046 you should make in your language to the existing translation, in order
2047 to make your translation up to date.
2049 @seeCommittishesUpdate
2051 Global state of the translation is recorded in
2052 @file{Documentation/translations.itexi}, which is used to generate
2053 Translations status page. To update that page, do from
2054 @file{Documentation/}
2057 make translation-status
2060 This will also leave @file{out/translations-status.txt}, which contains
2061 up-to-dateness percentages for each translated file, and update word
2062 counts of documentation files in this Guide.
2065 @ref{Maintaining without updating translations}.
2067 @node Updating documentation translation
2068 @unnumberedsubsubsec Updating documentation translation
2070 Instead of running @code{check-translation}, you may want to run
2071 @code{update-translation}, which will run your favorite text editor to
2072 update files. First, make sure environment variable @code{EDITOR} is
2073 set to a text editor command, then run from @file{Documentation/}
2076 make ISOLANG=@var{MY_LANGUAGE} update-translation
2080 or to update a single file
2083 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
2086 For each file to be updated, @code{update-translation} will open your
2087 text editor with this file and a diff of the file in English; if the
2088 diff cannot be generated or is bigger than the file in English itself,
2089 the full file in English will be opened instead.
2091 @seeCommittishesUpdate
2093 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
2094 containing only the first node of the original file in English can be
2095 updated automatically: whenever @command{make check-translation} shows
2096 that such files should be updated, run from @file{Documentation/}
2099 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
2102 @file{.po} message catalogs in @file{Documentation/po/} may be updated
2103 by issuing from @file{Documentation/} or @file{Documentation/po/}
2109 @warning{if you run po-update and somebody else does the same and
2110 pushes before you push or send a patch to be applied, there will be a
2111 conflict when you pull. Therefore, it is better that only the
2112 Translation meister runs this command.}
2114 Updating music snippets can quickly become cumbersome, as most
2115 snippets should be identical in all languages. Fortunately, there is
2116 a script that can do this odd job for you (run from
2117 @file{Documentation/}):
2120 make ISOLANG=@var{MY_LANGUAGE} snippet-update
2123 This script overwrites music snippets in
2124 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
2125 @file{@var{foo/every.itely}}. It ignores skeleton files, and keeps
2126 intact music snippets preceded with a line starting with @code{@@c
2127 KEEP LY}; it reports an error for each @file{.itely} that has not the
2128 same music snippet count in both languages. Always use this script
2129 with a lot of care, i.e. run it on a clean Git working tree, and check
2130 the changes it made with @command{git diff} before committing; if you
2131 don't do so, some @code{@@lilypond} snippets might be broken or make
2132 no sense in their context.
2134 Finally, a command runs the three update processes above for all
2135 enabled languages (from @file{Documentation/}):
2138 make all-translations-update
2141 Use this command with caution, and keep in mind it will not be really
2142 useful until translations are stabilized after the end of GDP and GOP.
2145 @ref{Maintaining without updating translations},
2146 @ref{Adding and editing snippets}.
2149 @node Updating translation committishes
2150 @unnumberedsubsubsec Updating translation committishes
2152 At the beginning of each translated file except PO files, there is a
2153 committish which represents the revision of the sources which you have
2154 used to translate this file from the file in English.
2156 When you have pulled and updated a translation, it is very important to
2157 update this committish in the files you have completely updated (and
2158 only these); to do this, first commit possible changes to any
2159 documentation in English which you are sure to have done in your
2160 translation as well, then replace in the up-to-date translated files the
2161 old committish by the committish of latest commit, which can be obtained
2165 git rev-list HEAD |head -1
2168 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
2169 @c contains a helper script which could be used to perform massive
2170 @c committish updates.
2172 Most of the changes in the LSR snippets included in the documentation concern
2173 the syntax, not the description inside @code{texidoc=""}. This implies that
2174 quite often you will have to update only the committish of the matching
2175 .texidoc file. This can be a tedious work if there are many snippets to be
2176 marked as up do date. You can use the following command to update the
2177 committishes at once:
2180 cd Documentation/LANG/texidocs
2181 sed -i -r 's/[0-9a-z]@{40@}/NEW-COMMITTISH/' *.texidoc
2187 @node Translations management policies
2188 @subsection Translations management policies
2190 These policies show the general intent of how the translations should
2191 be managed, they aim at helping translators, developers and
2192 coordinators work efficiently.
2195 * Maintaining without updating translations::
2196 * Managing documentation translation with Git::
2199 @node Maintaining without updating translations
2200 @unnumberedsubsubsec Maintaining without updating translations
2202 Keeping translations up to date under heavy changes in the documentation
2203 in English may be almost impossible, especially as during the former
2204 Grand Documentation Project (GDP) or the Grand Organization Project
2205 (GOP) when a lot of contributors brings changes. In addition,
2206 translators may be --- and that is a very good thing --- involved in
2209 it is possible --- and even recommended --- to perform some maintenance
2210 that keeps translated documentation usable and eases future translation
2211 updating. The rationale below the tasks list motivates this plan.
2213 The following tasks are listed in decreasing priority order.
2216 @item Update macros.itexi.
2217 For each obsolete macro definition, if it is possible to update macro
2218 usage in documentation with an automatic text or regexp substitution,
2219 do it and delete the macro definition from @file{macros.itexi}; otherwise,
2220 mark this macro definition as obsolete with a comment, and keep it in
2221 @file{macros.itexi} until the documentation translation has been updated and
2222 no longer uses this macro.
2224 @item Update @file{*.tely} files completely with
2225 @command{make check-translation} -- you may want to redirect output
2226 to a file because of overwhelming output, or call check-translation.py
2227 on individual files, see @ref{Check state of translation}.
2229 @item In @file{.itelys}, match sections and .itely file names with those from
2230 English docs, which possibly involves moving nodes contents in block
2231 between files, without updating contents itself. In other words, the
2232 game is catching where has gone each section. In Learning manual, and
2233 in Notation Reference sections which have been revised in GDP, there may
2234 be completely new sections: in this case, copy @code{@@node} and
2235 @code{@@section}-command from English docs, and add the marker for
2236 untranslated status @code{@@untranslated} on a single line. Note that
2237 it is not possible to exactly match subsections or subsubsections of
2238 documentation in English, when contents has been deeply revised; in this
2239 case, keep obsolete (sub)subsections in the translation, marking them
2240 with a line @code{@@c obsolete} just before the node.
2242 Emacs with Texinfo mode makes this step easier:
2245 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
2246 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
2247 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
2248 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
2249 (e.g. the translated file), copy @code{*Occur*} contents into
2250 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
2252 If you happen to have installed AucTeX, you can either call the macro
2253 by doing @key{M-x texinfo-show-structure} or create a key binding in your
2254 @file{~/.emacs}, by adding the four following lines:
2257 (add-hook 'Texinfo-mode-hook
2259 (define-key Texinfo-mode-map "\C-cs"
2260 'texinfo-show-structure)))
2264 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
2267 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
2268 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
2269 updated all the rest of the file.
2271 @item Moving to next or previous node using incremental search: press
2272 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
2273 contains the word @q{node}) then press @key{C-s} to move to next node
2274 or @key{C-r} to move to previous node. Similar operation can be used
2275 to move to the next/previous section. Note that every cursor move
2276 exits incremental search, and hitting @key{C-s} twice starts
2277 incremental search with the text entered in previous incremental
2280 @item Moving a whole node (or even a sequence of nodes): jump to beginning
2281 of the node (quit incremental search by pressing an arrow), press
2282 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
2283 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
2284 the right place (moving between nodes with the previous hint is often
2285 useful) and paste with @key{C-y} or @key{C-v}.
2288 @item Update sections finished in the English documentation; check
2291 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
2294 @item Update documentation PO. It is recommended not to update
2295 strings which come from documentation that is currently deeply revised
2296 in English, to avoid doing the work more than once.
2298 @item Fix broken cross-references by running (from @file{Documentation/})
2301 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
2305 This step requires a successful documentation build (with @command{make
2306 doc}). Some cross-references are broken because they point to a node
2307 that exists in the documentation in English, which has not been added
2308 to the translation; in this case, do not fix the cross-reference but
2309 keep it "broken", so that the resulting HTML link will point to an
2310 existing page of documentation in English.
2313 @subsubheading Rationale
2315 You may wonder if it would not be better to leave translations as-is
2316 until you can really start updating translations. There are several
2317 reasons to do these maintenance tasks right now.
2320 @item This will have to be done sooner or later anyway, before updating
2321 translation of documentation contents, and this can already be done
2322 without needing to be redone later, as sections of documentation in
2323 English are mostly revised once. However, note that not all
2324 documentation sectioning has been revised in one go, so all this
2325 maintenance plan has to be repeated whenever a big reorganization is
2328 @item This just makes translated documentation take advantage of the new
2329 organization, which is better than the old one.
2331 @item Moving and renaming sections to match sectioning of documentation in
2332 English simplify future updating work: it allows updating the
2333 translation by side-by-side comparison, without bothering whether
2334 cross-reference names already exist in the translation.
2336 @item Each maintenance task except @q{Updating PO files} can be done by
2337 the same person for all languages, which saves overall time spent by
2338 translators to achieve this task: the node names and section titles
2339 are in English, so you can do. It is important to take advantage of
2340 this now, as it will be more complicated (but still possible) to do
2341 step 3 in all languages when documentation is compiled with
2342 @command{texi2html} and node names are directly translated in source
2347 @node Managing documentation translation with Git
2348 @unnumberedsubsubsec Managing documentation translation with Git
2350 This policy explains how to manage Git branches and commit
2351 translations to Git.
2354 @item Translation work is made on
2355 @code{translation} branch. This branch is merged on
2356 @code{staging} once a week, approximately. Then,
2357 @code{master} branch is merged on
2358 @code{translation}, where the check-translation script (see
2359 @ref{Check state of translation}) shows changes in English docs which
2360 should be translated, and the cycle starts again.
2362 @item Translations may be pushed directly to
2363 @code{staging} only if they do not break compilation of LilyPond and
2364 its documentation. Those changes could be pushed to
2365 @code{translation} too, or alternatively translators could wait until
2367 @code{master} the next time it is merged on
2368 @code{translation}. Similarly, changes matching
2369 @code{stable/X.Y} are preferably made on
2370 @code{X.Ytranslation}.
2372 @item @code{translation} Git branch may be merged into
2373 @code{staging} branch only if LilyPond (@command{make all}) and
2374 documentation (@command{make doc}) compile successfully.
2376 @item @command{make} and @command{make doc} are usually successful in
2377 @code{master} Git branch because those tests should have already
2379 @code{staging} branch before merging.
2380 @code{master} branch may be merged into
2381 @code{translation} when significant changes had been made in
2382 documentation in English in
2383 @code{master} branch.
2385 @item General maintenance may be done by anybody who knows what he does
2386 in documentation in all languages, without informing translators
2387 first. General maintenance include simple text substitutions
2388 (e.g. automated by sed), compilation fixes, updating Texinfo or
2389 lilypond-book commands, updating macros, updating ly code, fixing
2390 cross-references, and operations described in
2391 @ref{Maintaining without updating translations}.
2395 @node Technical background
2396 @subsection Technical background
2398 A number of Python scripts handle a part of the documentation
2399 translation process. All scripts used to maintain the translations
2400 are located in @file{scripts/auxiliar/}.
2403 @item @file{check_translation.py} -- show diff to update a translation,
2404 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
2405 make message catalogs and Texinfo skeleton files,
2406 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2407 @item @file{update-snippets.py} -- synchronize ly snippets with those
2409 @item @file{translations-status.py} -- update translations status pages and word
2410 counts in the file you are reading,
2411 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2412 in the sources; WARNING only use this script once for each file, when support for
2413 "makeinfo --html" has been dropped.
2416 Other scripts are used in the build process, in @file{scripts/build/}:
2419 @item @file{mass-link.py} -- link or symlink files between English documentation
2420 and documentation in other languages.
2423 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
2424 not by installed Python scripts) are located in @file{python/auxiliar/}:
2426 @item @file{manuals_definitions.py} -- define manual names and name of
2427 cross-reference Texinfo macros,
2428 @item @file{buildlib.py} -- common functions (read piped output
2429 of a shell command, use Git),
2430 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
2431 tweak links in HTML pages.
2436 @item @file{python/langdefs.py} -- language definitions module