]> git.donarmstrong.com Git - lilypond.git/blob - Documentation/contributor/doc-work.itexi
Doc: Adjusted CG Policy on @lilypond[] variables
[lilypond.git] / Documentation / contributor / doc-work.itexi
1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @node Documentation work
3 @chapter Documentation work
4
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
9 set of source files.
10
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}.
14
15 @menu
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::
24 @end menu
25
26
27 @node Introduction to documentation work
28 @section Introduction to documentation work
29
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.
39
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.
53
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.
59
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.
64
65 Before undertaking any large documentation work, contributors are
66 encouraged to contact the @ref{Meisters, Documentation Meister}.
67
68
69 @node Documentation suggestions
70 @section Documentation suggestions
71
72 @subheading Small additions
73
74 For additions to the documentation,
75
76 @enumerate
77
78 @item
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").
81
82 @item
83 Please write exact changes to the text.
84
85 @item
86 A formal patch to the source code is @emph{not} required; we can
87 take care of the technical details.
88
89 @item
90 Send the suggestions to the @code{bug-lilypond} mailing list as
91 discussed in @rweb{Contact}.
92
93 @item
94 Here is an example of a perfect documentation report:
95
96 @verbatim
97 To: bug-lilypond@gnu.org
98 From: helpful-user@example.net
99 Subject: doc addition
100
101 In LM 2.13 (printing lyrics), above the last line ("More options,
102 like..."), please add:
103
104 ----
105 To add lyrics to a divided part, use blah blah blah.  For example,
106
107 \score {
108   \notes {blah <<blah>> }
109   \lyrics {blah <<blah>> }
110   blah blah blah
111 }
112 ----
113
114 In addition, the second sentence of the first paragraph is
115 confusing.  Please delete that sentence (it begins "Users
116 often...") and replace it with this:
117 ----
118 To align lyrics with something, do this thing.
119 ----
120
121 Have a nice day,
122 Helpful User
123 @end verbatim
124
125 @end enumerate
126
127
128 @subheading Larger contributions
129
130 To replace large sections of the documentation, the guidelines are
131 stricter.  We cannot remove parts of the current documentation
132 unless we are certain that the new version is an improvement.
133
134 @enumerate
135
136 @item
137 Ask on the lilypond-devel mailing list if such a rewrite is necessary;
138 somebody else might already be working on this issue!
139
140 @item
141 Split your work into small sections; this makes it much easier to
142 compare the new and old documentation.
143
144 @item
145 Please prepare a formal git patch.
146
147 @end enumerate
148
149 Once you have followed these guidelines, please send a message to
150 lilypond-devel with your documentation submissions.  Unfortunately
151 there is a strict “no top-posting” check on the mailing list; to avoid
152 this, add:
153
154 > I'm not top posting.
155
156 (you must include the > ) to the top of your documentation
157 addition.
158
159 We may edit your suggestion for spelling, grammar, or style, and
160 we may not place the material exactly where you suggested, but if
161 you give us some material to work with, we can improve the manual
162 much faster.  Thanks for your interest!
163
164
165 @node Texinfo introduction and usage policy
166 @section Texinfo introduction and usage policy
167
168 @menu
169 * Texinfo introduction::
170 * Documentation files::
171 * Sectioning commands::
172 * LilyPond formatting::
173 * Text formatting::
174 * Syntax survey::
175 * Other text concerns::
176 @end menu
177
178
179 @node Texinfo introduction
180 @subsection Texinfo introduction
181
182 The language is called Texinfo; you can see its manual here:
183
184 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
185
186 However, you don't need to read those docs.  The most important
187 thing to notice is that text is text.  If you see a mistake in the
188 text, you can fix it.  If you want to change the order of
189 something, you can cut-and-paste that stuff into a new location.
190
191 @warning{Rule of thumb: follow the examples in the existing docs.
192 You can learn most of what you need to know from this; if you want
193 to do anything fancy, discuss it on @code{lilypond-devel} first.}
194
195
196 @node Documentation files
197 @subsection Documentation files
198
199 All manuals live in @file{Documentation/}.
200
201 In particular, there are four user manuals, their respective master
202 source files are @file{learning.tely} (LM, Learning Manual),
203 @file{notation.tely} (NR, Notation Reference),
204 @file{music-glossary.tely} (MG, Music Glossary), and
205 @file{lilypond-program} (AU).  Each chapter is written in a separate
206 file, ending in @file{.itely} for files containing lilypond code, and
207 @file{.itexi} for files without lilypond code, located in a subdirectory
208 associated to the manual (@file{learning/} for @file{learning.tely}, and
209 so on); list the subdirectory of each manual to determine the filename
210 of the specific chapter you wish to modify.
211
212 Developer manuals live in @file{Documentation/} too.  Currently there is
213 only one: the Contributor's Guide @file{contrib-guide.texi} you are
214 reading.
215
216 Snippet files are part of documentation, and the Snippet List (SL) lives
217 in @file{Documentation/} just like the manuals.  For information about
218 how to modify the snippet files and SL, see @ref{LSR work}.
219
220
221 @node Sectioning commands
222 @subsection Sectioning commands
223
224 Most of the manual operates at the
225
226 @example
227 @@node Foo
228 @@subsubsection Foo
229 @end example
230
231 @noindent
232 level.  Sections are created with
233
234 @example
235 @@node Foo
236 @@subsection Foo
237 @end example
238
239 @itemize
240 @item
241 Please leave two blank lines above a @code{@@node}; this makes it
242 easier to find sections in texinfo.
243
244 @item
245 Do not use any @code{@@} commands for a @code{@@node}.  They may be
246 used for any @code{@@sub...} sections or headings however.
247
248 @example
249 not:
250 @@node @@code@{Foo@} Bar
251 @@subsection @@code@{Foo@} Bar
252
253 but instead:
254 @@node Foo Bar
255 @@subsection @@code@{Foo@} Bar
256 @end example
257
258 @item
259 If a heading is desired without creating a @code{@@node}, please use
260 the following:
261
262 @example
263 @@subheading Foo
264 @end example
265
266 @item
267 Sectioning commands (@code{@@node} and @code{@@section}) must not appear
268 inside an @code{@@ignore}.  Separate those commands with a space, ie
269 @code{@@n}@tie{}@code{ode}.
270
271 @end itemize
272
273 Nodes must be included inside a
274
275 @example
276 @@menu
277 * foo::
278 * bar::
279 @@end menu
280 @end example
281
282 @noindent
283 construct.  These are easily constructed with automatic tools; see
284 @ref{Scripts to ease doc work}.
285
286
287 @node LilyPond formatting
288 @subsection LilyPond formatting
289
290 @itemize
291
292 @item
293 Most LilyPond examples throughout the documentation can be produced
294 with:
295
296 @example
297 @@lilypond[verbatim,quote,relative=1]
298 @end example
299
300 or
301
302 @example
303 @@lilypond[verbatim,quote,relative=2]
304 @end example
305
306 If using any combination of @code{\header@{@}}, @code{\score@{@}} or
307 @code{\layout@{@}} in your example, then you must omit the
308 @code{relative} variable and either use absolute entry mode or an
309 explicit @code{\relative@{@}} construction.
310
311 If using @code{\book@{@}} in your example then you must also omit the
312 @code{relative} variable and either use absolute entry mode or an
313 explicit @code{\relative@{@}} construction.  However, you must also
314 include the @code{papersize=X} variable, where @code{X} is a defined
315 paper size from within @file{scm/paper.scm}.  This is to avoid the
316 default @code{a4} paper size being used and leaving too much unnecessary
317 whitespace and potentially awkward page breaks in the PDFs.
318
319 The preferred @code{papersize}s are @code{a5}, @code{a6} or
320 @code{a8landscape}.
321
322 @code{a8landscape} works best for a single measure with a single title
323 and/or single @code{tagline}:
324
325 @lilypond[papersize=a8landscape,verbatim]
326 \book {
327   \header {
328     title = "A scale in LilyPond"
329   }
330   \relative {
331     c d e f
332   }
333 }
334 @end lilypond
335
336 and can also be used to easily show features that require page breaks
337 (i.e. page numbers) without taking large amounts of space within the
338 documentation.  Do not use the @code{quote} option with this paper size.
339
340 @code{a5} or @code{a6} paper sizes are best used for examples that have
341 more than two measures of music or require multiple staves (i.e. to
342 illustrate cross-staff features, RH and LH parts etc.) and where
343 @code{\book@{@}} constructions are required or where @code{a8landscape}
344 produces an example that is too cramped.  Depending on the example the
345 @code{quote} option may need to be omitted.
346
347 In rare cases, other options may be used (or omitted), but ask first.
348
349 @item
350 Please avoid using extra spacing either after or within the
351 @code{@@lilypond} parameters.
352
353 @example
354 not:          @@lilypond [verbatim, quote, relative=1]
355 but instead:  @@lilypond[verbatim,quote,relative=1]
356 @end example
357
358 @item
359 Inspirational headwords are produced with:
360
361 @example
362 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
363 @{pitches-headword.ly@}
364 @end example
365
366 @item
367 LSR snippets are linked with:
368
369 @example
370 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
371 @{filename.ly@}
372 @end example
373
374 @item
375 Use two spaces for indentation in lilypond examples (no tabs).
376
377 @item
378 All engravers should have double-quotes around them:
379
380 @example
381 \consists "Spans_arpeggio_engraver"
382 @end example
383
384 LilyPond does not strictly require this, but it is a useful
385 convention to follow.
386
387 @item
388 All context or layout object strings should be prefaced with @code{#}.
389 Again, LilyPond does not strictly require this, but it is helpful
390 to get users accustomed to this scheme construct, i.e. @code{\set
391 Staff.instrumentName = #"cello"}
392
393 @item
394 Try to avoid using @code{#'} or @code{#`} within when describing
395 context or layout properties outside of an @code{@@example} or @code{@@lilypond}, unless
396 the description explicitly requires it.
397
398 i.e. @qq{...setting the @code{transparent} property leaves the object where it
399 is, but makes it invisible.}
400
401 @item
402 If possible, only write one bar per line.
403
404 @item
405 If you only have one bar per line, omit bar checks.  If you
406 must put more than one bar per line (not recommended), then include bar
407 checks.
408
409 @item
410 Tweaks should, if possible, also occur on their own line.
411 @example
412 not:          \override TextScript #'padding = #3 c1^"hi"
413 but instead:  \override TextScript #'padding = #3
414               c1^"hi"
415 @end example
416
417 @noindent
418 excepted in Templates, where `doctitle' may be omitted.
419
420 @item
421 Avoid long stretches of input code.  Nobody is going to read
422 them in print.  Create small examples.  However, this does not mean
423 it has be minimal.
424
425 @item
426 Specify durations for at least the first note of every bar.
427
428 @item
429 If possible, end with a complete bar.
430
431 @item
432 Comments should go on their own line, and be placed before
433 the line(s) to which they refer.
434
435 @item
436 For clarity, always use @{ @} marks even if they are not technically
437 required; i.e.
438
439 @example
440 not:
441
442 \context Voice \repeat unfold 2 \relative c' @{
443   c2 d
444 @}
445
446 but instead:
447
448 \context Voice @{
449   \repeat unfold 2 @{
450     \relative c' @{
451       c2 d
452     @}
453   @}
454 @}
455 @end example
456
457 @item
458 Add a space around @{ @} marks; i.e.
459
460 @example
461 not:          \chordmode@{c e g@}
462 but instead:  \chordmode @{ c e g @}
463 @end example
464
465 @item
466 Use @{ @} marks for additional @code{\markup} format commands; i.e.
467
468 @example
469 not:          c^\markup \tiny\sharp
470 but instead:  c^\markup @{ \tiny \sharp @}
471 @end example
472
473 @item
474 Remove any space around @code{<} @code{>} marks; i.e.
475
476 @example
477 not:           < c e g > 4
478 but instead:   <c e g>4
479 @end example
480
481 @item
482 Beam, slur and tie marks should begin immediately after the first
483 note with beam and phrase marks ending immediately after the last.
484
485 @example
486 a8\( ais16[ b cis( d] b) cis4~ b' cis,\)
487 @end example
488
489 @item
490 If you want to work on an example outside of the manual (for
491 easier/faster processing), use this header:
492
493 @example
494 \paper @{
495   indent = 0\mm
496   line-width = 160\mm - 2.0 * 0.4\in
497   ragged-right = ##t
498   force-assignment = #""
499   line-width = #(- line-width (* mm  3.000000))
500 @}
501
502 \layout @{
503 @}
504 @end example
505
506 You may not change any of these values.  If you are making an
507 example demonstrating special @code{\paper@{@}} values, contact the
508 Documentation Editor.
509
510 @end itemize
511
512
513 @node Text formatting
514 @subsection Text formatting
515
516 @itemize
517 @item
518 Lines should be less than 72 characters long.  (We personally
519 recommend writing with 66-char lines, but do not bother modifying
520 existing material).  Also see the recommendations for fixed-width
521 fonts in the @ref{Syntax survey}.
522
523 @item
524 Do not use tabs.
525
526 @item
527 Do not use spaces at the beginning of a line (except in
528 @code{@@example} or @code{@@verbatim} environments), and do not
529 use more than a single space between words.  @q{makeinfo} copies
530 the input lines verbatim without removing those spaces.
531
532 @item
533 Use two spaces after a period.
534
535 @item
536 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
537 music expression.
538
539 @item
540 Don't use @code{@@rinternals@{@}} in the main text.  If you're
541 tempted to do so, you're probably getting too close to @qq{talking
542 through the code}.  If you really want to refer to a context, use
543 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
544 the @code{@@seealso}.
545 @end itemize
546
547
548 @node Syntax survey
549 @subsection Syntax survey
550
551
552 @menu
553 * Comments::
554 * Cross references::
555 * External links::
556 * Fixed-width font::
557 * Indexing::
558 * Lists::
559 * Special characters::
560 * Miscellany::
561 @end menu
562
563
564 @node Comments
565 @unnumberedsubsubsec Comments
566
567 @itemize
568 @item
569 @code{@@c @dots{}} --- single line comment.  @samp{@@c NOTE:} is a
570 comment which should remain in the final version.  (gp only
571 command ;)
572
573 @item
574 @code{@@ignore} --- multi-line comment:
575
576 @example
577 @@ignore
578 @dots{}
579 @@end ignore
580 @end example
581 @end itemize
582
583
584 @node Cross references
585 @unnumberedsubsubsec Cross references
586
587 Enter the exact @code{@@node} name of the target reference between
588 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}).  Do not
589 split a cross-reference across two lines -- this causes the
590 cross-reference to be rendered incorrectly in html documents.
591
592 @itemize
593 @item
594 @code{@@ref@{@dots{}@}} --- link within current manual.
595
596 @item
597 @code{@@rchanges@{@dots{}@}} --- link to Changes.
598
599 @item
600 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
601
602 @item
603 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
604
605 @item
606 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
607
608 @item
609 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
610
611 @item
612 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
613
614 @item
615 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
616
617 @item
618 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
619
620 @item
621 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
622
623 @item
624 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
625
626 @item
627 @code{@@rweb@{@dots{}@}} --- link to General Information.
628 @end itemize
629
630
631 @node External links
632 @unnumberedsubsubsec External links
633
634 @itemize
635 @item
636 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
637
638 @item
639 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
640 external url.  Use within an @code{@@example ... @@end example}.
641
642 @example
643 @@example
644 @@uref@{URL [, link text ]@}
645 @@end example
646 @end example
647 @end itemize
648
649
650 @node Fixed-width font
651 @unnumberedsubsubsec Fixed-width font
652
653 @itemize
654 @item
655 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
656
657 Use the @code{@@code@{@dots{}@}} command when referring to
658 individual language-specific tokens (keywords, commands,
659 engravers, scheme symbols, etc.) in the text.  Ideally, a single
660 @code{@@code@{@dots{}@}} block should fit within one line in the
661 PDF output.
662
663 Use the @code{@@samp@{@dots{}@}} command when you have a short
664 example of user input, unless it constitutes an entire
665 @code{@@item} by itself, in which case @code{@@code@{@dots{}@}} is
666 preferable.  Otherwise, both should only be used when part of a
667 larger sentence within a paragraph or @code{@@item}.  Do not use
668 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} inside an
669 @code{@@example} block, and do not use either as a free-standing
670 paragraph; use @code{@@example} instead.
671
672 A single unindented line in the PDF has space for about 79
673 fixed-width characters (76 if indented).  Within an @code{@@item}
674 there is space for about 75 fixed-width characters.  Each
675 additional level of @code{@@itemize} or @code{@@enumerate}
676 shortens the line by about 4 columns.
677
678 However, even short blocks of @code{@@code@{@dots{}@}} and
679 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
680 line-breaking algorithm gets confused.  Additionally, blocks that
681 are longer than this may in fact print nicely; it all depends
682 where the line breaks end up.  If you compile the docs yourself,
683 check the PDF output to make sure the line breaks are
684 satisfactory.
685
686 The Texinfo setting @code{@@allowcodebreaks} is set to
687 @code{false} in the manuals, so lines within
688 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
689 only break at spaces, not at hyphens or underscores.  If the block
690 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
691 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
692
693 The Texinfo settings @code{txicodequoteundirected} and
694 @code{txicodequotebacktick} are both set in the manuals, so
695 backticks (@code{`}) and apostrophes (@code{'}) placed within
696 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
697 are not converted to left- and right-angled quotes
698 (@code{@quoteleft{} @quoteright{}}) as they normally are within
699 the text, so the apostrophes in
700 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
701 correctly.  However, these settings do not affect the PDF output
702 for anything within a @code{@@samp} block (even if it includes a
703 nested @code{@@code} block), so entering
704 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
705 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
706 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
707 which contains backticks or apostrophes, you should instead use
708 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
709 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
710 contains spaces).  Note that backslashes within
711 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
712 so the example above would be coded as
713 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
714
715 @item
716 @code{@@command@{@dots{}@}} --- Use when referring to command-line
717 commands within the text (eg. @samp{@@command@{convert-ly@}}).  Do
718 not use inside an @code{@@example} block.
719
720 @item
721 @code{@@example} --- Use for examples of program code.  Do not add
722 extraneous indentation (i.e. don't start every line with
723 whitespace).  Use the following layout (notice the use of blank
724 lines).  Omit the @code{@@noindent} if the text following the
725 example starts a new paragraph:
726
727 @example
728 @var{@dots{}text leading into the example@dots{}}
729
730 @@example
731 @dots{}
732 @@end example
733
734 @@noindent
735 @var{continuation of the text@dots{}}
736 @end example
737
738 Individual lines within an @code{@@example} block should not
739 exceed 74 characters; otherwise they will run into the margin in
740 the PDF output, and may get clipped.  If an @code{@@example} block
741 is part of an @code{@@item}, individual lines in the
742 @code{@@example} block should not exceed 70 columns.  Each
743 additional level of @code{@@itemize} or @code{@@enumerate}
744 shortens the line by about 4 columns.
745
746 For long command line examples, if possible, use a trailing
747 backslash to break up a single line, indenting the next line with
748 2 spaces.  If this isn't feasible, use @samp{@@smallexample
749 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
750 fontsize.  Use @code{@@example} whenever possible, but if needed,
751 @code{@@smallexample} can fit up to 90 characters per line before
752 running into the PDF margin.  Each additional level of
753 @code{@@itemize} or @code{@@enumerate} shortens a
754 @code{@@smallexample} line by about 5 columns.
755
756 @item
757 @code{@@file@{@dots{}@}} --- Use when referring to filenames and
758 directories in the text.  Do not use inside an @code{@@example}
759 block.
760
761 @item
762 @code{@@option@{@dots{}@}} --- Use when referring to command-line
763 options in the text (eg. @samp{@@option@{--format@}}).  Do not use
764 inside an @code{@@example} block.
765
766 @item
767 @code{@@verbatim} --- Prints the block exactly as it appears in
768 the source file (including whitespace, etc.).  For program code
769 examples, use @code{@@example} instead.  @code{@@verbatim} uses
770 the same format as @code{@@example}.
771
772 Individual lines within an @code{@@verbatim} block should not
773 exceed 74 characters; otherwise they will run into the margin in
774 the PDF output, and may get clipped.  If an @code{@@verbatim}
775 block is part of an @code{@@item}, individual lines in the
776 @code{@@verbatim} block should not exceed 70 columns.  Each
777 additional level of @code{@@itemize} or @code{@@enumerate}
778 shortens the line by about 4 columns.
779 @end itemize
780
781
782 @node Indexing
783 @unnumberedsubsubsec Indexing
784
785 @itemize
786 @item
787 @code{@@cindex @dots{}} --- General index.  Please add as many as you can.
788 Don't capitalize the first word.
789
790 @item
791 @code{@@funindex @dots{}} --- is for a \lilycommand.
792 @end itemize
793
794
795 @node Lists
796 @unnumberedsubsubsec Lists
797
798 @itemize
799 @item
800 @code{@@enumerate} --- Create an ordered list (with numbers).
801 Always put @samp{@@item} on its own line.  As an exception, if all
802 the items in the list are short enough to fit on single lines, placing
803 them on the @samp{@@item} lines is also permissible.  @samp{@@item}
804 and @samp{@@end@tie{}enumerate} should always be preceded by a blank
805 line.
806
807 @example
808 @@enumerate
809
810 @@item
811 A long multi-line item like this one must begin
812 on a line of its own and all the other items in
813 the list must do so too.
814
815 @@item
816 Even short ones
817
818 @@end enumerate
819 @end example
820
821 @example
822 @@enumerate
823
824 @@item Short item
825
826 @@item Short item
827
828 @@end enumerate
829 @end example
830
831 @item
832 @code{@@itemize} --- Create an unordered list (with bullets).  Use
833 the same format as @code{@@enumerate}.  Do not use
834 @samp{@@itemize@tie{}@@bullet}.
835 @end itemize
836
837
838 @node Special characters
839 @unnumberedsubsubsec Special characters
840
841 @itemize
842 @item
843 @code{--}, @code{---} --- Create an en dash (--) or an em dash
844 (---) in the text.  To print two or three literal hyphens in a
845 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
846 @samp{-@@w@{-@}-}).
847
848 @item
849 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
850 a left curly bracket (@{), or a right curly bracket (@}).
851
852 @item
853 @code{@@bs@{@}} --- Create a backslash within a
854 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
855 @code{@@warning@{@dots{}@}} block.  This is a custom LilyPond
856 macro, not a builtin @@-command in Texinfo.  Texinfo would also
857 allow @samp{\\}, but this breaks the PDF output.
858
859 @item
860 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
861 space in the text (use @w{@samp{@@w@{ @}}} for a single
862 @emph{fixed-width} non-breaking space).  Variables or numbers
863 which consist of a single character (probably followed by a
864 punctuation mark) should be tied properly, either to the previous
865 or the next word.  Example: @samp{The letter@@tie@{@}@@q@{I@} is
866 skipped}
867 @end itemize
868
869
870 @node Miscellany
871 @unnumberedsubsubsec Miscellany
872
873 @itemize
874 @item
875 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
876 @samp{@@notation@{clef@}}.  Also use for specific lyrics
877 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
878 Only use once per subsection per term.
879
880 @item
881 @code{@@q@{@dots{}@}} --- Single quotes.  Used for
882 @quoteleft{}vague@quoteright{} terms.  To get a backslash
883 (\), you must use @samp{@@bs@{@}}.
884
885 @item
886 @code{@@qq@{@dots{}@}} --- Double quotes.  Used for actual quotes
887 (@qq{he said}) or for introducing special input modes.  To get a
888 backslash (\), you must use @samp{@@bs@{@}}.
889
890 @item
891 @code{@@var@{@dots{}@}} --- Use for metasyntactic variables (such
892 as @code{@var{foo}}, @code{@var{bar}}, @code{@var{arg1}}, etc.).
893 In most cases, when the @code{@@var@{@dots{}@}} command appears in
894 the text (and not in an @code{@@example} block) it should be
895 wrapped with an appropriate texinfo code-highlighting command
896 (such as @code{@@code}, @code{@@samp}, @code{@@file},
897 @code{@@command}, etc.).  For example:
898 @samp{@@code@{@@var@{foo@}@}},
899 @samp{@@file@{@@var@{myfile.ly@}@}},
900 @w{@samp{@@samp@{git checkout @@var@{branch@}@}}}, etc.  This
901 improves readability in the PDF and HTML output.
902
903 @item
904 @code{@@version@{@}} --- Return the current LilyPond version
905 string.  Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
906 line (to prevent an ugly line break in PDF); use
907 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
908
909 @item
910 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
911
912 @item
913 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
914 Use for important messages.  To get a backslash (\), you must use
915 @samp{@@bs@{@}}.
916 @end itemize
917
918
919 @node Other text concerns
920 @subsection Other text concerns
921
922 @itemize
923 @item
924 References must occur at the end of a sentence, for more
925 information see the
926 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
927 manual}.  Ideally this should also be the final sentence of a
928 paragraph, but this is not required.  Any link in a doc section
929 must be duplicated in the @code{@@seealso} section at the bottom.
930
931 @item
932 Introducing examples must be done with
933
934 @example
935 . (i.e. finish the previous sentence/paragraph)
936 : (i.e. `in this example:')
937 , (i.e. `may add foo with the blah construct,')
938 @end example
939
940 The old @qq{sentence runs directly into the example} method is not
941 allowed any more.
942
943 @item
944 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
945
946 @item
947 Colon usage
948
949 @enumerate
950 @item
951 To introduce lists
952
953 @item
954 When beginning a quote: @qq{So, he said,...}.
955
956 This usage is rarer.  Americans often just use a comma.
957
958 @item
959 When adding a defining example at the end of a sentence.
960 @end enumerate
961
962 @item
963 Non-ASCII characters which are in utf-8 should be directly used;
964 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}.  This
965 ensures that all such characters appear in all output formats.
966 @end itemize
967
968
969 @node Documentation policy
970 @section Documentation policy
971
972 @menu
973 * Books::
974 * Section organization::
975 * Checking cross-references::
976 * General writing::
977 * Technical writing style::
978 @end menu
979
980 @node Books
981 @subsection Books
982
983 There are four parts to the documentation: the Learning Manual,
984 the Notation Reference, the Program Reference, and the Music
985 Glossary.
986
987 @itemize
988
989 @item
990 Learning Manual:
991
992 The LM is written in a tutorial style which introduces the most
993 important concepts, structure and syntax of the elements of a
994 LilyPond score in a carefully graded sequence of steps.
995 Explanations of all musical concepts used in the Manual can be
996 found in the Music Glossary, and readers are assumed to have no
997 prior knowledge of LilyPond.  The objective is to take readers to
998 a level where the Notation Reference can be understood and
999 employed to both adapt the templates in the Appendix to their
1000 needs and to begin to construct their own scores.  Commonly used
1001 tweaks are introduced and explained.  Examples are provided
1002 throughout which, while being focussed on the topic being
1003 introduced, are long enough to seem real in order to retain the
1004 readers' interest.  Each example builds on the previous material,
1005 and comments are used liberally.  Every new aspect is thoroughly
1006 explained before it is used.
1007
1008 Users are encouraged to read the complete Learning Manual from
1009 start-to-finish.
1010
1011
1012 @item
1013 Notation Reference: a (hopefully complete) description of LilyPond
1014 input notation.  Some material from here may be duplicated in the
1015 Learning Manual (for teaching), but consider the NR to be the
1016 "definitive" description of each notation element, with the LM
1017 being an "extra".  The goal is _not_ to provide a step-by-step
1018 learning environment -- do not avoid using notation that has not
1019 be introduced previously in the NR  (for example, use \break if
1020 appropriate).  This section is written in formal technical writing
1021 style.
1022
1023 Avoid duplication.  Although users are not expected to read this
1024 manual from start to finish, they should be familiar with the
1025 material in the Learning Manual (particularly ``Fundamental
1026 Concepts''), so do not repeat that material in each section of
1027 this book.  Also watch out for common constructs, like ^ - _ for
1028 directions -- those are explained in NR 3.  In NR 1, you can
1029 write: DYNAMICS may be manually placed above or below the staff,
1030 see @@ref@{Controlling direction and placement@}.
1031
1032 Most tweaks should be added to LSR and not placed directly in the
1033 @file{.itely} file.  In some cases, tweaks may be placed in the main
1034 text, but ask about this first.
1035
1036 Finally, you should assume that users know what the notation
1037 means; explaining musical concepts happens in the Music Glossary.
1038
1039
1040 @item
1041 Application Usage: information about using the program lilypond
1042 with other programs (lilypond-book, operating systems, GUIs,
1043 convert-ly, etc).  This section is written in formal technical
1044 writing style.
1045
1046 Users are not expected to read this manual from start to finish.
1047
1048
1049 @item
1050 Music Glossary: information about the music notation itself.
1051 Explanations and translations about notation terms go here.
1052
1053 Users are not expected to read this manual from start to finish.
1054
1055 @item
1056 Internals Reference: not really a documentation book, since it is
1057 automagically generated from the source, but this is its name.
1058
1059 @end itemize
1060
1061
1062 @node Section organization
1063 @subsection Section organization
1064
1065 @itemize
1066
1067 @item
1068 The order of headings inside documentation sections should
1069 be:
1070
1071 @example
1072 main docs
1073 @@predefined
1074 @@endpredefined
1075 @@snippets
1076 @@seealso
1077 @@knownissues
1078 @end example
1079
1080 @item
1081 You @emph{must} include a @@seealso.
1082
1083 @itemize
1084 @item
1085 The order of items inside the @@seealso section is
1086
1087 @example
1088 Music Glossary:
1089 @@rglos@{foo@},
1090 @@rglos@{bar@}.
1091
1092 Learning Manual:
1093 @@rlearning@{baz@},
1094 @@rlearning@{foozle@}.
1095
1096 Notation Reference:
1097 @@ruser@{faazle@},
1098 @@ruser@{boo@}.
1099
1100 Application Usage:
1101 @@rprogram@{blah@}.
1102
1103 Essay on automated music engraving:
1104 @@ressay@{yadda@}.
1105
1106 Extending LilyPond:
1107 @@rextend@{frob@}.
1108
1109 Installed Files:
1110 @@file@{path/to/dir/blahz@}.
1111
1112 Snippets: @@rlsr@{section@}.
1113
1114 Internals Reference:
1115 @@rinternals@{fazzle@},
1116 @@rinternals@{booar@}.
1117 @end example
1118
1119 @item
1120 If there are multiple entries, separate them by commas but do not
1121 include an `and'.
1122
1123 @item
1124 Always end with a period.
1125
1126 @item
1127 Place each link on a new line as above; this makes it much easier
1128 to add or remove links.  In the output, they appear on a single
1129 line.
1130
1131 ("Snippets" is REQUIRED; the others are optional)
1132
1133 @item
1134 Any new concepts or links which require an explanation should go
1135 as a full sentence(s) in the main text.
1136
1137 @item
1138 Don't insert an empty line between @@seealso and the first entry!
1139 Otherwise there is excessive vertical space in the PDF output.
1140
1141 @end itemize
1142
1143 @item
1144 To create links, use @@ref@{@} if the link is within the same
1145 manual.
1146
1147 @item
1148 @@predefined ... @@endpredefined is for commands in
1149 @file{ly/*-init.ly}
1150
1151 @item
1152 Do not include any real info in second-level sections (i.e. 1.1
1153 Pitches).  A first-level section may have introductory material,
1154 but other than that all material goes into third-level sections
1155 (i.e. 1.1.1 Writing Pitches).
1156
1157 @item
1158 The @@knownissues should not discuss any issues that are in the
1159 tracker, unless the issue is Priority-Postponed.  The goal is to
1160 discuss any overall architecture or syntax decisions which may be
1161 interpreted as bugs.  Normal bugs should not be discussed here,
1162 because we have so many bugs that it would be a huge task to keep
1163 the @@knownissues current and accurate all the time.
1164
1165 @end itemize
1166
1167
1168 @node Checking cross-references
1169 @subsection Checking cross-references
1170
1171 Cross-references between different manuals are heavily used in the
1172 documentation, but they are not checked during compilation.
1173 However, if you compile the documentation, a script called
1174 check_texi_refs can help you with checking and fixing these
1175 cross-references; for information on usage, cd into a source tree
1176 where documentation has been built, cd into Documentation and run:
1177
1178 @example
1179 make check-xrefs
1180 make fix-xrefs
1181 @end example
1182
1183 Note that you have to find yourself the source files to fix
1184 cross-references in the generated documentation such as the
1185 Internals Reference; e.g. you can grep scm/ and lily/.
1186
1187 @c temporary?  how long will kainhofer be used?  -gp
1188 Also of interest may be the linkdoc checks on kainhofer.com.  Be
1189 warned that these docs are not completely rebuilt every day, so it
1190 might not accurately reflect the current state of the docs.
1191
1192 @example
1193 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1194 @end example
1195
1196
1197 @node General writing
1198 @subsection General writing
1199
1200 @itemize
1201
1202 @item
1203 Do not forget to create @@cindex entries for new sections of text.
1204 Enter commands with @@funindex, i.e.
1205
1206 @example
1207 @@cindex pitches, writing in different octaves
1208 @@funindex \relative
1209 @end example
1210
1211 @noindent
1212 Do not bother with the @@code@{@} (they are added automatically).
1213 These items are added to both the command index and the unified
1214 index.  Both index commands should go in front of the actual material.
1215
1216 @item
1217 @@cindex entries should not be capitalized, i.e.
1218
1219 @example
1220 @@cindex time signature
1221 @end example
1222
1223 @noindent
1224 is preferred instead of @qq{Time signature}.  Only use capital
1225 letters for musical terms which demand them, e.g.
1226 @qq{D.S. al Fine}.
1227
1228 @item
1229 For scheme function index entries, only include the final part, i.e.
1230
1231 @example
1232 @@funindex modern-voice-cautionary
1233      and NOT
1234 @@funindex #(set-accidental-style modern-voice-cautionary)
1235 @end example
1236
1237 @item
1238 Use American spelling.  LilyPond's internal property
1239 names use this convention.
1240
1241 @item
1242 Here is a list of preferred terms to be used:
1243
1244 @itemize
1245 @item
1246 @emph{Simultaneous} NOT concurrent.
1247
1248 @item
1249 @emph{Measure}: the unit of music.
1250
1251 @item
1252 @emph{Bar line}: the symbol delimiting a measure NOT barline.
1253
1254 @item
1255 @emph{Note head} NOT notehead.
1256
1257 @item
1258 @emph{Chord construct} NOT just chord (when referring to < ... >)
1259
1260 @item
1261 @emph{Staff} NOT stave.
1262
1263 @item
1264 @emph{Staves} NOT Staffs:
1265 Phrases such as
1266 @q{multiple @@internalsref@{Staff@}s}
1267 should be rephrased to
1268 @q{multiple @@internalsref@{Staff@} contexts}.
1269
1270 @end itemize
1271
1272
1273 @end itemize
1274
1275
1276 @node Technical writing style
1277 @subsection Technical writing style
1278
1279 These refer to the NR.  The LM uses a more gentle, colloquial
1280 style.
1281
1282 @itemize
1283
1284 @item
1285 Do not refer to LilyPond in the text.  The reader knows what the
1286 manual is about.  If you do, capitalization is LilyPond.
1287
1288 @item
1289 If you explicitly refer to @q{lilypond} the program (or any other
1290 command to be executed), write @code{@@command@{lilypond@}}.
1291
1292 @item
1293 Do not explicitly refer to the reader/user.  There is no one else
1294 besides the reader and the writer.
1295
1296 @item
1297 Avoid contractions (don't, won't, etc.).  Spell the words out completely.
1298
1299 @item
1300 Avoid abbreviations, except for commonly used abbreviations of foreign
1301 language terms such as etc. and i.e.
1302
1303 @item
1304 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1305 @qq{Currently,}).
1306
1307 @item
1308 The use of the word @q{illegal} is inappropriate in most cases.
1309 Say @q{invalid} instead.
1310
1311 @end itemize
1312
1313
1314 @node Tips for writing docs
1315 @section Tips for writing docs
1316
1317 In the NR, I highly recommend focusing on one subsection at a
1318 time.  For each subsection,
1319
1320 @itemize
1321
1322 @item
1323 check the mundane formatting.  Are the headings (@@predefined,
1324 @@seealso, etc.) in the right order?
1325
1326 @item
1327 add any appropriate index entries.
1328
1329 @item
1330 check the links in the @@seealso section -- links to music
1331 glossary, internal references, and other NR sections are the main
1332 concern.  Check for potential additions.
1333
1334 @item
1335 move LSR-worthy material into LSR.  Add the snippet, delete the
1336 material from the @file{.itely} file, and add a @@lilypondfile command.
1337
1338 @item
1339 check the examples and descriptions.  Do they still work?
1340 @strong{Do not} assume that the existing text is
1341 accurate/complete; some of the manual is highly out of date.
1342
1343 @item
1344 is the material in the @@knownissues  still accurate?
1345
1346 @item
1347 can the examples be improved (made more explanatory), or is there
1348 any missing info?  (feel free to ask specific questions on -user;
1349 a couple of people claimed to be interesting in being
1350 @qq{consultants} who would help with such questions)
1351
1352 @end itemize
1353
1354 In general, I favor short text explanations with good examples --
1355 @qq{an example is worth a thousand words}.  When I worked on the
1356 docs, I spent about half my time just working on those tiny
1357 lilypond examples.  Making easily-understandable examples is much
1358 harder than it looks.
1359
1360
1361 @subsubheading Tweaks
1362
1363 In general, any \set or \override commands should go in the
1364 @qq{select snippets} section, which means that they should go in
1365 LSR and not the @file{.itely} file.  For some cases, the command
1366 obviously belongs in the @qq{main text} (i.e. not inside
1367 @@predefined or @@seealso or whatever) -- instrument names are a
1368 good example of this.
1369
1370 @example
1371 \set Staff.instrumentName = #"foo"
1372 @end example
1373
1374 On the other side of this,
1375
1376 @example
1377 \override Score.Hairpin #'after-line-breaking = ##t
1378 @end example
1379
1380 clearly belongs in LSR.
1381
1382 I'm quite willing to discuss specific cases if you think that a
1383 tweaks needs to be in the main text.  But items that can go into
1384 LSR are easier to maintain, so I'd like to move as much as
1385 possible into there.
1386
1387
1388 It would be @qq{nice} if you spent a lot of time crafting nice
1389 tweaks for users@dots{} but my recommendation is @strong{not} to do
1390 this.  There's a lot of doc work to do without adding examples of
1391 tweaks.  Tweak examples can easily be added by normal users by adding
1392 them to the LSR.
1393
1394 One place where a documentation writer can profitably spend time writing
1395 or upgrading tweaks is creating tweaks to deal with known issues.  It
1396 would be ideal if every significant known issue had a workaround to avoid
1397 the difficulty.
1398
1399 @seealso
1400 @ref{Adding and editing snippets}.
1401
1402
1403 @node Scripts to ease doc work
1404 @section Scripts to ease doc work
1405
1406 @subheading Building only one section of the documentation
1407
1408 In order to save build time, a script is available to build only
1409 one section of the documentation in English with a default html
1410 appearance.
1411
1412 The script is available as:
1413
1414 @example
1415 scripts/auxiliar/doc-section.sh
1416 @end example
1417
1418 This script will require customization for your site if your
1419 LilyPond git repository is anyplace but @code{$HOME/lilypond}.
1420
1421 Assuming that no customization is required, you can setup the
1422 single section build with:
1423
1424 @example
1425 mkdir $HOME/lilypond/tempdocs
1426 cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs
1427 @end example
1428
1429 You can then build a section of the documentation with:
1430
1431 @example
1432 scripts/auxiliar/doc-section.sh MANUAL SECTION
1433 @end example
1434
1435 @noindent
1436 where @code{SECTION} is the name of the file containing the section
1437 to be built, and @code{MANUAL} is replaced by the name of the directory
1438 containing the section.  So, for example, to build section 1.1 of the
1439 Notation Reference, use the command:
1440
1441 @example
1442 scripts/auxiliar/doc-section.sh notation pitches
1443 @end example
1444
1445 This script will not work for building sections of the
1446 Contributors' guide.  For building sections of the Contributors'
1447 Guide, use:
1448
1449 @example
1450 scripts/auxiliar/cg-section.sh SECTION
1451 @end example
1452
1453 @noindent
1454 where @code{SECTION} is the name of the file containing the sections
1455 to be built.  For example, to build section 4 of the Contributors' guide,
1456 use:
1457
1458 @example
1459 scripts/auxiliar/cg-section.sh doc-work
1460 @end example
1461
1462 Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
1463 for your installation.
1464
1465 @subheading Stripping whitespace and generating menus
1466
1467 @warning{This script assumes that the file conforms to our doc
1468 policy; a few files still need work in this regard.}
1469
1470 To automatically regenerate @code{@@menu} portions and strip
1471 whitespace, use:
1472
1473 @example
1474 scripts/auxiliar/node-menuify.py @var{FILENAME}
1475 @end example
1476
1477
1478 @subheading Stripping whitespace only
1479
1480 @c TODO: should this be documented elsewhere?  It's useful for
1481 @c more than just docs.
1482 To remove extra whitespace from the ends of lines, run
1483
1484 @example
1485 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1486 @end example
1487
1488
1489 @subheading Updating doc with @command{convert-ly}
1490
1491 Don't.  This should be done by programmers when they add new
1492 features.  If you notice that it hasn't been done, complain to
1493 @code{lilypond-devel}.
1494
1495
1496 @node Docstrings in scheme
1497 @section Docstrings in scheme
1498
1499 Material in the Internals reference is generated automatically
1500 from our source code.  Any doc work on Internals therefore
1501 requires modifying files in @file{scm/*.scm}.  Texinfo is allowed
1502 in these docstrings.
1503
1504 Most documentation writers never touch these, though.  If you want
1505 to work on them, please ask for help.
1506
1507
1508 @node Translating the documentation
1509 @section Translating the documentation
1510
1511 The mailing list @code{translations@@lilynet.net} is dedicated to
1512 LilyPond web site and documentation translation; on this list, you will
1513 get support from the Translations Meister and experienced translators,
1514 and we regularly discuss translation issues common to all languages.
1515 All people interested in LilyPond translations are invited to subscribe
1516 to this list regardless of the amount of their contribution, by sending
1517 an email to @code{translations-request@@lilynet.net} with subject
1518 @code{subscribe} and an empty message body.  Unless mentioned explicitly,
1519 or except if a translations coordinator contacts you privately, you
1520 should send questions, remarks and patches to the list
1521 @code{translations@@lilynet.net}.  Please note that traffic is high
1522 on the English-speaking list @code{lilypond-user@@gnu.org}, so it may
1523 take some time before your request or contribution is handled.
1524
1525 @menu
1526 * Getting started with documentation translation::
1527 * Documentation translation details::
1528 * Documentation translation maintenance::
1529 * Translations management policies::
1530 * Technical background::
1531 @end menu
1532
1533 @node Getting started with documentation translation
1534 @subsection Getting started with documentation translation
1535
1536 First, get the sources of branch @code{lilypond/translation} from the
1537 Git repository, see @ref{Starting with Git}.
1538
1539 @menu
1540 * Translation requirements::
1541 * Which documentation can be translated::
1542 * Starting translation in a new language::
1543 @end menu
1544
1545 @node Translation requirements
1546 @unnumberedsubsubsec Translation requirements
1547
1548 Working on LilyPond documentation translations requires the following
1549 pieces of software, in order to make use of dedicated helper tools:
1550
1551 @itemize
1552 @item Python 2.4 or higher,
1553 @item GNU Make,
1554 @item Gettext,
1555 @item Git.
1556 @end itemize
1557
1558 It is not required to build LilyPond and the documentation to
1559 translate the documentation.  However, if you have enough time and
1560 motivation and a suitable system, it can be very useful to build at
1561 least the documentation so that you can check the output yourself and
1562 more quickly; if you are interested, see @ref{Compiling}.
1563
1564 Before undertaking any large translation work, contributors are
1565 encouraged to contact the @ref{Meisters, Translation Meister}.
1566
1567
1568 @node Which documentation can be translated
1569 @unnumberedsubsubsec Which documentation can be translated
1570
1571 The makefiles and scripts infrastructure currently supports translation
1572 of the following documentation:
1573
1574 @itemize
1575 @item the web site, the Learning Manual, the Notation Reference and
1576 Application Usage -- Texinfo source, PDF and HTML output; Info output
1577 might be added if there is enough demand for it;
1578 @item the Changes document.
1579 @end itemize
1580
1581 Support for translating the following pieces of documentation should be
1582 added soon, by decreasing order of priority:
1583
1584 @itemize
1585 @item automatically generated documentation: markup commands,
1586 predefined music functions;
1587 @item the Snippets List;
1588 @item the Internals Reference.
1589 @end itemize
1590
1591
1592 @node Starting translation in a new language
1593 @unnumberedsubsubsec Starting translation in a new language
1594
1595 At top of the source directory, do
1596
1597 @example
1598 ./autogen.sh
1599 @end example
1600
1601 @noindent
1602 or (if you want to install your self-compiled LilyPond locally)
1603
1604 @example
1605 ./autogen.sh --prefix=$HOME
1606 @end example
1607
1608 @noindent
1609 If you want to compile LilyPond -- which is almost required to build
1610 the documentation, but is not required to do translation only -- fix
1611 all dependencies and rerun @command{./configure} (with the same
1612 options as for @command{autogen.sh}).
1613
1614 Then @command{cd} into @file{Documentation/} and run
1615
1616 @example
1617 make ISOLANG=@var{MY-LANGUAGE} new-lang
1618 @end example
1619
1620 @noindent
1621 where @var{MY-LANGUAGE} is the ISO 639 language code.
1622
1623 Finally, add a language definition for your language in
1624 @file{python/langdefs.py}.
1625
1626
1627 @node Documentation translation details
1628 @subsection Documentation translation details
1629
1630 Please follow all the instructions with care to ensure quality work.
1631
1632 All files should be encoded in UTF-8.
1633
1634 @menu
1635 * Files to be translated::
1636 * Translating the Web site and other Texinfo documentation::
1637 * Adding a Texinfo manual::
1638 @end menu
1639
1640 @node Files to be translated
1641 @unnumberedsubsubsec Files to be translated
1642
1643 @include contributor/doc-translation-list.itexi
1644
1645 In addition, not listed above, Snippets' titles and descriptions
1646 should be translated; they are a part of the Notation Reference and
1647 therefore their priority is 5.
1648
1649 @node Translating the Web site and other Texinfo documentation
1650 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1651
1652 Every piece of text should be translated in the source file, except
1653 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1654 mentioned below.
1655
1656 Node names are translated, but the original node name in English should
1657 be kept as the argument of @code{@@translationof} put after the section
1658 title; that is, every piece in the original file like
1659
1660 @example
1661 @@node Foo bar
1662 @@@var{section_command} Bar baz
1663 @end example
1664
1665 @noindent
1666 should be translated as
1667
1668 @example
1669 @@node @var{translation of Foo bar}
1670 @@@var{section_command} @var{translation of Bar baz}
1671 @@translationof Foo bar
1672 @end example
1673
1674 The argument of @code{@@rglos} commands and the first argument of
1675 @code{@@rglosnamed} commands must not be translated, as it is the node
1676 name of an entry in Music Glossary.
1677
1678 Every time you translate a node name in a cross-reference, i.e. the
1679 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1680 @@ruser} or the first argument of their @code{@var{*}named} variants,
1681 you should make sure the target node is defined in the correct source
1682 file; if you do not intend to translate the target node right now, you
1683 should at least write the node definition (that is, the @code{@@node
1684 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1685 expected source file and define all its parent nodes; for each node you
1686 have defined this way but have not translated, insert a line that
1687 contains @code{@@untranslated}.  That is, you should end up
1688 for each untranslated node with something like
1689
1690 @example
1691 @@node @var{translation of Foo bar}
1692 @@@var{section_command} @var{translation of Bar baz}
1693 @@translationof Foo bar
1694
1695 @@untranslated
1696 @end example
1697
1698 @warning{you do not have to translate the node name of a cross-reference
1699 to a node that you do not have translated.  If you do, you must define
1700 an @qq{empty} node like explained just above; this will produce a
1701 cross-reference with the translated node name in output, although the
1702 target node will still be in English.  On the opposite, if all
1703 cross-references that refer to an untranslated node use the node name in
1704 English, then you do not have to define such an @qq{empty} node, and the
1705 cross-reference text will appear in English in the output.  The choice
1706 between these two strategies implies its particular maintenance
1707 requirements and is left to the translators, although the opinion of the
1708 Translation meister leans towards not translating these
1709 cross-references.}
1710
1711 Please think of the fact that it may not make sense translating
1712 everything in some Texinfo files, and you may take distance from the
1713 original text; for instance, in the translation of the web site section
1714 Community, you may take this into account depending on what you know the
1715 community in your language is willing to support, which is possible only
1716 if you personally assume this support, or there exists a public forum
1717 or mailing list listed in Community for LilyPond in your language:
1718
1719 @itemize
1720 @item @rweb{Bug reports}: this page should be translated only if you
1721 know that every bug report sent on your language's mailing list or forum
1722 will be handled by someone who will translate it to English and send it
1723 on bug-lilypond or add an issue in the tracker, then translate back the
1724 reply from developers.
1725
1726 @item @rweb{Help us}: this page should be translated very freely,
1727 and possibly not at all: ask help for contributing to LilyPond for tasks
1728 that LilyPond community in your language is able and going to handle.
1729 @end itemize
1730
1731 @noindent
1732 In any case, please mark in your work the sections which do not result
1733 from the direct translation of a piece of English translation, using
1734 comments i.e. lines starting with @q{@code{@@c}}.
1735
1736 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1737 menus.  This process should be made easier in the future, when the helper
1738 script @command{texi-langutils.py} and the makefile target are updated.
1739
1740 Some pieces of text manipulated by build scripts that appear in the
1741 output are translated in a @file{.po} file -- just like LilyPond output
1742 messages -- in @file{Documentation/po}.  The Gettext domain is named
1743 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1744 through the Free Translation Project.
1745
1746
1747 Take care of using typographic rules for your language, especially in
1748 @file{macros.itexi}.
1749
1750 If you wonder whether a word, phrase or larger piece of text should be
1751 translated, whether it is an argument of a Texinfo command or a small
1752 piece sandwiched between two Texinfo commands, try to track whether and
1753 where it appears in PDF and/or HTML output as visible text.  This piece
1754 of advice is especially useful for translating @file{macros.itexi}.
1755
1756 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1757 blocs).  However, some music snippets containing text that shows in
1758 the rendered music, and sometimes translating this text really helps
1759 the user to understand the documentation; in this case, and only in
1760 this case, you may as an exception translate text in the music
1761 snippet, and then you must add a line immediately before the
1762 @code{@@lilypond} block, starting with
1763
1764 @example
1765 @@c KEEP LY
1766 @end example
1767
1768 @noindent
1769 Otherwise the music snippet would be reset to the same content as the
1770 English version at next @command{make snippet-update} run -- see
1771 @ref{Updating documentation translation}.
1772
1773 When you encounter
1774
1775 @example
1776 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1777 @end example
1778
1779 @noindent
1780 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1781 translate the @code{texidoc} header field it contains, enclose it with
1782 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1783 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}.
1784 Additionally, you may translate the snippet's title in @code{doctitle}
1785 header field, in case @code{doctitle} is a fragment option used in
1786 @code{@@lilypondfile}; you can do this exactly the same way as
1787 @code{texidoc}.  For instance,
1788 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@/@var{filename}.texidoc}
1789 may contain
1790
1791 @example
1792 doctitlees = "Spanish title baz"
1793 texidoces = "
1794 Spanish translation blah
1795 "
1796 @end example
1797
1798 @noindent
1799 Then, you should get these translated strings into compiled snippets in
1800 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1801 and editing snippets}.
1802
1803 @code{@@example} blocks need not be verbatim copies, e.g. variable
1804 names, file names and comments should be translated.
1805
1806 Finally, please carefully apply every rule exposed in @ref{Texinfo
1807 introduction and usage policy}, and @ref{Documentation policy}.  If one
1808 of these rules conflicts with a rule specific to your language, please
1809 ask the Translation meister on @email{translations@@lilynet.net} list
1810 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1811 list.
1812
1813
1814 @node Adding a Texinfo manual
1815 @unnumberedsubsubsec Adding a Texinfo manual
1816
1817 In order to start translating a new manual whose basename is @var{FOO},
1818 do
1819
1820 @example
1821 cd Documentation/@var{MY-LANGUAGE}
1822 cp ../@var{FOO}.tely .
1823 mkdir @var{FOO}
1824 cp web/GNUmakefile @var{FOO}
1825 @end example
1826
1827 @noindent
1828 then append @var{FOO} to variable @code{SUBDIRS} in
1829 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1830 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1831
1832 @example
1833 cd Documentation/
1834 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1835 @end example
1836
1837 @noindent
1838 Your are now ready to translate the new manual exactly like the web site
1839 or the Learning Manual.
1840
1841
1842 @node Documentation translation maintenance
1843 @subsection Documentation translation maintenance
1844
1845 Several tools have been developed to make translations maintenance
1846 easier.  These helper scripts make use of the power of Git, the
1847 version control system used for LilyPond development.
1848
1849 You should use them whenever you would like to update the translation in
1850 your language, which you may do at the frequency that fits your and your
1851 cotranslators' respective available times.  In the case your translation
1852 is up-do-date (which you can discover in the first subsection below), it
1853 is enough to check its state every one or two weeks.  If you feel
1854 overwhelmed by the quantity of documentation to be updated, see
1855 @ref{Maintaining without updating translations}.
1856
1857 @menu
1858 * Check state of translation::
1859 * Updating documentation translation::
1860 * Updating translation committishes::
1861 @end menu
1862
1863 @macro seeCommittishesUpdate{}
1864 @warning{do not forget to update the committish in each file you have
1865 completely updated, see @ref{Updating translation committishes}.}
1866 @end macro
1867
1868 @node Check state of translation
1869 @unnumberedsubsubsec Check state of translation
1870
1871 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1872 unless you are sure to master the translation state checking and
1873 updating system -- then cd into @file{Documentation/} (or at top of the
1874 source tree, replace @command{make} with @command{make -C
1875 Documentation}) and run
1876
1877 @example
1878 make ISOLANG=@var{MY_LANGUAGE} check-translation
1879 @end example
1880
1881 @noindent
1882 This presents a diff of the original files since the most recent
1883 revision of the translation.  To check a single file, cd into
1884 @file{Documentation/} and run
1885
1886 @example
1887 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1888 @end example
1889
1890 @noindent
1891 In case this file has been renamed since you last updated the
1892 translation, you should specify both old and new file names, e.g.
1893 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1894
1895 To see only which files need to be updated, do
1896
1897 @example
1898 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1899 @end example
1900
1901 To avoid printing terminal colors control characters, which is often
1902 desirable when you redirect output to a file, run
1903
1904 @example
1905 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1906 @end example
1907
1908 You can see the diffs generated by the commands above as changes that
1909 you should make in your language to the existing translation, in order
1910 to make your translation up to date.
1911
1912 @seeCommittishesUpdate
1913
1914 Global state of the translation is recorded in
1915 @file{Documentation/translations.itexi}, which is used to generate
1916 Translations status page.  To update that page, do from
1917 @file{Documentation/}
1918
1919 @example
1920 make translation-status
1921 @end example
1922
1923 This will also leave @file{out/translations-status.txt}, which contains
1924 up-to-dateness percentages for each translated file, and update word
1925 counts of documentation files in this Guide.
1926
1927 @seealso
1928 @ref{Maintaining without updating translations}.
1929
1930 @node Updating documentation translation
1931 @unnumberedsubsubsec Updating documentation translation
1932
1933 Instead of running @code{check-translation}, you may want to run
1934 @code{update-translation}, which will run your favorite text editor to
1935 update files.  First, make sure environment variable @code{EDITOR} is
1936 set to a text editor command, then run from @file{Documentation/}
1937
1938 @example
1939 make ISOLANG=@var{MY_LANGUAGE} update-translation
1940 @end example
1941
1942 @noindent
1943 or to update a single file
1944
1945 @example
1946 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1947 @end example
1948
1949 For each file to be updated, @code{update-translation} will open your
1950 text editor with this file and a diff of the file in English; if the
1951 diff cannot be generated or is bigger than the file in English itself,
1952 the full file in English will be opened instead.
1953
1954 @seeCommittishesUpdate
1955
1956 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1957 containing only the first node of the original file in English can be
1958 updated automatically: whenever @command{make check-translation} shows
1959 that such files should be updated, run from @file{Documentation/}
1960
1961 @example
1962 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1963 @end example
1964
1965 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1966 by issuing from @file{Documentation/} or @file{Documentation/po/}
1967
1968 @example
1969 make po-update
1970 @end example
1971
1972 @warning{if you run po-update and somebody else does the same and
1973 pushes before you push or send a patch to be applied, there will be a
1974 conflict when you pull.  Therefore, it is better that only the
1975 Translation meister runs this command.}
1976
1977 Updating music snippets can quickly become cumbersome, as most
1978 snippets should be identical in all languages.  Fortunately, there is
1979 a script that can do this odd job for you (run from
1980 @file{Documentation/}):
1981
1982 @example
1983 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1984 @end example
1985
1986 This script overwrites music snippets in
1987 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1988 @file{@var{foo/every.itely}}.  It ignores skeleton files, and keeps
1989 intact music snippets preceded with a line starting with @code{@@c
1990 KEEP LY}; it reports an error for each @file{.itely} that has not the
1991 same music snippet count in both languages.  Always use this script
1992 with a lot of care, i.e. run it on a clean Git working tree, and check
1993 the changes it made with @command{git diff} before committing; if you
1994 don't do so, some @code{@@lilypond} snippets might be broken or make
1995 no sense in their context.
1996
1997 When you have updated texidocs in
1998 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
1999 changes into compiled snippets in @file{Documentation/snippets}, see
2000 @q{General guidelines} in @ref{Adding and editing snippets}.
2001
2002 Finally, a command runs the three update processes above for all
2003 enabled languages (from @file{Documentation/}):
2004
2005 @example
2006 make all-translations-update
2007 @end example
2008
2009 Use this command with caution, and keep in mind it will not be really
2010 useful until translations are stabilized after the end of GDP and GOP.
2011
2012 @seealso
2013 @ref{Maintaining without updating translations},
2014 @ref{Adding and editing snippets}.
2015
2016
2017 @node Updating translation committishes
2018 @unnumberedsubsubsec Updating translation committishes
2019
2020 At the beginning of each translated file except PO files, there is a
2021 committish which represents the revision of the sources which you have
2022 used to translate this file from the file in English.
2023
2024 When you have pulled and updated a translation, it is very important to
2025 update this committish in the files you have completely updated (and
2026 only these); to do this, first commit possible changes to any
2027 documentation in English which you are sure to have done in your
2028 translation as well, then replace in the up-to-date translated files the
2029 old committish by the committish of latest commit, which can be obtained
2030 by doing
2031
2032 @example
2033 git rev-list HEAD |head -1
2034 @end example
2035
2036 A special case is updating Snippet documentation strings in
2037 @file{Documentation/@var{MY-LANGUAGE}/texidocs}.  For these to be
2038 correctly marked as up-to-date, first run @code{makelsr.py} as
2039 explained in @ref{Adding and editing snippets}, and commit the
2040 resulting compiled snippets left in @file{Documentation/snippets/}.
2041 Say the SHA1 ID code of this commit is <C>.  Now edit again your
2042 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
2043 adjusting the 40-digit committish that appears in the text to be <C>;
2044 finally, commit these updated files.  Not doing so would result in
2045 changes made both to your updates and original snippets to
2046 persistently appear in the check-translation output as if they were
2047 out of sync.
2048
2049 This two-phase mechanism avoids the (practically) unsolvable problem
2050 of guessing what committish will have our update, and pretending to
2051 put this very committish on the files in the same commit.
2052
2053 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
2054 @c contains a helper script which could be used to perform massive
2055 @c committish updates.
2056
2057
2058 @seealso
2059 @ref{LSR work}.
2060
2061 @node Translations management policies
2062 @subsection Translations management policies
2063
2064 These policies show the general intent of how the translations should
2065 be managed, they aim at helping translators, developers and
2066 coordinators work efficiently.
2067
2068 @menu
2069 * Maintaining without updating translations::
2070 * Managing documentation translation with Git::
2071 @end menu
2072
2073 @node Maintaining without updating translations
2074 @unnumberedsubsubsec Maintaining without updating translations
2075
2076 Keeping translations up to date under heavy changes in the documentation
2077 in English may be almost impossible, especially as during the former
2078 Grand Documentation Project (GDP) or the Grand Organization Project
2079 (GOP) when a lot of contributors brings changes.  In addition,
2080 translators may be --- and that is a very good thing --- involved in
2081 these projects too.
2082
2083 it is possible --- and even recommended --- to perform some maintenance
2084 that keeps translated documentation usable and eases future translation
2085 updating.  The rationale below the tasks list motivates this plan.
2086
2087 The following tasks are listed in decreasing priority order.
2088
2089 @enumerate
2090 @item Update macros.itexi.
2091 For each obsolete macro definition, if it is possible to update macro
2092 usage in documentation with an automatic text or regexp substitution,
2093 do it and delete the macro definition from @file{macros.itexi}; otherwise,
2094 mark this macro definition as obsolete with a comment, and keep it in
2095 @file{macros.itexi} until the documentation translation has been updated and
2096 no longer uses this macro.
2097
2098 @item Update @file{*.tely} files completely with
2099 @command{make check-translation} -- you may want to redirect output
2100 to a file because of overwhelming output, or call check-translation.py
2101 on individual files, see @ref{Check state of translation}.
2102
2103 @item In @file{.itelys}, match sections and .itely file names with those from
2104 English docs, which possibly involves moving nodes contents in block
2105 between files, without updating contents itself.  In other words, the
2106 game is catching where has gone each section.  In Learning manual, and
2107 in Notation Reference sections which have been revised in GDP, there may
2108 be completely new sections: in this case, copy @code{@@node} and
2109 @code{@@section}-command from English docs, and add the marker for
2110 untranslated status @code{@@untranslated} on a single line.  Note that
2111 it is not possible to exactly match subsections or subsubsections of
2112 documentation in English, when contents has been deeply revised; in this
2113 case, keep obsolete (sub)subsections in the translation, marking them
2114 with a line @code{@@c obsolete} just before the node.
2115
2116 Emacs with Texinfo mode makes this step easier:
2117
2118 @itemize
2119 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
2120 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
2121 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
2122 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
2123 (e.g. the translated file), copy @code{*Occur*} contents into
2124 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
2125
2126 If you happen to have installed AucTeX, you can either call the macro
2127 by doing @key{M-x texinfo-show-structure} or create a key binding in your
2128 @file{~/.emacs}, by adding the four following lines:
2129
2130 @example
2131 (add-hook 'Texinfo-mode-hook
2132           '(lambda ()
2133              (define-key Texinfo-mode-map "\C-cs"
2134               'texinfo-show-structure)))
2135 @end example
2136
2137 @noindent
2138 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
2139 s}.
2140
2141 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
2142 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
2143 updated all the rest of the file.
2144
2145 @item Moving to next or previous node using incremental search: press
2146 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
2147 contains the word @q{node}) then press @key{C-s} to move to next node
2148 or @key{C-r} to move to previous node.  Similar operation can be used
2149 to move to the next/previous section.  Note that every cursor move
2150 exits incremental search, and hitting @key{C-s} twice starts
2151 incremental search with the text entered in previous incremental
2152 search.
2153
2154 @item Moving a whole node (or even a sequence of nodes): jump to beginning
2155 of the node (quit incremental search by pressing an arrow), press
2156 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
2157 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
2158 the right place (moving between nodes with the previous hint is often
2159 useful) and paste with @key{C-y} or @key{C-v}.
2160 @end itemize
2161
2162 @item Update sections finished in the English documentation; check
2163 sections status at
2164 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
2165
2166 @item Update documentation PO.  It is recommended not to update
2167 strings which come from documentation that is currently deeply revised
2168 in English, to avoid doing the work more than once.
2169
2170 @item Fix broken cross-references by running (from @file{Documentation/})
2171
2172 @example
2173 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
2174 @end example
2175
2176 @noindent
2177 This step requires a successful documentation build (with @command{make
2178 doc}).  Some cross-references are broken because they point to a node
2179 that exists in the documentation in English, which has not been added
2180 to the translation; in this case, do not fix the cross-reference but
2181 keep it "broken", so that the resulting HTML link will point to an
2182 existing page of documentation in English.
2183 @end enumerate
2184
2185 @subsubheading Rationale
2186
2187 You may wonder if it would not be better to leave translations as-is
2188 until you can really start updating translations.  There are several
2189 reasons to do these maintenance tasks right now.
2190
2191 @itemize
2192 @item This will have to be done sooner or later anyway, before updating
2193 translation of documentation contents, and this can already be done
2194 without needing to be redone later, as sections of documentation in
2195 English are mostly revised once.  However, note that not all
2196 documentation sectioning has been revised in one go, so all this
2197 maintenance plan has to be repeated whenever a big reorganization is
2198 made.
2199
2200 @item This just makes translated documentation take advantage of the new
2201 organization, which is better than the old one.
2202
2203 @item Moving and renaming sections to match sectioning of documentation in
2204 English simplify future updating work: it allows updating the
2205 translation by side-by-side comparison, without bothering whether
2206 cross-reference names already exist in the translation.
2207
2208 @item Each maintenance task except @q{Updating PO files} can be done by
2209 the same person for all languages, which saves overall time spent by
2210 translators to achieve this task: the node names and section titles
2211 are in English, so you can do.  It is important to take advantage of
2212 this now, as it will be more complicated (but still possible) to do
2213 step 3 in all languages when documentation is compiled with
2214 @command{texi2html} and node names are directly translated in source
2215 files.
2216 @end itemize
2217
2218
2219 @node Managing documentation translation with Git
2220 @unnumberedsubsubsec Managing documentation translation with Git
2221
2222 This policy explains how to manage Git branches and commit
2223 translations to Git.
2224
2225 @itemize
2226 @item Translation changes matching master branch are preferably made on
2227 @code{lilypond/translation} branch; they may be pushed directly to
2228 @code{master} only if they do not break compilation of LilyPond and
2229 its documentation, and in this case they should be pushed to
2230 @code{lilypond/translation} too.  Similarly, changes matching
2231 @code{stable/X.Y} are preferably made on
2232 @code{lilypond/X.Ytranslation}.
2233
2234 @item @code{lilypond/translation} Git branch may be merged into
2235 master only if LilyPond (@command{make all}) and documentation
2236 (@command{make doc}) compile successfully.
2237
2238 @item @code{master} Git branch may be merged into
2239 @code{lilypond/translation} whenever @command{make} and @command{make
2240 doc} are successful (in order to ease documentation compilation by
2241 translators), or when significant changes had been made in
2242 documentation in English in master branch.
2243
2244 @item General maintenance may be done by anybody who knows what he does
2245 in documentation in all languages, without informing translators
2246 first.  General maintenance include simple text substitutions
2247 (e.g. automated by sed), compilation fixes, updating Texinfo or
2248 lilypond-book commands, updating macros, updating ly code, fixing
2249 cross-references, and operations described in @ref{Maintaining
2250 without updating translations}.
2251 @end itemize
2252
2253
2254 @node Technical background
2255 @subsection Technical background
2256
2257 A number of Python scripts handle a part of the documentation
2258 translation process.  All scripts used to maintain the translations
2259 are located in @file{scripts/auxiliar/}.
2260
2261 @itemize
2262 @item @file{check_translation.py}  -- show diff to update a translation,
2263 @item @file{texi-langutils.py}  -- quickly and dirtily parse Texinfo files to
2264 make message catalogs and Texinfo skeleton files,
2265 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2266 @item @file{update-snippets.py} -- synchronize ly snippets with those
2267 from English docs,
2268 @item @file{translations-status.py} -- update translations status pages and word
2269 counts in the file you are reading,
2270 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2271 in the sources; WARNING only use this script once for each file, when support for
2272 "makeinfo --html" has been dropped.
2273 @end itemize
2274
2275 Other scripts are used in the build process, in @file{scripts/build/}:
2276
2277 @itemize
2278 @item @file{mass-link.py} -- link or symlink files between English documentation
2279 and documentation in other languages.
2280 @end itemize
2281
2282 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
2283 not by installed Python scripts) are located in @file{python/auxiliar/}:
2284 @itemize
2285 @item @file{manuals_definitions.py} -- define manual names and name of
2286 cross-reference Texinfo macros,
2287 @item @file{buildlib.py} -- common functions (read piped output
2288 of a shell command, use Git),
2289 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
2290 tweak links in HTML pages.
2291 @end itemize
2292
2293 And finally
2294 @itemize
2295 @item @file{python/langdefs.py}  -- language definitions module
2296 @end itemize