Doc: CG: Fix backslashes in @samp example.
[lilypond/mpolesky.git] / Documentation / contributor / doc-work.itexi
blobc299d47d83f50672a4ab20ac1db15cab82fa3e1a
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
9 set of source files.
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}.
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
27 @node Introduction to documentation work
28 @section Introduction to documentation work
30 Our documentation tries to adhere to our @ref{Documentation
31 policy}.  This policy contains a few items which may seem odd.
32 One policy in particular is often questioned by potential
33 contributors: we do not repeat material in the Notation Reference,
34 and instead provide links to the @qq{definitive} presentation of
35 that information.  Some people point out, with good reason, that
36 this makes the documentation harder to read.  If we repeated
37 certain information in relevant places, readers would be less
38 likely to miss that information.
40 That reasoning is sound, but we have two counter-arguments.
41 First, the Notation Reference -- one of @emph{five} manuals for
42 users to read -- is already over 500 pages long.  If we repeated
43 material, we could easily exceed 1000 pages!  Second, and much
44 more importantly, LilyPond is an evolving project.  New features
45 are added, bugs are fixed, and bugs are discovered and documented.
46 If features are discussed in multiple places, the documentation
47 team must find every instance.  Since the manual is so large, it
48 is impossible for one person to have the location of every piece
49 of information memorized, so any attempt to update the
50 documentation will invariably omit a few places.  This second
51 concern is not at all theoretical; the documentation used to be
52 plagued with inconsistent information.
54 If the documentation were targeted for a specific version -- say,
55 LilyPond 2.10.5 -- and we had unlimited resources to spend on
56 documentation, then we could avoid this second problem.  But since
57 LilyPond evolves (and that is a very good thing!), and since we
58 have quite limited resources, this policy remains in place.
60 A few other policies (such as not permitting the use of tweaks in
61 the main portion of NR 1+2) may also seem counter-intuitive, but
62 they also stem from attempting to find the most effective use of
63 limited documentation help.
66 @node Documentation suggestions
67 @section Documentation suggestions
69 @subheading Small additions
71 For additions to the documentation,
73 @enumerate
75 @item
76 Tell us where the addition should be placed. Please include both
77 the section number and title (i.e. "LM 2.13 Printing lyrics").
79 @item
80 Please write exact changes to the text.
82 @item
83 A formal patch to the source code is @emph{not} required; we can
84 take care of the technical details. Here is an example of a
85 perfect documentation report:
87 @verbatim
88 To: lilypond-devel@gnu.org
89 From: helpful-user@example.net
90 Subject: doc addition
92 In LM 2.13 (printing lyrics), above the last line ("More options,
93 like..."), please add:
95 ----
96 To add lyrics to a divided part, use blah blah blah.  For example,
98 \score {
99   \notes {blah <<blah>> }
100   \lyrics {blah <<blah>> }
101   blah blah blah
103 ----
105 In addition, the second sentence of the first paragraph is
106 confusing.  Please delete that sentence (it begins "Users
107 often...") and replace it with this:
108 ----
109 To align lyrics with something, do this thing.
110 ----
112 Have a nice day,
113 Helpful User
114 @end verbatim
116 @end enumerate
119 @subheading Larger contributions
121 To replace large sections of the documentation, the guidelines are
122 stricter. We cannot remove parts of the current documentation
123 unless we are certain that the new version is an improvement.
125 @enumerate
127 @item
128 Ask on the lilypond-devel maillist if such a rewrite is necessary;
129 somebody else might already be working on this issue!
131 @item
132 Split your work into small sections; this makes it much easier to
133 compare the new and old documentation.
135 @item
136 Please prepare a formal git patch.
138 @end enumerate
140 Once you have followed these guidelines, please send a message to
141 lilypond-devel with your documentation submissions. Unfortunately
142 there is a strict “no top-posting” check on the mailist; to avoid
143 this, add:
145 > I'm not top posting.
147 (you must include the > ) to the top of your documentation
148 addition.
150 We may edit your suggestion for spelling, grammar, or style, and
151 we may not place the material exactly where you suggested, but if
152 you give us some material to work with, we can improve the manual
153 much faster.  Thanks for your interest!
156 @node Texinfo introduction and usage policy
157 @section Texinfo introduction and usage policy
159 @menu
160 * Texinfo introduction::
161 * Documentation files::
162 * Sectioning commands::
163 * LilyPond formatting::
164 * Text formatting::
165 * Syntax survey::
166 * Other text concerns::
167 @end menu
170 @node Texinfo introduction
171 @subsection Texinfo introduction
173 The language is called Texinfo; you can see its manual here:
175 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
177 However, you don't need to read those docs.  The most important
178 thing to notice is that text is text.  If you see a mistake in the
179 text, you can fix it.  If you want to change the order of
180 something, you can cut-and-paste that stuff into a new location.
182 @warning{Rule of thumb: follow the examples in the existing docs.
183 You can learn most of what you need to know from this; if you want
184 to do anything fancy, discuss it on @code{lilypond-devel} first.}
187 @node Documentation files
188 @subsection Documentation files
190 All manuals live in @file{Documentation/}.
192 In particular, there are four user manuals, their respective master
193 source files are @file{learning.tely} (LM, Learning Manual),
194 @file{notation.tely} (NR, Notation Reference),
195 @file{music-glossary.tely} (MG, Music Glossary), and
196 @file{lilypond-program} (AU).  Each chapter is written in a separate
197 file, ending in @file{.itely} for files containing lilypond code, and
198 @file{.itexi} for files without lilypond code, located in a subdirectory
199 associated to the manual (@file{learning/} for @file{learning.tely}, and
200 so on); list the subdirectory of each manual to determine the filename
201 of the specific chapter you wish to modify.
203 Developer manuals live in @file{Documentation/} too.  Currently there is
204 only one: the Contributor's Guide @file{contrib-guide.texi} you are
205 reading.
207 Snippet files are part of documentation, and the Snippet List (SL) lives
208 in @file{Documentation/} just like the manuals.  For information about
209 how to modify the snippet files and SL, see @ref{LSR work}.
212 @node Sectioning commands
213 @subsection Sectioning commands
215 Most of the manual operates at the
217 @example
218 @@node Foo
219 @@subsubsection Foo
220 @end example
222 @noindent
223 level.  Sections are created with
225 @example
226 @@node Foo
227 @@subsection Foo
228 @end example
230 @itemize
231 @item
232 Please leave two blank lines above a @@node; this makes it
233 easier to find sections in texinfo.
235 @item
236 If a heading is desired without creating a node, please use
237 the following:
239 @example
240 @@subheading Foo
241 @end example
243 @item
244 Sectioning commands (@@node and @@section) must not appear
245 inside an @@ignore.  Separate those commands with a space, ie
246 @@n@tie{}ode.
248 @end itemize
250 Nodes must be included inside a
252 @example
253 @@menu
254 * foo::
255 * bar::
256 @@end menu
257 @end example
259 @noindent
260 construct.  These are easily constructed with automatic tools; see
261 @ref{Scripts to ease doc work}.
264 @node LilyPond formatting
265 @subsection LilyPond formatting
267 @itemize
269 @item
270 Use two spaces for indentation in lilypond examples.  (no
271 tabs)
273 @item
274 All text strings should be prefaced with #.  LilyPond does
275 not strictly require this, but it is helpful to get users
276 accustomed to this scheme construct.  ie @code{\set
277 Staff.instrumentName = #"cello"}
279 @item
280 All engravers should have double-quotes around them:
282 @example
283 \consists "Spans_arpeggio_engraver"
284 @end example
286 Again, LilyPond does not strictly require this, but it is a useful
287 standard to follow.
289 @item
290 If possible, only write one bar per line.
292 @item
293 If you only have one bar per line, omit bar checks.  If you
294 must put more than one bar per line (not recommended), then include bar
295 checks.
297 @item
298 Tweaks should, if possible, also occur on their own line.
299 @example
300 not:          \override TextScript #'padding = #3 c1^"hi"
301 but instead:  \override TextScript #'padding = #3
302               c1^"hi"
303 @end example
305 @item
306 Most LilyPond input should be produced with:
308 @example
309 @@lilypond[verbatim,quote,relative=2]
310 @end example
312 @noindent
315 @example
316 @@lilypond[verbatim,quote,relative=1]
317 @end example
319 If you want to use @code{\layout@{@}} or define variables, use
321 @example
322 @@lilypond[verbatim,quote]
323 @end example
325 In rare cases, other options may be used (or omitted), but ask first.
327 @item
328 Inspirational headwords are produced with
330 @example
331 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
332 @{pitches-headword.ly@}
333 @end example
335 @item
336 LSR snippets are linked with
338 @example
339 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
340 @{filename.ly@}
341 @end example
343 @noindent
344 excepted in Templates, where `doctitle' may be omitted.
346 @item
347 Avoid long stretches of input code.  Nobody is going to read
348 them in print.  Create small examples. However, this does not mean
349 it has be minimal.
351 @item
352 Specify durations for at least the first note of every bar.
354 @item
355 If possible, end with a complete bar.
357 @item
358 Comments should go on their own line, and be placed before
359 the line(s) to which they refer.
361 @item
362 Add extra spaces around @{ @} marks; ie
364 @example
365 not:          \chordmode @{c e g@}
366 but instead:  \chordmode @{ c e g @}
367 @end example
369 @item
370 Use @{ @} marks for additional @code{\markup} format comands; ie
372 @example
373 not:          c^\markup \tiny\sharp
374 but instead:  c^\markup @{ \tiny \sharp @}
375 @end example
377 @item
378 Remove any space around @code{<} @code{>} marks; ie
380 @example
381 not:           < c e g > 4
382 but instead:   <c e g>4
383 @end example
385 @item
386 Beam, slur and tie marks should begin immediately after the first
387 note with beam and phrase marks ending immediately after the last.
389 @example
390 a8(\ ais16[ b cis( d] b) cis4~ b' cis,\)
391 @end example
393 @item
394 If you want to work on an example outside of the manual (for
395 easier/faster processing), use this header:
397 @example
398 \paper @{
399   indent = 0\mm
400   line-width = 160\mm - 2.0 * 0.4\in
401   ragged-right = ##t
402   force-assignment = #""
403   line-width = #(- line-width (* mm  3.000000))
406 \layout @{
408 @end example
410 You may not change any of these values.  If you are making an
411 example demonstrating special @code{\paper@{@}} values, contact the
412 Documentation Editor.
414 @end itemize
417 @node Text formatting
418 @subsection Text formatting
420 @itemize
421 @item
422 Lines should be less than 72 characters long.  (We personally
423 recommend writing with 66-char lines, but do not bother modifying
424 existing material).  Also see the recommendations for fixed-width
425 fonts in the @ref{Syntax survey}.
427 @item
428 Do not use tabs.
430 @item
431 Do not use spaces at the beginning of a line (except in
432 @code{@@example} or @code{@@verbatim} environments), and do not
433 use more than a single space between words.  @q{makeinfo} copies
434 the input lines verbatim without removing those spaces.
436 @item
437 Use two spaces after a period.
439 @item
440 In examples of syntax, use @code{@@var@{@var{musicexpr}@}} for a
441 music expression.
443 @item
444 Don't use @code{@@rinternals@{@}} in the main text.  If you're
445 tempted to do so, you're probably getting too close to @qq{talking
446 through the code}.  If you really want to refer to a context, use
447 @code{@@code@{@}} in the main text and @code{@@rinternals@{@}} in
448 the @code{@@seealso}.
449 @end itemize
452 @node Syntax survey
453 @subsection Syntax survey
456 @menu
457 * Comments::
458 * Cross references::
459 * External links::
460 * Fixed-width font::
461 * Indexing::
462 * Lists::
463 * Special characters::
464 * Miscellany::
465 @end menu
468 @node Comments
469 @unnumberedsubsubsec Comments
471 @itemize
472 @item
473 @code{@@c @dots{}} --- single line comment.  @samp{@@c NOTE:} is a
474 comment which should remain in the final version.  (gp only
475 command ;)
477 @item
478 @code{@@ignore} --- multi-line comment:
480 @example
481 @@ignore
482 @dots{}
483 @@end ignore
484 @end example
485 @end itemize
488 @node Cross references
489 @unnumberedsubsubsec Cross references
491 Enter the exact @code{@@node} name of the target reference between
492 the brackets (eg.@tie{}@w{@samp{@@ref@{Syntax survey@}}}).
494 @itemize
495 @item
496 @code{@@ref@{@dots{}@}} --- link within current manual.
498 @item
499 @code{@@rchanges@{@dots{}@}} --- link to Changes.
501 @item
502 @code{@@rcontrib@{@dots{}@}} --- link to Contributor's Guide.
504 @item
505 @code{@@ressay@{@dots{}@}} --- link to Engraving Essay.
507 @item
508 @code{@@rextend@{@dots{}@}} --- link to Extending LilyPond.
510 @item
511 @code{@@rglos@{@dots{}@}} --- link to the Music Glossary.
513 @item
514 @code{@@rinternals@{@dots{}@}} --- link to the Internals Reference.
516 @item
517 @code{@@rlearning@{@dots{}@}} --- link to Learning Manual.
519 @item
520 @code{@@rlsr@{@dots{}@}} --- link to a Snippet section.
522 @item
523 @code{@@rprogram@{@dots{}@}} --- link to Application Usage.
525 @item
526 @code{@@ruser@{@dots{}@}} --- link to Notation Reference.
528 @item
529 @code{@@rweb@{@dots{}@}} --- link to General Informaion.
530 @end itemize
533 @node External links
534 @unnumberedsubsubsec External links
536 @itemize
537 @item
538 @code{@@email@{@dots{}@}} --- create a @code{mailto:} E-mail link.
540 @item
541 @code{@@uref@{@var{URL}[, @var{link text}]@}} --- link to an
542 external url.
543 @end itemize
546 @node Fixed-width font
547 @unnumberedsubsubsec Fixed-width font
549 @itemize
550 @item
551 @code{@@code@{@dots{}@}}, @code{@@samp@{@dots{}@}} ---
553 Use the @code{@@code@{@dots{}@}} command for individual
554 language-specific tokens (keywords, commands, engravers, scheme
555 symbols, etc.).  Ideally, a single @code{@@code@{@dots{}@}} block
556 should fit within one line in the PDF output.  Use the
557 @code{@@samp@{@dots{}@}} command when you have a short example of
558 user input, unless it constitutes an entire @code{@@item} by
559 itself, in which case @code{@@code@{@dots{}@}} is preferable.
560 Otherwise, both should only be used when part of a larger sentence
561 within a paragraph or @code{@@item}.  Never use a
562 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} block as a
563 free-standing paragraph; use @code{@@example} instead.
565 A single unindented line in the PDF has space for about 79
566 fixed-width characters (76 if indented).  Within an @code{@@item}
567 there is space for about 75 fixed-width characters.  Each
568 additional level of @code{@@itemize} or @code{@@enumerate}
569 shortens the line by about 4 columns.
571 However, even short blocks of @code{@@code@{@dots{}@}} and
572 @code{@@samp@{@dots{}@}} can run into the margin if the Texinfo
573 line-breaking algorithm gets confused.  Additionally, blocks that
574 are longer than this may in fact print nicely; it all depends
575 where the line breaks end up.  If you compile the docs yourself,
576 check the PDF output to make sure the line breaks are
577 satisfactory.
579 The Texinfo setting @code{@@allowcodebreaks} is set to
580 @code{false} in the manuals, so lines within
581 @code{@@code@{@dots{}@}} or @code{@@samp@{@dots{}@}} blocks will
582 only break at spaces, not at hyphens or underscores.  If the block
583 contains spaces, use @code{@@w@{@@code@{@dots{}@}@}} or
584 @code{@@w@{@@samp@{@dots{}@}@}} to prevent unexpected line breaks.
586 The Texinfo settings @code{txicodequoteundirected} and
587 @code{txicodequotebacktick} are both set in the manuals, so
588 backticks (@code{`}) and apostrophes (@code{'}) placed within
589 blocks of @code{@@code}, @code{@@example}, or @code{@@verbatim}
590 are not converted to left- and right-angled quotes
591 (@code{@quoteleft{} @quoteright{}}) as they normally are within
592 the text, so the apostrophes in
593 @q{@w{@code{@@w@{@@code@{@bs{}relative c''@}@}}}} will display
594 correctly.  However, these settings do not affect the PDF output
595 for anything within a @code{@@samp} block (even if it includes a
596 nested @code{@@code} block), so entering
597 @q{@code{@@w@{@@samp@{@bs{}relative c''@}@}}} wrongly produces
598 @q{@w{@code{@bs{}relative c@quoteright{}@quoteright{}}}} in PDF.
599 Consequently, if you want to use a @code{@@samp@{@dots{}@}} block
600 which contains backticks or apostrophes, you should instead use
601 @q{@code{@@q@{@@code@{@dots{}@}@}}} (or
602 @q{@code{@@q@{@@w@{@@code@{@dots{}@}@}@}}} if the block also
603 contains spaces).  Note that backslashes within
604 @code{@@q@{@dots{}@}} blocks must be entered as @samp{@@bs@{@}},
605 so the example above would be coded as
606 @q{@code{@@q@{@@w@{@@code@{@@bs@{@}relative c''@}@}@}}}.
608 @item
609 @code{@@command@{@dots{}@}} --- Use for command-line commands (eg.
610 @samp{@@command@{lilypond-book@}}).
612 @item
613 @code{@@example} --- Use for examples of program code.  Do not add
614 extraneous indentation (ie. don't start every line with
615 whitespace).  Use the following layout (notice the use of blank
616 lines).  Omit the @code{@@noindent} if the text following the
617 example starts a new paragraph:
619 @example
620 @var{@dots{}text leading into the example@dots{}}
622 @@example
623 @dots{}
624 @@end example
626 @@noindent
627 @var{continuation of the text@dots{}}
628 @end example
630 Individual lines within an @code{@@example} block should not
631 exceed 74 characters; otherwise they will run into the margin in
632 the PDF output, and may get clipped.  If an @code{@@example} block
633 is part of an @code{@@item}, individual lines in the
634 @code{@@example} block should not exceed 70 columns.  Each
635 additional level of @code{@@itemize} or @code{@@enumerate}
636 shortens the line by about 4 columns.
638 For long command line examples, if possible, use a trailing
639 backslash to break up a single line, indenting the next line with
640 2 spaces.  If this isn't feasible, use @samp{@@smallexample
641 @dots{} @@end@tie{}smallexample} instead, which uses a smaller
642 fontsize.  Use @code{@@example} whenever possible, but if needed,
643 @code{@@smallexample} can fit up to 90 characters per line before
644 running into the PDF margin.  Each additional level of
645 @code{@@itemize} or @code{@@enumerate} shortens a
646 @code{@@smallexample} line by about 5 columns.
648 @item
649 @code{@@file@{@dots{}@}} --- Use for filenames and directories.
651 @item
652 @code{@@option@{@dots{}@}} --- Use for options to command-line
653 commands (eg. @samp{@@option@{--format@}}).
655 @item
656 @code{@@verbatim} --- Prints the block exactly as it appears in
657 the source file (including whitespace, etc.).  For program code
658 examples, use @code{@@example} instead.  @code{@@verbatim} uses
659 the same format as @code{@@example}.
661 Individual lines within an @code{@@verbatim} block should not
662 exceed 74 characters; otherwise they will run into the margin in
663 the PDF output, and may get clipped.  If an @code{@@verbatim}
664 block is part of an @code{@@item}, individual lines in the
665 @code{@@verbatim} block should not exceed 70 columns.  Each
666 additional level of @code{@@itemize} or @code{@@enumerate}
667 shortens the line by about 4 columns.
668 @end itemize
671 @node Indexing
672 @unnumberedsubsubsec Indexing
674 @itemize
675 @item
676 @code{@@cindex @dots{}} --- General index.  Please add as many as you can.
677 Don't capitalize the first word.
679 @item
680 @code{@@funindex @dots{}} --- is for a \lilycommand.
681 @end itemize
684 @node Lists
685 @unnumberedsubsubsec Lists
687 @itemize
688 @item
689 @code{@@enumerate} --- Create an ordered list (with numbers).
690 Always put @samp{@@item} on its own line, and separate consecutive
691 items with a blank line:
693 @example
694 @@enumerate
695 @@item
698 @@item
700 @@end enumerate
701 @end example
703 @item
704 @code{@@itemize} --- Create an unordered list (with bullets).  Use
705 the same format as @code{@@enumerate}.  Do not use
706 @samp{@@itemize@tie{}@@bullet}.
707 @end itemize
710 @node Special characters
711 @unnumberedsubsubsec Special characters
713 @itemize
714 @item
715 @code{--}, @code{---} --- Create an en dash (--) or an em dash
716 (---) in the text.  To print two or three literal hyphens in a
717 row, wrap one of them in a @code{@@w@{@dots{}@}} (eg.
718 @samp{-@@w@{-@}-}).
720 @item
721 @code{@@@@}, @code{@@@{}, @code{@@@}} --- Create an at-sign (@@),
722 a left curly bracket (@{), or a right curly bracket (@}).
724 @item
725 @code{@@bs@{@}} --- Create a backslash within a
726 @code{@@q@{@dots{}@}}, @code{@@qq@{@dots{}@}}, or
727 @code{@@warning@{@dots{}@}} block.  This is a custom LilyPond
728 macro, not a builtin @@-command in Texinfo.  Texinfo would also
729 allow @samp{\\}, but this breaks the PDF output.
731 @item
732 @code{@@tie@{@}} --- Create a @emph{variable-width} non-breaking
733 space in the text (use @w{@samp{@@w@{ @}}} for a single
734 @emph{fixed-width} non-breaking space).  Variables or numbers
735 which consist of a single character (probably followed by a
736 punctuation mark) should be tied properly, either to the previous
737 or the next word.  Example: @samp{The letter@@tie@{@}@@q@{I@} is
738 skipped}
739 @end itemize
742 @node Miscellany
743 @unnumberedsubsubsec Miscellany
745 @itemize
746 @item
747 @code{@@notation@{@dots{}@}} --- refers to pieces of notation, e.g.
748 @samp{@@notation@{clef@}}.  Also use for specific lyrics
749 (@samp{the @@notation@{A@tie{}-@tie{}men@} is centered}).
750 Only use once per subsection per term.
752 @item
753 @code{@@q@{@dots{}@}} --- Single quotes.  Used for
754 @quoteleft{}vague@quoteright{} terms.  To get a backslash
755 (\), you must use @samp{@@bs@{@}}.
757 @item
758 @code{@@qq@{@dots{}@}} --- Double quotes.  Used for actual quotes
759 (@qq{he said}) or for introducing special input modes.  To get a
760 backslash (\), you must use @samp{@@bs@{@}}.
762 @item
763 @code{@@var@{@dots{}@}} --- Use for variables.
765 @item
766 @code{@@version@{@}} --- Return the current LilyPond version
767 string.  Use @samp{@@w@{@@version@{@}@}} if it's at the end of a
768 line (to prevent an ugly line break in PDF); use
769 @samp{@@w@{"@@version@{@}"@}} if you need it in quotes.
771 @item
772 @code{@@w@{@dots{}@}} --- Do not allow any line breaks.
774 @item
775 @code{@@warning@{@dots{}@}} --- produces a @qq{Note:@tie{}} box.
776 Use for important messages.  To get a backslash (\), you must use
777 @samp{@@bs@{@}}.
778 @end itemize
781 @node Other text concerns
782 @subsection Other text concerns
784 @itemize
785 @item
786 References must occur at the end of a sentence, for more
787 information see the
788 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/,texinfo
789 manual}.  Ideally this should also be the final sentence of a
790 paragraph, but this is not required.  Any link in a doc section
791 must be duplicated in the @code{@@seealso} section at the bottom.
793 @item
794 Introducing examples must be done with
796 @example
797 . (ie finish the previous sentence/paragaph)
798 : (ie `in this example:')
799 , (ie `may add foo with the blah construct,')
800 @end example
802 The old @qq{sentence runs directly into the example} method is not
803 allowed any more.
805 @item
806 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
808 @item
809 Colon usage
811 @enumerate
812 @item
813 To introduce lists
815 @item
816 When beginning a quote: @qq{So, he said,...}.
818 This usage is rarer.  Americans often just use a comma.
820 @item
821 When adding a defining example at the end of a sentence.
822 @end enumerate
824 @item
825 Non-ASCII characters which are in utf-8 should be directly used;
826 this is, don't say @samp{Ba@@ss@{@}tuba} but @samp{Baßtuba}.  This
827 ensures that all such characters appear in all output formats.
828 @end itemize
831 @node Documentation policy
832 @section Documentation policy
834 @menu
835 * Books::
836 * Section organization::
837 * Checking cross-references::
838 * General writing::
839 * Technical writing style::
840 @end menu
842 @node Books
843 @subsection Books
845 There are four parts to the documentation: the Learning Manual,
846 the Notation Reference, the Program Reference, and the Music
847 Glossary.
849 @itemize
851 @item
852 Learning Manual:
854 The LM is written in a tutorial style which introduces the most
855 important concepts, structure and syntax of the elements of a
856 LilyPond score in a carefully graded sequence of steps.
857 Explanations of all musical concepts used in the Manual can be
858 found in the Music Glossary, and readers are assumed to have no
859 prior knowledge of LilyPond.  The objective is to take readers to
860 a level where the Notation Reference can be understood and
861 employed to both adapt the templates in the Appendix to their
862 needs and to begin to construct their own scores.  Commonly used
863 tweaks are introduced and explained.  Examples are provided
864 throughout which, while being focussed on the topic being
865 introduced, are long enough to seem real in order to retain the
866 readers' interest.  Each example builds on the previous material,
867 and comments are used liberally.  Every new aspect is thoroughly
868 explained before it is used.
870 Users are encouraged to read the complete Learning Manual from
871 start-to-finish.
874 @item
875 Notation Reference: a (hopefully complete) description of LilyPond
876 input notation.  Some material from here may be duplicated in the
877 Learning Manual (for teaching), but consider the NR to be the
878 "definitive" description of each notation element, with the LM
879 being an "extra".  The goal is _not_ to provide a step-by-step
880 learning environment -- do not avoid using notation that has not
881 be introduced previously in the NR  (for example, use \break if
882 appropriate).  This section is written in formal technical writing
883 style.
885 Avoid duplication.  Although users are not expected to read this
886 manual from start to finish, they should be familiar with the
887 material in the Learning Manual (particularly ``Fundamental
888 Concepts''), so do not repeat that material in each section of
889 this book.  Also watch out for common constructs, like ^ - _ for
890 directions -- those are explained in NR 3.  In NR 1, you can
891 write: DYNAMICS may be manually placed above or below the staff,
892 see @@ref@{Controlling direction and placement@}.
894 Most tweaks should be added to LSR and not placed directly in the
895 .itely file.  In some cases, tweaks may be placed in the main
896 text, but ask about this first.
898 Finally, you should assume that users know what the notation
899 means; explaining musical concepts happens in the Music Glossary.
902 @item
903 Application Usage: information about using the program lilypond
904 with other programs (lilypond-book, operating systems, GUIs,
905 convert-ly, etc).  This section is written in formal technical
906 writing style.
908 Users are not expected to read this manual from start to finish.
911 @item
912 Music Glossary: information about the music notation itself.
913 Explanations and translations about notation terms go here.
915 Users are not expected to read this manual from start to finish.
917 @item
918 Internals Reference: not really a documentation book, since it is
919 automagically generated from the source, but this is its name.
921 @end itemize
924 @node Section organization
925 @subsection Section organization
927 @itemize
929 @item
930 The order of headings inside documentation sections should
933 @example
934 main docs
935 @@predefined
936 @@endpredefined
937 @@snippets
938 @@seealso
939 @@knownissues
940 @end example
942 @item
943 You @emph{must} include a @@seealso.
945 @itemize
946 @item
947 The order of items inside the @@seealso section is
949 @example
950 Music Glossary:
951 @@rglos@{foo@},
952 @@rglos@{bar@}.
954 Learning Manual:
955 @@rlearning@{baz@},
956 @@rlearning@{foozle@}.
958 Notation Reference:
959 @@ruser@{faazle@},
960 @@ruser@{boo@}.
962 Application Usage:
963 @@rprogram@{blah@}.
965 Extending LilyPond:
966 @@rextend@{frob@}.
968 Installed Files:
969 @@file@{path/to/dir/blahz@}.
971 Snippets: @@rlsr@{section@}.
973 Internals Reference:
974 @@rinternals@{fazzle@},
975 @@rinternals@{booar@}.
976 @end example
978 @item
979 If there are multiple entries, separate them by commas but do not
980 include an `and'.
982 @item
983 Always end with a period.
985 @item
986 Place each link on a new line as above; this makes it much easier
987 to add or remove links.  In the output, they appear on a single
988 line.
990 ("Snippets" is REQUIRED; the others are optional)
992 @item
993 Any new concepts or links which require an explanation should go
994 as a full sentence(s) in the main text.
996 @item
997 Don't insert an empty line between @@seealso and the first entry!
998 Otherwise there is excessive vertical space in the PDF output.
1000 @end itemize
1002 @item
1003 To create links, use @@ref@{@} if the link is within the same
1004 manual.
1006 @item
1007 @@predefined ... @@endpredefined is for commands in
1008 @file{ly/*-init.ly}
1010 @item
1011 Do not include any real info in second-level sections (ie 1.1
1012 Pitches).  A first-level section may have introductory material,
1013 but other than that all material goes into third-level sections
1014 (ie 1.1.1 Writing Pitches).
1016 @end itemize
1019 @node Checking cross-references
1020 @subsection Checking cross-references
1022 Cross-references between different manuals are heavily used in the
1023 documentation, but they are not checked during compilation.
1024 However, if you compile the documentation, a script called
1025 check_texi_refs can help you with checking and fixing these
1026 cross-references; for information on usage, cd into a source tree
1027 where documentation has been built, cd into Documentation and run:
1029 @example
1030 make check-xrefs
1031 make fix-xrefs
1032 @end example
1034 Note that you have to find yourself the source files to fix
1035 cross-references in the generated documentation such as the
1036 Internals Reference; e.g. you can grep scm/ and lily/.
1038 @c temporary?  how long will kainhofer be used?  -gp
1039 Also of interest may be the linkdoc checks on kainhofer.com.  Be
1040 warned that these docs are not completely rebuilt every day, so it
1041 might not accurately reflect the current state of the docs.
1043 @example
1044 @uref{http://kainhofer.com/~lilypond/linkdoc/}
1045 @end example
1048 @node General writing
1049 @subsection General writing
1051 @itemize
1053 @item
1054 Do not forget to create @@cindex entries for new sections of text.
1055 Enter commands with @@funindex, i.e.
1057 @example
1058 @@cindex pitches, writing in different octaves
1059 @@funindex \relative
1060 @end example
1062 @noindent
1063 do not bother with the @@code@{@} (they are added automatically).
1064 These items are added to both the command index and the unified
1065 index.
1067 Both index commands should go in front of the actual material.
1069 @@cindex entries should not be capitalized, ie
1071 @example
1072 @@cindex time signature
1073 @end example
1075 @noindent
1076 is preferred instead of @qq{Time signature},   Only use capital
1077 letters for musical terms which demand them, like D.S. al Fine.
1079 For scheme functions, only include the final part, i.e.,
1081 @example
1082 @@funindex modern-voice-cautionary
1083      and NOT
1084 @@funindex #(set-accidental-style modern-voice-cautionary)
1085 @end example
1087 @item
1088 Preferred terms:
1090 @itemize
1092 @item
1093 In general, use the American spellings.  The internal lilypond
1094 property names use this spelling.
1096 @item
1097 List of specific terms:
1099 @example
1100 canceled
1101 simultaneous    NOT concurrent
1102 measure: the unit of music
1103 bar line: the symbol delimiting a measure   NOT barline
1104 note head   NOT notehead
1105 chord construct   NOT chord (when referring to <>)
1106 @end example
1108 @end itemize
1110 @end itemize
1113 @node Technical writing style
1114 @subsection Technical writing style
1116 These refer to the NR.  The LM uses a more gentle, colloquial
1117 style.
1119 @itemize
1121 @item
1122 Do not refer to LilyPond in the text.  The reader knows what the
1123 manual is about.  If you do, capitalization is LilyPond.
1125 @item
1126 If you explicitly refer to @q{lilypond} the program (or any other
1127 command to be executed), write @code{@@command@{lilypond@}}.
1129 @item
1130 Do not explicitly refer to the reader/user.  There is no one else
1131 besides the reader and the writer.
1133 @item
1134 Avoid contractions (don't, won't, etc.).  Spell the words out completely.
1136 @item
1137 Avoid abbreviations, except for commonly used abbreviations of foreign
1138 language terms such as etc. and i.e.
1140 @item
1141 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
1142 @qq{Currently,}).
1144 @item
1145 The use of the word @q{illegal} is inappropriate in most cases.
1146 Say @q{invalid} instead.
1148 @end itemize
1151 @node Tips for writing docs
1152 @section Tips for writing docs
1154 In the NR, I highly recommend focusing on one subsection at a
1155 time.  For each subsection,
1157 @itemize
1159 @item
1160 check the mundane formatting.  Are the headings (@@predefined,
1161 @@seealso, etc.) in the right order?
1163 @item
1164 add any appropriate index entries.
1166 @item
1167 check the links in the @@seealso section -- links to music
1168 glossary, internal references, and other NR sections are the main
1169 concern.  Check for potential additions.
1171 @item
1172 move LSR-worthy material into LSR.  Add the snippet, delete the
1173 material from the .itely file, and add a @@lilypondfile command.
1175 @item
1176 check the examples and descriptions.  Do they still work?
1177 @strong{Do not} assume that the existing text is
1178 accurate/complete; some of the manual is highly out of date.
1180 @item
1181 is the material in the @@knownissues  still accurate?
1183 @item
1184 can the examples be improved (made more explanatory), or is there
1185 any missing info?  (feel free to ask specific questions on -user;
1186 a couple of people claimed to be interesting in being
1187 @qq{consultants} who would help with such questions)
1189 @end itemize
1191 In general, I favor short text explanations with good examples --
1192 @qq{an example is worth a thousand words}.  When I worked on the
1193 docs, I spent about half my time just working on those tiny
1194 lilypond examples.  Making easily-understandable examples is much
1195 harder than it looks.
1198 @subsubheading Tweaks
1200 In general, any \set or \override commands should go in the
1201 @qq{select snippets} section, which means that they should go in
1202 LSR and not the .itely file.  For some cases, the command
1203 obviously belongs in the @qq{main text} (i.e. not inside
1204 @@predefined or @@seealso or whatever) -- instrument names are a
1205 good example of this.
1207 @example
1208 \set Staff.instrumentName = #"foo"
1209 @end example
1211 On the other side of this,
1213 @example
1214 \override Score.Hairpin #'after-line-breaking = ##t
1215 @end example
1217 clearly belongs in LSR.
1219 I'm quite willing to discuss specific cases if you think that a
1220 tweaks needs to be in the main text.  But items that can go into
1221 LSR are easier to maintain, so I'd like to move as much as
1222 possible into there.
1225 It would be @qq{nice} if you spent a lot of time crafting nice
1226 tweaks for users@dots{} but my recommendation is @strong{not} to do
1227 this.  There's a lot of doc work to do without adding examples of
1228 tweaks.  Tweak examples can easily be added by normal users by adding
1229 them to the LSR.
1231 One place where a documentation writer can profitably spend time writing
1232 or upgrading tweaks is creating tweaks to deal with known issues.  It
1233 would be ideal if every significant known issue had a workaround to avoid
1234 the difficulty.
1236 @seealso
1237 @ref{Adding and editing snippets}.
1240 @node Scripts to ease doc work
1241 @section Scripts to ease doc work
1243 @subheading Stripping whitespace
1245 @c TODO: should this be documented elsewhere?  It's useful for
1246 @c more than just docs.
1247 To remove extra whitespace from the ends of lines, run
1249 @example
1250 scripts/auxiliar/strip-whitespace.py Documentation/FILENAME
1251 @end example
1254 @subheading Sectioning commands
1256 @warning{These commands add whitespace.}
1258 The emacs @code{M-x texinfo-all-menus-update} command will
1259 regenerate @@menu blocks.  This can also be run with this
1260 command-line script:
1262 @example
1263 #!/bin/sh
1264 emacs $1 -batch -f texinfo-all-menus-update -f save-buffer
1265 @end example
1267 @noindent
1268 (save the above as something like @command{texinfo-menus.sh}, make
1269 it executable, then run @command{texinfo-menus.sh foo.itely})
1272 @subheading Updating doc with @command{convert-ly}
1274 cd into @file{Documentation/} and run
1276 @example
1277 find . -name '*.itely' | xargs convert-ly -e
1278 @end example
1280 @noindent
1281 This also updates translated documentation.
1285 @node Docstrings in scheme
1286 @section Docstrings in scheme
1288 Material in the Internals reference is generated automatically
1289 from our source code.  Any doc work on Internals therefore
1290 requires modifying files in @file{scm/*.scm}.  Texinfo is allowed
1291 in these docstrings.
1293 Most documentation writers never touch these, though.  If you want
1294 to work on them, please ask for help.
1297 @node Translating the documentation
1298 @section Translating the documentation
1300 The mailing list @code{translations@@lilynet.net} is dedicated to
1301 LilyPond web site and documentation translation; on this list, you will
1302 get support from the Translations Meister and experimented translators,
1303 and we regularly discuss translations issues common to all languagues.
1304 All people interested in LilyPond translations are invited to subscribe
1305 to this list regardless of the amount of their contribution, by sending
1306 an email to @code{translations-request@@lilynet.net} with subject
1307 @code{subscribe} and an empty message body.  Unless mentioned explicitly
1308 or except if a translations coordinator contacts you privately, you
1309 should send questions, remarks, patches to this list
1310 @code{translations@@lilynet.net}; especially note that the traffic is so
1311 high on English-speaking list @code{lilypond-user@@gnu.org} that it may
1312 take months before your request or contribution is handled if you send a
1313 email to these lists.
1315 @menu
1316 * Getting started with documentation translation::
1317 * Documentation translation details::
1318 * Documentation translation maintenance::
1319 * Translations management policies::
1320 * Technical background::
1321 @end menu
1323 @node Getting started with documentation translation
1324 @subsection Getting started with documentation translation
1326 First, get the sources of branch @code{lilypond/translation} from the
1327 Git repository, see @ref{Starting with Git}.
1329 @menu
1330 * Translation requirements::
1331 * Which documentation can be translated::
1332 * Starting translation in a new language::
1333 @end menu
1335 @node Translation requirements
1336 @unnumberedsubsubsec Translation requirements
1338 Working on LilyPond documentation translations requires the following
1339 pieces of software, in order to make use of dedicated helper tools:
1341 @itemize
1342 @item Python 2.4 or higher,
1343 @item GNU Make,
1344 @item Gettext,
1345 @item Git.
1346 @end itemize
1348 It is not required to build LilyPond and the documentation to
1349 translate the documentation.  However, if you have enough time and
1350 motivation and a suitable system, it can be very useful to build at
1351 least the documentation so that you can check the output yourself and
1352 more quickly; if you are interested, see @ref{Compiling}.
1355 @node Which documentation can be translated
1356 @unnumberedsubsubsec Which documentation can be translated
1358 The makefiles and scripts infrastructure currently supports translation
1359 of the following documentation:
1361 @itemize
1362 @item the web site, the Learning Manual, the Notation Reference and
1363 Application Usage -- Texinfo source, PDF and HTML output; Info output
1364 might be added if there is enough demand for it;
1365 @item the Changes document.
1366 @end itemize
1368 Support for translating the following pieces of documentation should be
1369 added soon, by decreasing order of priority:
1371 @itemize
1372 @item automatically generated documentation: markup commands,
1373 predefined music functions;
1374 @item the Snippets List;
1375 @item the Internals Reference.
1376 @end itemize
1379 @node Starting translation in a new language
1380 @unnumberedsubsubsec Starting translation in a new language
1382 At top of the source directory, do
1384 @example
1385 ./autogen.sh
1386 @end example
1388 @noindent
1389 or (if you want to install your self-compiled LilyPond locally)
1391 @example
1392 ./autogen.sh --prefix=$HOME
1393 @end example
1395 @noindent
1396 If you want to compile LilyPond -- which is almost required to build
1397 the documentation, but is not required to do translation only -- fix
1398 all dependencies and rerun @command{./configure} (with the same
1399 options as for @command{autogen.sh}).
1401 Then @command{cd} into @file{Documentation/} and run
1403 @example
1404 make ISOLANG=@var{MY-LANGUAGE} new-lang
1405 @end example
1407 @noindent
1408 where @var{MY-LANGUAGE} is the ISO 639 language code.
1410 Finally, add a language definition for your language in
1411 @file{python/langdefs.py}.
1414 @node Documentation translation details
1415 @subsection Documentation translation details
1417 Please follow all the instructions with care to ensure quality work.
1419 All files should be encoded in UTF-8.
1421 @menu
1422 * Files to be translated::
1423 * Translating the Web site and other Texinfo documentation::
1424 * Adding a Texinfo manual::
1425 @end menu
1427 @node Files to be translated
1428 @unnumberedsubsubsec Files to be translated
1430 @include contributor/doc-translation-list.itexi
1432 In addition, not listed above, Snippets' titles and descriptions
1433 should be translated; they are a part of the Notation Reference and
1434 therefore their priority is 5.
1436 @node Translating the Web site and other Texinfo documentation
1437 @unnumberedsubsubsec Translating the Web site and other Texinfo documentation
1439 Every piece of text should be translated in the source file, except
1440 Texinfo comments, text in @code{@@lilypond} blocks and a few cases
1441 mentioned below.
1443 Node names are translated, but the original node name in English should
1444 be kept as the argument of @code{@@translationof} put after the section
1445 title; that is, every piece in the original file like
1447 @example
1448 @@node Foo bar
1449 @@@var{section_command} Bar baz
1450 @end example
1452 @noindent
1453 should be translated as
1455 @example
1456 @@node @var{translation of Foo bar}
1457 @@@var{section_command} @var{translation of Bar baz}
1458 @@translationof Foo bar
1459 @end example
1461 The argument of @code{@@rglos} commands and the first argument of
1462 @code{@@rglosnamed} commands must not be translated, as it is the node
1463 name of an entry in Music Glossary.
1465 Every time you translate a node name in a cross-reference, i.e. the
1466 argument of commands @code{@@ref, @@rprogram, @@rlearning, @@rlsr,
1467 @@ruser} or the first argument of their @code{@var{*}named} variants,
1468 you should make sure the target node is defined in the correct source
1469 file; if you do not intend to translate the target node right now, you
1470 should at least write the node definition (that is, the @code{@@node
1471 @@@var{section_commmand} @@translationof} trio mentioned above) in the
1472 expected source file and define all its parent nodes; for each node you
1473 have defined this way but have not translated, insert a line that
1474 contains @code{@@untranslated}. That is, you should end up
1475 for each untranslated node with something like
1477 @example
1478 @@node @var{translation of Foo bar}
1479 @@@var{section_command} @var{translation of Bar baz}
1480 @@translationof Foo bar
1482 @@untranslated
1483 @end example
1485 @warning{you do not have to translate the node name of a cross-reference
1486 to a node that you do not have translated.  If you do, you must define
1487 an @qq{empty} node like explained just above; this will produce a
1488 cross-reference with the translated node name in output, although the
1489 target node will still be in English.  On the opposite, if all
1490 cross-references that refer to an untranslated node use the node name in
1491 English, then you do not have to define such an @qq{empty} node, and the
1492 cross-reference text will appear in English in the output.  The choice
1493 between these two strategies implies its particular maintenance
1494 requirements and is left to the translators, although the opinion of the
1495 Translation meister leans towards not translating these
1496 cross-references.}
1498 Please think of the fact that it may not make sense translating
1499 everything in some Texinfo files, and you may take distance from the
1500 original text; for instance, in the translation of the web site section
1501 Community, you may take this into account depending on what you know the
1502 community in your language is willing to support, which is possible only
1503 if you personnally assume this support, or there exists a public forum
1504 or mailing list listed in Community for LilyPond in your language:
1506 @itemize
1507 @item @rweb{Bug reports}: this page should be translated only if you
1508 know that every bug report sent on your language's mailing list or forum
1509 will be handled by someone who will translate it to English and send it
1510 on bug-lilypond or add an issue in the tracker, then translate back the
1511 reply from developers.
1513 @item @rweb{Help us}: this page should be translated very freely,
1514 and possibly not at all: ask help for contributing to LilyPond for tasks
1515 that LilyPond community in your language is able and going to handle.
1516 @end itemize
1518 @noindent
1519 In any case, please mark in your work the sections which do not result
1520 from the direct translation of a piece of English translation, using
1521 comments i.e. lines starting with @q{@code{@@c}}.
1523 Finally, press in Emacs @key{C-c C-u C-a} to update or generate
1524 menus. This process should be made easier in the future, when the helper
1525 script @command{texi-langutils.py} and the makefile target are updated.
1527 Some pieces of text manipulated by build scripts that appear in the
1528 output are translated in a @file{.po} file -- just like LilyPond output
1529 messages -- in @file{Documentation/po}.  The Gettext domain is named
1530 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not managed
1531 through the Free Translation Project.
1534 Take care of using typographic rules for your language, especially in
1535 @file{macros.itexi}.
1537 If you wonder whether a word, phrase or larger piece of text should be
1538 translated, whether it is an argument of a Texinfo command or a small
1539 piece sandwiched between two Texinfo commands, try to track whether and
1540 where it appears in PDF and/or HTML output as visible text.  This piece
1541 of advice is especially useful for translating @file{macros.itexi}.
1543 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1544 blocs).  However, some music snippets containing text that shows in
1545 the rendered music, and sometimes translating this text really helps
1546 the user to understand the documentation; in this case, and only in
1547 this case, you may as an exception translate text in the music
1548 snippet, and then you must add a line immediately before the
1549 @code{@@lilypond} block, starting with
1551 @example
1552 @@c KEEP LY
1553 @end example
1555 @noindent
1556 Otherwise the music snippet would be reset to the same content as the
1557 English version at next @command{make snippet-update} run -- see
1558 @ref{Updating documentation translation}.
1560 When you encounter
1562 @example
1563 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1564 @end example
1566 @noindent
1567 in the source, open @file{Documentation/snippets/@var{filename}.ly},
1568 translate the @code{texidoc} header field it contains, enclose it with
1569 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1570 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}.
1571 Additionnally, you may translate the snippet's title in @code{doctitle}
1572 header field, in case @code{doctitle} is a fragment option used in
1573 @code{@@lilypondfile}; you can do this exactly the same way as
1574 @code{texidoc}.  For instance,
1575 @file{Documentation/@var{MY-LANGUAGE}/texidocs/@var{filename}.texidoc}
1576 may contain
1578 @example
1579 doctitlees = "Spanish title baz"
1580 texidoces = "
1581 Spanish translation blah
1583 @end example
1585 @noindent
1586 Then, you should get these translated strings into compiled snippets in
1587 @file{Documentation/snippets}, see @q{General guidelines} in @ref{Adding
1588 and editing snippets}.
1590 @code{@@example} blocks need not be verbatim copies, e.g. variable
1591 names, file names and comments should be translated.
1593 Finally, please carefully apply every rule exposed in @ref{Texinfo
1594 introduction and usage policy}, and @ref{Documentation policy}.  If one
1595 of these rules conflicts with a rule specific to your language, please
1596 ask the Translation meister on @email{translations@@lilynet.net} list
1597 and/or the Documentation Editors on @email{lilypond-devel@@gnu.org}
1598 list.
1601 @node Adding a Texinfo manual
1602 @unnumberedsubsubsec Adding a Texinfo manual
1604 In order to start translating a new manual whose basename is @var{FOO},
1607 @example
1608 cd Documentation/@var{MY-LANGUAGE}
1609 cp ../@var{FOO}.tely .
1610 mkdir @var{FOO}
1611 cp web/GNUmakefile @var{FOO}
1612 @end example
1614 @noindent
1615 then append @var{FOO} to variable @code{SUBDIRS} in
1616 Documentation/@var{MY-LANGUAGE}/GNUmakefile, then translate file
1617 @var{MY-LANGUAGE}/@var{FOO}.tely and run @code{skeleton-update}:
1619 @example
1620 cd Documentation/
1621 make ISOLANG=@var{MY-LANGUAGE} TEXI_LANGUTIL_FLAGS=--head-only skeleton-update
1622 @end example
1624 @noindent
1625 Your are now ready to translate the new manual exactly like the web site
1626 or the Learning Manual.
1629 @node Documentation translation maintenance
1630 @subsection Documentation translation maintenance
1632 Several tools have been developed to make translations maintenance
1633 easier.  These helper scripts make use of the power of Git, the
1634 version control system used for LilyPond development.
1636 You should use them whenever you would like to update the translation in
1637 your language, which you may do at the frequency that fits your and your
1638 cotranslators' respective available times.  In the case your translation
1639 is up-do-date (which you can discover in the first subsection below), it
1640 is enough to check its state every one or two weeks.  If you feel
1641 overwhelmed by the quantity of documentation to be updated, see
1642 @ref{Maintaining without updating translations}.
1644 @menu
1645 * Check state of translation::
1646 * Updating documentation translation::
1647 * Updating translation committishes::
1648 @end menu
1650 @macro seeCommittishesUpdate{}
1651 @warning{do not forget to update the committish in each file you have
1652 completely updated, see @ref{Updating translation committishes}.}
1653 @end macro
1655 @node Check state of translation
1656 @unnumberedsubsubsec Check state of translation
1658 First pull from Git -- see @ref{Pulling and rebasing}, but DO NOT rebase
1659 unless you are sure to master the translation state checking and
1660 updating system -- then cd into @file{Documentation/} (or at top of the
1661 source tree, replace @command{make} with @command{make -C
1662 Documentation}) and run
1664 @example
1665 make ISOLANG=@var{MY_LANGUAGE} check-translation
1666 @end example
1668 @noindent
1669 This presents a diff of the original files since the most recent
1670 revision of the translation.  To check a single file, cd into
1671 @file{Documentation/} and run
1673 @example
1674 make CHECKED_FILES=@var{MY_LANGUAGE}/@var{manual}/@var{foo}.itely check-translation
1675 @end example
1677 @noindent
1678 In case this file has been renamed since you last updated the
1679 translation, you should specify both old and new file names, e.g.
1680 @code{CHECKED_FILES=@var{MY_LANGUAGE}/@{@var{manual},user@}/@var{foo}.itely}.
1682 To see only which files need to be updated, do
1684 @example
1685 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1686 @end example
1688 To avoid printing terminal colors control characters, which is often
1689 desirable when you redirect output to a file, run
1691 @example
1692 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1693 @end example
1695 You can see the diffs generated by the commands above as changes that
1696 you should make in your language to the existing translation, in order
1697 to make your translation up to date.
1699 @seeCommittishesUpdate
1701 Global state of the translation is recorded in
1702 @file{Documentation/translations.itexi}, which is used to generate
1703 Translations status page.  To update that page, do from
1704 @file{Documentation/}
1706 @example
1707 make translation-status
1708 @end example
1710 This will also leave @file{out/translations-status.txt}, which contains
1711 up-to-dateness percentages for each translated file, and update word
1712 counts of documentation files in this Guide.
1714 @seealso
1715 @ref{Maintaining without updating translations}.
1717 @node Updating documentation translation
1718 @unnumberedsubsubsec Updating documentation translation
1720 Instead of running @code{check-translation}, you may want to run
1721 @code{update-translation}, which will run your favorite text editor to
1722 update files.  First, make sure environment variable @code{EDITOR} is
1723 set to a text editor command, then run from @file{Documentation/}
1725 @example
1726 make ISOLANG=@var{MY_LANGUAGE} update-translation
1727 @end example
1729 @noindent
1730 or to update a single file
1732 @example
1733 make CHECKED_FILES=@var{MY_LANGUAGE/@var{manual}/foo.itely} update-translation
1734 @end example
1736 For each file to be udpated, @code{update-translation} will open your
1737 text editor with this file and a diff of the file in English; if the
1738 diff cannot be generated or is bigger than the file in English itself,
1739 the full file in English will be opened instead.
1741 @seeCommittishesUpdate
1743 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1744 containing only the first node of the original file in English can be
1745 updated automatically: whenever @command{make check-translation} shows
1746 that such files should be updated, run from @file{Documentation/}
1748 @example
1749 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1750 @end example
1752 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1753 by issuing from @file{Documentation/} or @file{Documentation/po/}
1755 @example
1756 make po-update
1757 @end example
1759 @warning{if you run po-update and somebody else does the same and
1760 pushes before you push or send a patch to be applied, there will be a
1761 conflict when you pull.  Therefore, it is better that only the
1762 Translation meister runs this command.}
1764 Updating music snippets can quickly become cumbersome, as most
1765 snippets should be identical in all languages.  Fortunately, there is
1766 a script that can do this odd job for you (run from
1767 @file{Documentation/}):
1769 @example
1770 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1771 @end example
1773 This script overwrites music snippets in
1774 @file{@var{MY_LANGUAGE/foo/every.itely}} with music snippets from
1775 @file{@var{foo/every.itely}}.  It ignores skeleton files, and keeps
1776 intact music snippets preceded with a line starting with @code{@@c
1777 KEEP LY}; it reports an error for each @file{.itely} that has not the
1778 same music snippet count in both languages.  Always use this script
1779 with a lot of care, i.e. run it on a clean Git working tree, and check
1780 the changes it made with @command{git diff} before committing; if you
1781 don't do so, some @code{@@lilypond} snippets might be broken or make
1782 no sense in their context.
1784 When you have updated texidocs in
1785 @file{Documentation/@var{MY-LANGUAGE}/texidocs}, you can get these
1786 changes into compiled snippets in @file{Documentation/snippets}, see
1787 @q{General guidelines} in @ref{Adding and editing snippets}.
1789 Finally, a command runs the three update processes above for all
1790 enabled languages (from @file{Documentation/}):
1792 @example
1793 make all-translations-update
1794 @end example
1796 Use this command with caution, and keep in mind it will not be really
1797 useful until translations are stabilized after the end of GDP and GOP.
1799 @seealso
1800 @ref{Maintaining without updating translations},
1801 @ref{Adding and editing snippets}.
1804 @node Updating translation committishes
1805 @unnumberedsubsubsec Updating translation committishes
1807 At the beginning of each translated file except PO files, there is a
1808 committish which represents the revision of the sources which you have
1809 used to translate this file from the file in English.
1811 When you have pulled and updated a translation, it is very important to
1812 update this committish in the files you have completely updated (and
1813 only these); to do this, first commit possible changes to any
1814 documentation in English which you are sure to have done in your
1815 translation as well, then replace in the up-to-date translated files the
1816 old committish by the committish of latest commit, which can be obtained
1817 by doing
1819 @example
1820 git rev-list HEAD |head -1
1821 @end example
1823 A special case is updating Snippet documentation strings in
1824 @file{Documentation/@var{MY-LANGUAGE}/texidocs}.  For these to be
1825 correctly marked as up-to-date, first run @code{makelsr.py} as
1826 explained in @ref{Adding and editing snippets}, and commit the
1827 resulting compiled snippets left in @file{Documentation/snippets/}.
1828 Say the SHA1 ID code of this commit is <C>.  Now edit again your
1829 translated files in @file{Documentation/@var{MY-LANGUAGE}/texidocs}
1830 adjusting the 40-digit committish that appears in the text to be <C>;
1831 finally, commit these updated files.  Not doing so would result in
1832 changes made both to your updates and original snippets to
1833 persistently appear in the check-translation output as if they were
1834 out of sync.
1836 This two-phase mechanism avoids the (practically) unsolvable problem
1837 of guessing what committish will have our update, and pretending to
1838 put this very committish on the files in the same commit.
1840 @c http://lists.gnu.org/archive/html/lilypond-devel/2009-01/msg00245.html
1841 @c contains a helper script which could be used to perform massive
1842 @c committish updates.
1845 @seealso
1846 @ref{LSR work}.
1848 @node Translations management policies
1849 @subsection Translations management policies
1851 These policies show the general intent of how the translations should
1852 be managed, they aim at helping translators, developers and
1853 coordinators work efficiently.
1855 @menu
1856 * Maintaining without updating translations::
1857 * Managing documentation translation with Git::
1858 @end menu
1860 @node Maintaining without updating translations
1861 @unnumberedsubsubsec Maintaining without updating translations
1863 Keeping translations up to date under heavy changes in the documentation
1864 in English may be almost impossible, especially as during the former
1865 Grand Documentation Project (GDP) or the Grand Organization Project
1866 (GOP) when a lot of contributors brings changes.  In addition,
1867 translators may be --- and that is a very good thing --- involved in
1868 these projects too.
1870 it is possible --- and even recommended --- to perform some maintenance
1871 that keeps translated documentation usable and eases future translation
1872 updating.  The rationale below the tasks list motivates this plan.
1874 The following tasks are listed in decreasing priority order.
1876 @enumerate
1877 @item Update macros.itexi.
1878 For each obsolete macro definition, if it is possible to update macro
1879 usage in documentation with an automatic text or regexp substitution,
1880 do it and delete the macro definition from macros.itexi; otherwise,
1881 mark this macro definition as obsolete with a comment, and keep it in
1882 macros.itexi until the documentation translation has been updated and
1883 no longer uses this macro.
1885 @item Update @file{*.tely} files completely with
1886 @command{make check-translation} -- you may want to redirect ouptput
1887 to a file because of overwhelming output, or call check-translation.py
1888 on individual files, see @ref{Check state of translation}.
1890 @item In @file{.itelys}, match sections and .itely file names with those from
1891 English docs, which possibly involves moving nodes contents in block
1892 between files, without updating contents itself.  In other words, the
1893 game is catching where has gone each section.  In Learning manual, and
1894 in Notation Reference sections which have been revised in GDP, there may
1895 be completely new sections: in this case, copy @code{@@node} and
1896 @code{@@section}-command from English docs, and add the marker for
1897 untranslated status @code{@@untranslated} on a single line.  Note that
1898 it is not possible to exactly match subsections or subsubsections of
1899 documentation in English, when contents has been deeply revised; in this
1900 case, keep obsolete (sub)subsections in the translation, marking them
1901 with a line @code{@@c obsolete} just before the node.
1903 Emacs with Texinfo mode makes this step easier:
1905 @itemize
1906 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
1907 Texinfo file in a new buffer @code{*Occur*}; to show structure of two files
1908 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
1909 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
1910 (e.g. the translated file), copy @code{*Occur*} contents into
1911 @code{*Scratch*}, then press @key{C-c C-s} for the other file.
1913 If you happen to have installed AucTeX, you can either call the macro
1914 by doing @key{M-x texinfo-show-structure} or create a key binding in your
1915 @file{~/.emacs}, by adding the four following lines:
1917 @example
1918 (add-hook 'Texinfo-mode-hook
1919           '(lambda ()
1920              (define-key Texinfo-mode-map "\C-cs"
1921               'texinfo-show-structure)))
1922 @end example
1924 @noindent
1925 and then obtain the structure in the @code{*Occur*} buffer with @key{C-c
1928 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
1929 file, just do @key{C-c C-u C-a} (@qq{update all menus}) when you have
1930 updated all the rest of the file.
1932 @item Moving to next or previous node using incremental search: press
1933 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
1934 contains the word @q{node}) then press @key{C-s} to move to next node
1935 or @key{C-r} to move to previous node.  Similar operation can be used
1936 to move to the next/previous section.  Note that every cursor move
1937 exits incremental search, and hitting @key{C-s} twice starts
1938 incremental search with the text entered in previous incremental
1939 search.
1941 @item Moving a whole node (or even a sequence of nodes): jump to beginning
1942 of the node (quit incremental search by pressing an arrow), press
1943 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
1944 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
1945 the right place (moving between nodes with the previous hint is often
1946 useful) and paste with @key{C-y} or @key{C-v}.
1947 @end itemize
1949 @item Update sections finished in the English documentation; check
1950 sections status at
1951 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
1953 @item Update documentation PO.  It is recommended not to update
1954 strings which come from documentation that is currently deeply revised
1955 in English, to avoid doing the work more than once.
1957 @item Fix broken cross-references by running (from @file{Documentation/})
1959 @example
1960 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
1961 @end example
1963 @noindent
1964 This step requires a sucessful documentation build (with @command{make
1965 doc}).  Some cross-references are broken because they point to a node
1966 that exists in the documentation in English, which has not been added
1967 to the translation; in this case, do not fix the cross-reference but
1968 keep it "broken", so that the resulting HTML link will point to an
1969 existing page of documentation in English.
1970 @end enumerate
1972 @subsubheading Rationale
1974 You may wonder if it would not be better to leave translations as-is
1975 until you can really start updating translations.  There are several
1976 reasons to do these maintenance tasks right now.
1978 @itemize
1979 @item This will have to be done sooner or later anyway, before updating
1980 translation of documentation contents, and this can already be done
1981 without needing to be redone later, as sections of documentation in
1982 English are mostly revised once.  However, note that not all
1983 documentation sectioning has been revised in one go, so all this
1984 maintenance plan has to be repeated whenever a big reorganization is
1985 made.
1987 @item This just makes translated documentation take advantage of the new
1988 organization, which is better than the old one.
1990 @item Moving and renaming sections to match sectioning of documentation in
1991 English simplify future updating work: it allows updating the
1992 translation by side-by-side comparison, without bothering whether
1993 cross-reference names already exist in the translation.
1995 @item Each maintenance task except @q{Updating PO files} can be done by
1996 the same person for all languages, which saves overall time spent by
1997 translators to achieve this task: the node names and section titles
1998 are in English, so you can do.  It is important to take advantage of
1999 this now, as it will be more complicated (but still possible) to do
2000 step 3 in all languages when documentation is compiled with
2001 @command{texi2html} and node names are directly translated in source
2002 files.
2003 @end itemize
2006 @node Managing documentation translation with Git
2007 @unnumberedsubsubsec Managing documentation translation with Git
2009 This policy explains how to manage Git branches and commit
2010 translations to Git.
2012 @itemize
2013 @item Translation changes matching master branch are preferably made on
2014 @code{lilypond/translation} branch; they may be pushed directly to
2015 @code{master} only if they do not break compilation of LilyPond and
2016 its documentation, and in this case they should be pushed to
2017 @code{lilypond/translation} too.  Similarly, changes matching
2018 @code{stable/X.Y} are preferably made on
2019 @code{lilypond/X.Ytranslation}.
2021 @item @code{lilypond/translation} Git branch may be merged into
2022 master only if LilyPond (@command{make all}) and documentation
2023 (@command{make doc}) compile succesfully.
2025 @item @code{master} Git branch may be merged into
2026 @code{lilypond/translation} whenever @command{make} and @command{make
2027 doc} are succesful (in order to ease documentation compilation by
2028 translators), or when significant changes had been made in
2029 documentation in English in master branch.
2031 @item General maintenance may be done by anybody who knows what he does
2032 in documentation in all languages, without informing translators
2033 first.  General maintenance include simple text substitutions
2034 (e.g. automated by sed), compilation fixes, updating Texinfo or
2035 lilypond-book commands, updating macros, updating ly code, fixing
2036 cross-references, and operations described in @ref{Maintaining
2037 without updating translations}.
2038 @end itemize
2041 @node Technical background
2042 @subsection Technical background
2044 A number of Python scripts handle a part of the documentation
2045 translation process.  All scripts used to maintain the translations
2046 are located in @file{scripts/auxiliar/}.
2048 @itemize
2049 @item @file{check_translation.py}  -- show diff to update a translation,
2050 @item @file{texi-langutils.py}  -- quickly and dirtily parse Texinfo files to
2051 make message catalogs and Texinfo skeleton files,
2052 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
2053 @item @file{update-snippets.py} -- synchronize ly snippets with those
2054 from English docs,
2055 @item @file{translations-status.py} -- update translations status pages and word
2056 counts in the file you are reading,
2057 @item @file{tely-gettext.py} -- gettext node names, section titles and references
2058 in the sources; WARNING only use this script once for each file, when support for
2059 "makeinfo --html" has been dropped.
2060 @end itemize
2062 Other scripts are used in the build process, in @file{scripts/build/}:
2064 @itemize
2065 @item @file{mass-link.py} -- link or symlink files between English documentation
2066 and documentation in other languages.
2067 @end itemize
2069 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
2070 not by installed Python scripts) are located in @file{python/auxiliar/}:
2071 @itemize
2072 @item @file{manuals_definitions.py} -- define manual names and name of
2073 cross-reference Texinfo macros,
2074 @item @file{buildlib.py} -- common functions (read piped output
2075 of a shell command, use Git),
2076 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
2077 tweak links in HTML pages.
2078 @end itemize
2080 And finally
2081 @itemize
2082 @item @file{python/langdefs.py}  -- language definitions module
2083 @end itemize