1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @node Documentation work
3 @chapter Documentation work
6 * Introduction to documentation work::
7 * Documentation suggestions::
8 * Texinfo introduction and usage policy::
9 * Documentation policy::
10 * Tips for writing docs::
11 * Updating docs with convert-ly::
12 * Translating the documentation::
16 @node Introduction to documentation work
17 @section Introduction to documentation work
19 Our documentation tries to adhere to our @ref{Documentation
20 policy}. This policy contains a few items which may seem odd.
21 One policy in particular is often questioned by potential
22 contributors: we do not repeat material in the Notation Reference,
23 and instead provide links to the @qq{definitive} presentation of
24 that information. Some people point out, with good reason, that
25 this makes the documentation harder to read. If we repeated
26 certain information in relevant places, readers would be less
27 likely to miss that information.
29 That reasoning is sound, but we have two counter-arguments.
30 First, the Notation Reference -- one of @emph{five} manuals for
31 users to read -- is already over 500 pages long. If we repeated
32 material, we could easily exceed 1000 pages! Second, and much
33 more importantly, LilyPond is an evolving project. New features
34 are added, bugs are fixed, and bugs are discovered and documented.
35 If features are discussed in multiple places, the documentation
36 team must find every instance. Since the manual is so large, it
37 is impossible for one person to have the location of every piece
38 of information memorized, so any attempt to update the
39 documentation will invariably omit a few places. This second
40 concern is not at all theoretical; the documentation used to be
41 plagued with inconsistent information.
43 If the documentation were targeted for a specific version -- say,
44 LilyPond 2.10.5 -- and we had unlimited resources to spend on
45 documentation, then we could avoid this second problem. But since
46 LilyPond evolves (and that is a very good thing!), and since we
47 have quite limited resources, this policy remains in place.
49 A few other policies (such as not permitting the use of tweaks in
50 the main portion of NR 1+2) may also seem counter-intuitive, but
51 they also stem from attempting to find the most effective use of
52 limited documentation help.
55 @node Documentation suggestions
56 @section Documentation suggestions
58 @subheading Small additions
60 For additions to the documentation,
65 Tell us where the addition should be placed. Please include both
66 the section number and title (i.e. "LM 2.13 Printing lyrics").
69 Please write exact changes to the text.
72 A formal patch to the source code is @emph{not} required; we can
73 take care of the technical details. Here is an example of a
74 perfect documentation report:
77 To: lilypond-devel@gnu.org
78 From: helpful-user@example.net
81 In LM 2.13 (printing lyrics), above the last line ("More options,
82 like..."), please add:
85 To add lyrics to a divided part, use blah blah blah. For example,
88 \notes {blah <<blah>> }
89 \lyrics {blah <<blah>> }
94 In addition, the second sentence of the first paragraph is
95 confusing. Please delete that sentence (it begins "Users
96 often...") and replace it with this:
98 To align lyrics with something, do this thing.
108 @subheading Larger contributions
110 To replace large sections of the documentation, the guidelines are
111 stricter. We cannot remove parts of the current documentation
112 unless we are certain that the new version is an improvement.
117 Ask on the lilypond-devel maillist if such a rewrite is necessary;
118 somebody else might already be working on this issue!
121 Split your work into small sections; this makes it much easier to
122 compare the new and old documentation.
125 Please prepare a formal git patch.
129 Once you have followed these guidelines, please send a message to
130 lilypond-devel with your documentation submissions. Unfortunately
131 there is a strict “no top-posting” check on the mailist; to avoid
134 > I'm not top posting.
136 (you must include the > ) to the top of your documentation
139 We may edit your suggestion for spelling, grammar, or style, and
140 we may not place the material exactly where you suggested, but if
141 you give us some material to work with, we can improve the manual
142 much faster. Thanks for your interest!
145 @node Texinfo introduction and usage policy
146 @section Texinfo introduction and usage policy
149 * Texinfo introduction::
150 * Documentation files::
151 * Sectioning commands::
152 * LilyPond formatting::
155 * Other text concerns::
159 @node Texinfo introduction
160 @subsection Texinfo introduction
162 The language is called Texinfo; you can see its manual here:
164 @uref{http://www.gnu.org/software/texinfo/manual/texinfo/}
166 However, you don't need to read those docs. The most important
167 thing to notice is that text is text. If you see a mistake in the
168 text, you can fix it. If you want to change the order of
169 something, you can cut-and-paste that stuff into a new location.
171 @warning{Rule of thumb: follow the examples in the existing docs.
172 You can learn most of what you need to know from this; if you want
173 to do anything fancy, discuss it on @code{lilypond-devel} first.}
176 @node Documentation files
177 @subsection Documentation files
179 The user manuals lives in @file{Documentation/user/}. In
180 particular, the files @file{lilypond-learning.ly} (LM),
181 @file{lilypond.itely} (NR), @file{music-glossary.tely} (MG), and
182 @file{lilypond-program} (AU). Each chapter is written in a
183 separate file (ending in @file{.itely} for files containing
184 lilypond code, and @file{.itexi} for files without lilypond code);
185 see the @qq{main} file for each manual to determine the filename
186 of the specific chapter you wish to modify.
188 Developer manuals live in @file{Documentation/devel}. Currently
189 there is only one; @file{contrib-guide.texi}.
191 Although snippets are part of documentation, they are not
192 (directly) part of the manuals. For information about how to
193 modify them, see @ref{LSR work}.
196 @node Sectioning commands
197 @subsection Sectioning commands
199 Most of the manual operates at the
207 level. Sections are created with
216 Please leave two blank lines above a @@node; this makes it
217 easier to find sections in texinfo.
220 Sectioning commands (@@node and @@section) must not appear
221 inside an @@ignore. Separate those commands with a space, ie @@n
227 @node LilyPond formatting
228 @subsection LilyPond formatting
233 Use two spaces for indentation in lilypond examples. (no
237 All text strings should be prefaced with #. LilyPond does
238 not strictly require this, but it is helpful to get users
239 accustomed to this scheme construct. ie @code{\set
240 Staff.instrumentName = #"cello"}
243 All engravers should have double-quotes around them:
246 \consists "Spans_arpeggio_engraver"
249 Again, LilyPond does not strictly require this, but it is a useful
253 Examples should end with a complete bar if possible.
256 If possible, only write one bar per line. The notes on each
257 line should be an independent line -- tweaks should occur on their
258 own line if possible. Bad:
261 \override textscript #'padding = #3 c1^"hi"
267 \override textscript #'padding = #3
272 Most LilyPond input should be produced with:
275 @@lilypond[verbatim,quote,relative=2]
282 @@lilypond[verbatim,quote,relative=1]
285 If you want to use \layout@{@} or define variables, use
288 @@lilypond[verbatim,quote]
291 In rare cases, other options may be used (or omitted), but ask first.
294 Inspirational headwords are produced with
297 @@lilypondfile[quote,ragged-right,line-width=16\cm,staffsize=16]
298 @{pitches-headword.ly@}
302 LSR snippets are linked with
305 @@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
310 excepted in Templates, where `doctitle' may be omitted.
313 Avoid long stretches of input code. Noone is going to read
314 them in print. Please create a smaller example. (the smaller
315 example does not need to be minimal, however)
318 Specify durations for at least the first note of every bar.
321 If possible, end with a complete bar.
324 Comments should go on their own line, and be placed before
325 the line(s) to which they refer.
328 Add extra spaces around @{ @} marks; ie
331 not: \chordmode @{c e g@}
332 but instead: \chordmode @{ c e g @}
336 If you only have one bar per line, omit bar checks. If you
337 put more than one bar per line (not recommended), then include bar
341 If you want to work on an example outside of the manual (for
342 easier/faster processing), use this header:
346 #(define dump-extents #t)
348 line-width = 160\mm - 2.0 * 0.4\in
350 force-assignment = #""
351 line-width = #(- line-width (* mm 3.000000))
358 You may not change any of these values. If you are making an
359 example demonstrating special \paper@{@} values, contact the
360 Documentation Editor.
365 @node Text formatting
366 @subsection Text formatting
371 Lines should be less than 72 characters long. (I personally
372 recommend writing with 66-char lines, but don't bother modifying
379 Do not use spaces at the beginning of a line (except in
380 @@example or @@verbatim environments), and do not use more than a
381 single space between words. `makeinfo' copies the input lines
382 verbatim without removing those spaces.
385 Use two spaces after a period.
388 In examples of syntax, use @@var@{musicexpr@} for a music
392 Don't use @@rinternals@{@} in the main text. If you're
393 tempted to do so, you're probably getting too close to "talking
394 through the code". If you really want to refer to a context, use
395 @@code@{@} in the main text and @@rinternals@{@} in the @@seealso.
398 Variables or numbers which consist of a single character
399 (probably followed by a punctuation mark) should be tied properly,
400 either to the previous or the next word. Example:
403 The variable@@tie@{@}@@var@{a@} ...
407 To get consistent indentation in the DVI output it is better
408 to avoid the @@verbatim environment. Use the @@example
409 environment instead if possible, but without extraneous
410 indentation. For example, this
421 should be replaced with
432 where `@@example' starts the line (without leading spaces).
435 Do not compress the input vertically; this is, do not use
438 Beginning of logical unit
442 continuation of logical unit
449 Beginning of logical unit
456 continuation of logical unit
459 This makes it easier to avoid forgetting the `@@noindent'. Only
460 use @@noindent if the material is discussing the same material;
461 new material should simply begin without anything special on the
465 in @@itemize use @@item
466 on a separate line like this:
477 Do not use @@itemize @@bullet.
480 To get LilyPond version, use @@version@{@} (this does not work
481 inside LilyPond snippets). If you write "@@version@{@}" (enclosed
482 with quotes), or generally if @@version@{@} is not followed by a
483 space, tere will be an ugly line break in PDF output unless you
491 @@w@{"@@version@{@}"@}
498 @subsection Syntax survey
502 @@c - single line comments
503 "@@c NOTE:" is a comment which should remain in the final
504 version. (gp only command ;)
506 @@ignore ... @@end ignore - multi-line comment
509 @@cindex - General index. Please add as many as you can. Don't
510 capitalize the first word.
512 @@funindex - is for a \lilycommand.
515 @@example ... @@end ignore - example text that should be set as a
516 blockquote. Any @{@} must be escaped with @@@{ @}@@
520 B ... @@end itemize - for bulleted lists.
521 Do not compress vertically like this.
524 @@code@{@} - typeset in a tt-font. Use for actual lilypond code or
525 property/context names. If the name contains a space, wrap
526 the entire thing inside @@w@{@@code@{ @}@}.
528 @@notation@{@} - refers to pieces of notation, e.g.
529 "@@notation@{cres.@}". Also use to specific lyrics ("the
530 @@notation@{A - men@} is centered"). Only use once per subsection
533 @@q@{@} - Single quotes. Used for `vague' terms.
535 @@qq@{@} - Double quotes. Used for actual quotes ("he said") or for
536 introducing special input modes.
539 @@tie@{@} - Variables or numbers which consist of a single character
540 (probably followed by a punctuation mark) should be tied
541 properly, either to the previous or the next word. Example:
542 "The letter@@tie@{@}@@q@{I@} is skipped"
545 @@var - Use for variables.
547 @@warning@{@} - produces a "Note: " box. Use for important messages.
550 @@bs - Generates a backslash inside @@warning.
551 Any `\' used inside @@warning (and @@q or @@qq) must be written as `@@bs@{@}'
552 (texinfo would also allow \\, but this breaks with PDF output).
555 @@ref@{@} - normal references (type the exact node name inside the
556 @{@}). @@ruser@{@} - link to the NR. @@rlearning@{@} - link to
557 the LM. @@rglos@{@} - link to the MG. @@rprogram@{@} - link to
558 the AU. @@rlsr@{@} - link to a Snippet section. @@rinternals@{@}
565 @node Other text concerns
566 @subsection Other text concerns
571 References must occur at the end of a sentence, for more
572 information see @@ref@{the texinfo manual@}. Ideally this should
573 also be the final sentence of a paragraph, but this is not
574 required. Any link in a doc section must be duplicated in the
575 @@seealso section at the bottom.
578 Introducing examples must be done with
581 . (ie finish the previous sentence/paragaph)
582 : (ie `in this example:')
583 , (ie `may add foo with the blah construct,')
586 The old "sentence runs directly into the example" method is not
590 Abbrevs in caps, e.g., HTML, DVI, MIDI, etc.
601 When beginning a quote: "So, he said,...".
603 This usage is rarer. Americans often just use a comma.
606 When adding a defining example at the end of a sentence.
611 Non-ASCII characters which are in utf-8 should be directly used;
612 this is, don't say `Ba@@ss@{@}tuba' but `Baßtuba'. This ensures
613 that all such characters appear in all output formats.
620 @node Documentation policy
621 @section Documentation policy
625 * Section organization::
626 * Checking cross-references::
628 * Technical writing style::
634 There are four parts to the documentation: the Learning Manual,
635 the Notation Reference, the Program Reference, and the Music
643 The LM is written in a tutorial style which introduces the most
644 important concepts, structure and syntax of the elements of a
645 LilyPond score in a carefully graded sequence of steps.
646 Explanations of all musical concepts used in the Manual can be
647 found in the Music Glossary, and readers are assumed to have no
648 prior knowledge of LilyPond. The objective is to take readers to
649 a level where the Notation Reference can be understood and
650 employed to both adapt the templates in the Appendix to their
651 needs and to begin to construct their own scores. Commonly used
652 tweaks are introduced and explained. Examples are provided
653 throughout which, while being focussed on the topic being
654 introduced, are long enough to seem real in order to retain the
655 readers' interest. Each example builds on the previous material,
656 and comments are used liberally. Every new aspect is thoroughly
657 explained before it is used.
659 Users are encouraged to read the complete Learning Manual from
664 Notation Reference: a (hopefully complete) description of LilyPond
665 input notation. Some material from here may be duplicated in the
666 Learning Manual (for teaching), but consider the NR to be the
667 "definitive" description of each notation element, with the LM
668 being an "extra". The goal is _not_ to provide a step-by-step
669 learning environment -- do not avoid using notation that has not
670 be introduced previously in the NR (for example, use \break if
671 appropriate). This section is written in formal technical writing
674 Avoid duplication. Although users are not expected to read this
675 manual from start to finish, they should be familiar with the
676 material in the Learning Manual (particularly ``Fundamental
677 Concepts''), so do not repeat that material in each section of
678 this book. Also watch out for common constructs, like ^ - _ for
679 directions -- those are explained in NR 3. In NR 1, you can
680 write: DYNAMICS may be manually placed above or below the staff,
681 see @@ref@{Controlling direction and placement@}.
683 Most tweaks should be added to LSR and not placed directly in the
684 .itely file. In some cases, tweaks may be placed in the main
685 text, but ask about this first.
687 Finally, you should assume that users know what the notation
688 means; explaining musical concepts happens in the Music Glossary.
692 Application Usage: information about using the program lilypond
693 with other programs (lilypond-book, operating systems, GUIs,
694 convert-ly, etc). This section is written in formal technical
697 Users are not expected to read this manual from start to finish.
701 Music Glossary: information about the music notation itself.
702 Explanations and translations about notation terms go here.
704 Users are not expected to read this manual from start to finish.
707 Internals Reference: not really a documentation book, since it is
708 automagically generated from the source, but this is its name.
713 @node Section organization
714 @subsection Section organization
719 The order of headings inside documentation sections should
732 You @emph{must} include a @@seealso.
736 The order of items inside the @@seealso section is
745 @@rlearning@{foozle@}.
755 @@file@{path/to/dir/blahz@}.
757 Snippets: @@rlsr@{section@}.
760 @@rinternals@{fazzle@},
761 @@rinternals@{booar@}.
765 If there are multiple entries, separate them by commas but do not
769 Always end with a period.
772 Place each link on a new line as above; this makes it much easier
773 to add or remove links. In the output, they appear on a single
776 ("Snippets" is REQUIRED; the others are optional)
779 Any new concepts or links which require an explanation should go
780 as a full sentence(s) in the main text.
783 Don't insert an empty line between @@seealso and the first entry!
784 Otherwise there is excessive vertical space in the PDF output.
789 To create links, use @@ref@{@} if the link is within the same
793 @@predefined ... @@endpredefined is for commands in ly/*-init.ly
797 Do not include any real info in second-level sections (ie 1.1
798 Pitches). A first-level section may have introductory material,
799 but other than that all material goes into third-level sections
800 (ie 1.1.1 Writing Pitches).
805 @node Checking cross-references
806 @subsection Checking cross-references
808 Cross-references between different manuals are heavily used in the
809 documentation, but they are not checked during compilation.
810 However, if you compile the documentation, a script called
811 check_texi_refs can help you with checking and fixing these
812 cross-references; for information on usage, cd into a source tree
813 where documentation has been built, cd into Documentation and look
814 for check-xrefs and fix-xrefs targets in 'make help' output. Note
815 that you have to find yourself the source files to fix
816 cross-references in the generated documentation such as the
817 Internals Reference; e.g. you can grep scm/ and lily/.
820 @node General writing
821 @subsection General writing
826 Do not forget to create @@cindex entries for new sections of text.
827 Enter commands with @@funindex, i.e.
830 @@cindex pitches, writing in different octaves
835 do not bother with the @@code@{@} (they are added automatically).
836 These items are added to both the command index and the unified
839 Both index commands should go in front of the actual material.
841 @@cindex entries should not be capitalized, ie
844 @@cindex time signature
848 is preferred instead of @qq{Time signature}, Only use capital
849 letters for musical terms which demand them, like D.S. al Fine.
851 For scheme functions, only include the final part, i.e.,
854 @@funindex modern-voice-cautionary
856 @@funindex #(set-accidental-style modern-voice-cautionary)
865 In general, use the American spellings. The internal lilypond
866 property names use this spelling.
869 List of specific terms:
873 simultaneous NOT concurrent
874 measure: the unit of music
875 bar line: the symbol delimiting a measure NOT barline
876 note head NOT notehead
877 chord construct NOT chord (when referring to <>)
885 @node Technical writing style
886 @subsection Technical writing style
888 These refer to the NR. The LM uses a more gentle, colloquial
894 Do not refer to LilyPond in the text. The reader knows what the
895 manual is about. If you do, capitalization is LilyPond.
898 If you explicitly refer to @q{lilypond} the program (or any other
899 command to be executed), write @code{@@command@{lilypond@}}.
902 Do not explicitly refer to the reader/user. There is no one else
903 besides the reader and the writer.
906 Avoid contractions (don't, won't, etc.). Spell the words out completely.
909 Avoid abbreviations, except for commonly used abbreviations of foreign
910 language terms such as etc. and i.e.
913 Avoid fluff (@qq{Notice that,} @qq{as you can see,}
917 The use of the word @q{illegal} is inappropriate in most cases.
918 Say @q{invalid} instead.
923 @node Tips for writing docs
924 @section Tips for writing docs
926 In the NR, I highly recommend focusing on one subsection at a
927 time. For each subsection,
932 check the mundane formatting. Are the headings (@@predefined,
933 @@seealso, etc.) in the right order?
936 add any appropriate index entries.
939 check the links in the @@seealso section -- links to music
940 glossary, internal references, and other NR sections are the main
941 concern. Check for potential additions.
944 move LSR-worthy material into LSR. Add the snippet, delete the
945 material from the .itely file, and add a @@lilypondfile command.
948 check the examples and descriptions. Do they still work?
949 @strong{Do not} assume that the existing text is
950 accurate/complete; some of the manual is highly out of date.
953 is the material in the @@knownissues still accurate?
956 can the examples be improved (made more explanatory), or is there
957 any missing info? (feel free to ask specific questions on -user;
958 a couple of people claimed to be interesting in being
959 @qq{consultants} who would help with such questions)
963 In general, I favor short text explanations with good examples --
964 @qq{an example is worth a thousand words}. When I worked on the
965 docs, I spent about half my time just working on those tiny
966 lilypond examples. Making easily-understandable examples is much
967 harder than it looks.
970 @subsubheading Tweaks
972 In general, any \set or \override commands should go in the
973 @qq{select snippets} section, which means that they should go in
974 LSR and not the .itely file. For some cases, the command
975 obviously belongs in the @qq{main text} (i.e. not inside
976 @@predefined or @@seealso or whatever) -- instrument names are a
977 good example of this.
980 \set Staff.instrumentName = #"foo"
983 On the other side of this,
986 \override Score.Hairpin #'after-line-breaking = ##t
989 clearly belongs in LSR.
991 I'm quite willing to discuss specific cases if you think that a
992 tweaks needs to be in the main text. But items that can go into
993 LSR are easier to maintain, so I'd like to move as much as
997 It would be @qq{nice} if you spent a lot of time crafting nice
998 tweaks for users... but my recommendation is @strong{not} to do
999 this. There's a lot of doc work to do without adding examples of
1000 tweaks. Tweak examples can easily be added by normal users by adding
1003 One place where a documentation writer can profitably spend time writing
1004 or upgrading tweaks is creating tweaks to deal with known issues. It
1005 would be ideal if every significant known issue had a workaround to avoid
1010 @ref{Adding and editing snippets}.
1013 @node Updating docs with convert-ly
1014 @section Updating doc with @command{convert-ly}
1016 cd into Documentation and run
1019 find . -name '*.itely' | xargs convert-ly -e
1023 This also updates translated documentation.
1027 @node Translating the documentation
1028 @section Translating the documentation
1031 * Getting started with documentation translation::
1032 * Documentation translation details::
1033 * Documentation translation maintenance::
1034 * Translations management policies::
1035 * Technical background::
1038 @node Getting started with documentation translation
1039 @subsection Getting started with documentation translation
1041 First, get the sources from the Git repository, see @ref{Documentation
1042 translations source code}.
1045 * Translation requirements::
1046 * Which documentation can be translated::
1047 * Starting translation in a new language::
1050 @node Translation requirements
1051 @unnumberedsubsubsec Translation requirements
1053 Working on LilyPond documentation translations requires the following
1054 pieces of software, in order to make use of dedicated helper tools:
1057 @item Python 2.4 or higher,
1062 It is not required to build LilyPond and the documentation to
1063 translate the documentation. However, if you have enough time and
1064 motivation and a suitable system, it can be very useful to build at
1065 least the documentation so that you can check the output yourself and
1066 more quickly; if you are interested, see @ref{Compiling from source}.
1071 @node Which documentation can be translated
1072 @unnumberedsubsubsec Which documentation can be translated
1074 The makefiles and scripts infrastructure currently supports translation
1075 of the following documentation:
1078 @item documentation index (HTML);
1079 @item user manual and program usage -- Texinfo source, PDF and HTML
1080 output; Info output might be added if there is enough demand for it;
1081 @item the News document.
1084 The following pieces of documentation should be added soon, by
1085 descending order of priority:
1088 @item automatically generated documentation: markup commands,
1089 predefined music functions;
1090 @item the Snippets List;
1091 @item the examples page;
1092 @item the Internals Reference.
1096 @node Starting translation in a new language
1097 @unnumberedsubsubsec Starting translation in a new language
1099 At top of the source directory, do
1106 or (if you want to install your self-compiled LilyPond locally)
1109 ./autogen.sh --prefix=$HOME
1113 If you want to compile LilyPond -- which is almost required to build
1114 the documentation, but is not required to do translation only -- fix
1115 all dependencies and rerun @command{./configure} (with the same
1116 options as for @command{autogen.sh}).
1118 Then @command{cd} into @file{Documentation} and run
1121 make ISOLANG=@var{MY-LANGUAGE} new-lang
1125 where @var{MY-LANGUAGE} is the ISO 639 language code.
1127 Finally, add a language definition for your language in
1128 @file{python/langdefs.py}.
1130 Before starting the real translation work, it is recommended to commit
1131 changes you made so far to Git, so e.g. you are able to get back to
1132 this state of the sources easily if needed; see @ref{Sharing your
1136 @node Documentation translation details
1137 @subsection Documentation translation details
1139 Please follow all the instructions with care to ensure quality work.
1141 All files should be encoded in UTF-8.
1144 * Files to be translated::
1145 * Translating the Learning Manual and other Texinfo documentation::
1146 * Translating the Notation Reference and Application Usage::
1147 * Translating the Documentation index index.html.in::
1150 @node Files to be translated
1151 @unnumberedsubsubsec Files to be translated
1153 @include doc-translation-list.itexi
1155 @node Translating the Learning Manual and other Texinfo documentation
1156 @unnumberedsubsubsec Translating the Learning Manual and other Texinfo documentation
1158 Any title which comes with one of the following commands must not be
1159 translated directly in the Texinfo source
1162 @@node @@majorheading
1163 @@chapter @@unnumbered @@appendix @@chapheading
1164 @@section @@unnumberedsec @@appendixsec @@heading
1165 @@subsection @@unnumberedsubsec @@appendixsubsec @@subheading
1166 @@subsubsection @@unnumberedsubsubsec @@appendixsubsubsec @@subsubheading
1167 @@ref @@rglos @@ruser @@rlearning @@rprogram @@rlsr
1170 The same applies to first argument of @code{@@r@var{manual}named}
1171 commands; however, the second argument @var{Bar baz} of
1172 @code{@@ref@{@var{Foo},@var{Bar baz},,@var{info-file}@}} and
1173 @code{@@r@var{manual}named@{@var{Foo},@var{Bar baz}@}} should be
1176 @code{@@uref}'s names are to be translated.
1178 In any section which looks like
1182 * @var{node1}:: @var{thing1}
1183 * @var{node2}:: @var{thing2}
1189 the node names @var{nodeN} are @emph{not} to be translated, whereas
1190 extra title information @var{thingN} is.
1192 Every node name or section title must from now on be translated
1193 separately in a @file{.po} file (just as well as LilyPond output
1194 messages) in @file{Documentation/po}. The Gettext domain is named
1195 @code{lilypond-doc}, and unlike @code{lilypond} domain it is not
1196 managed through the Free Translation Project.
1199 Take care of using typographic rules for your language, especially in
1200 @file{user/macros.itexi}.
1203 Please keep verbatim copies of music snippets (in @code{@@lilypond}
1204 blocs). However, some music snippets containing text that shows in
1205 the rendered music, and sometimes translating this text really helps
1206 the user to understand the documentation; in this case, and only in
1207 this case, you may as an exception translate text in the music
1208 snippet, and then you must add a line immediately before the
1209 @code{@@lilypond} block, starting with
1216 Otherwise the music snippet would be reset to the same content as the
1217 English version at next @command{make snippet-update} run -- see
1218 @ref{Updating documentation translation}.
1223 @@lilypondfile[<number of fragment options>,texidoc]@{@var{filename.ly}@}
1227 in the source, open @file{input/lsr/@var{filename}.ly}, translate the
1228 @code{texidoc} header field it contains, enclose it with
1229 @code{texidoc@var{MY-LANGUAGE} = "} and @code{"}, and write it into
1230 @file{input/texidocs/@var{filename}.texidoc} -- please keep possibly
1231 existing translations in other languages! Additionnally, you may
1232 translate the snippet's title in @code{doctitle} header field, in case
1233 @code{doctitle} is a fragment option used in @code{@@lilypondfile};
1234 you can do this exactly the same way as @code{texidoc}. For instance,
1235 @file{input/texidocs/@var{filename}.texidoc} may contain
1238 doctitlees = "Spanish title baz"
1240 Spanish translation blah
1242 doctitlede = "German title bar"
1243 texidocde = "German translation foo
1247 @code{@@example} blocs need not be verbatim copies, e.g. variable
1248 names, file names and comments should be translated.
1250 Index entries (@code{@@cindex} and so on) should be translated.
1252 Finally, please carefully apply every rule exposed in @ref{Texinfo
1253 introduction and usage policy}, and @ref{Documentation policy}. If
1254 one of these rules conflicts with a rule specific to your language,
1255 please ask the Translation meister and/or the Documentation Editors on
1256 @email{lilypond-devel@@gnu.org}.
1259 @node Translating the Notation Reference and Application Usage
1260 @unnumberedsubsubsec Translating the Notation Reference and Application Usage
1262 Copy @file{user/lilypond.tely} (or @file{user/lilypond-program.tely},
1263 respectively) into @file{@var{MY-LANGUAGE}/user}, then translate this
1264 file and run @code{skeleton-update} -- see @ref{Updating documentation
1265 translation}. Your are now ready to translate the Notation Reference
1266 (Application Usage, respectively) exactly like the Learning Manual.
1269 @node Translating the Documentation index index.html.in
1270 @unnumberedsubsubsec Translating the Documentation index @file{index.html.in}
1272 Unlike almost all HTML pages in this documentation, links in this page
1273 are not tweaked by @file{postprocess_html.py}, so links should be
1274 manually edited to link to existing translations.
1277 @node Documentation translation maintenance
1278 @subsection Documentation translation maintenance
1280 Several tools have been developed to make translations maintenance
1281 easier. These helper scripts make use of the power of Git, the
1282 version control system used for LilyPond development.
1285 * Check state of translation::
1286 * Updating documentation translation::
1289 @node Check state of translation
1290 @unnumberedsubsubsec Check state of translation
1292 First pull from Git, then cd into @file{Documentation/} (or at top of
1293 the source tree, replace @command{make} with @command{make -C
1294 Documentation}) and run
1297 make ISOLANG=@var{MY_LANGUAGE} check-translation
1301 This presents a diff of the original files since the most recent
1302 revision of the translation. To check a single file, cd into
1303 @file{Documentation/} and run
1306 make CHECKED_FILES=@var{MY_LANGUAGE/user/foo.itely} check-translation
1309 To see only which files need to be updated, do
1312 make ISOLANG=@var{MY_LANGUAGE} check-translation | grep 'diff --git'
1315 To avoid printing terminal colors control characters, which is often
1316 desirable when you redirect output to a file, run
1319 make ISOLANG=@var{MY_LANGUAGE} NO_COLOR=1 check-translation
1322 Global state of the translation is recorded in
1323 @file{Documentation/translations.html.in}, which is used to generate
1324 Translations status page. To update that page, do from
1325 @file{Documentation/}
1328 make translation-status
1331 This will also leave @file{out/translations-status.txt}, which contains
1332 up-to-dateness percentages for each translated file, and update word
1333 counts of documentation files in this Guide.
1337 @ref{Maintaining without updating translations}.
1340 @node Updating documentation translation
1341 @unnumberedsubsubsec Updating documentation translation
1343 Instead of running @code{check-translation}, you may want to run
1344 @code{update-translation}, which will run your favorite text editor to
1345 update files. First, make sure environment variable @code{EDITOR} is
1346 set to a text editor command, then run from @file{Documentation/}
1349 make ISOLANG=@var{MY_LANGUAGE} update-translation
1352 or to update a single file
1355 make CHECKED_FILES=@var{MY_LANGUAGE/user/foo.itely} update-translation
1358 For each file to be udpated, update-translation will open your text
1359 editor with this file and a diff of the file in English; if the diff
1360 cannot be generated or is bigger than the file in English itself, the
1361 full file in English will be opened instead.
1363 Texinfo skeleton files, i.e. @file{.itely} files not yet translated,
1364 containing only the Texinfo structure can be updated automatically:
1365 whenever @command{make check-translation} shows that such files should
1366 be updated, run from @file{Documentation/}
1369 make ISOLANG=@var{MY_LANGUAGE} skeleton-update
1372 @file{.po} message catalogs in @file{Documentation/po/} may be updated
1373 by issuing from @file{Documentation/} or @file{Documentation/po/}
1379 @warning{if you run po-update and somebody else does the same and
1380 pushes before you push or send a patch to be applied, there will be a
1381 conflict when you pull. Therefore, it is better that only the
1382 Translation meister runs this command.}
1384 Updating music snippets can quickly become cumbersome, as most
1385 snippets should be identical in all languages. Fortunately, there is
1386 a script that can do this odd job for you (run from
1387 @file{Documentation/}):
1390 make ISOLANG=@var{MY_LANGUAGE} snippet-update
1393 This script overwrites music snippets in
1394 @file{@var{MY_LANGUAGE/user/every.itely}} with music snippets from
1395 @file{@var{user/every.itely}}. It ignores skeleton files, and keeps
1396 intact music snippets preceded with a line starting with @code{@@c
1397 KEEP LY}; it reports an error for each @file{.itely} that has not the
1398 same music snippet count in both languages. Always use this script
1399 with a lot of care, i.e. run it on a clean Git working tree, and check
1400 the changes it made with @command{git diff} before committing; if you
1401 don't do so, some @code{@@lilypond} snippets might be broken or make
1402 no sense in their context.
1404 Finally, a command runs the three update processes above for all
1405 enabled languages (from @file{Documentation/}):
1408 make all-translations-update
1411 Use this command with caution, and keep in mind it will not be really
1412 useful until translations are stabilized after the end of GDP.
1416 @ref{Maintaining without updating translations}.
1419 @node Translations management policies
1420 @subsection Translations management policies
1422 These policies show the general intent of how the translations should
1423 be managed, they aim at helping translators, developers and
1424 coordinators work efficiently.
1427 * Maintaining without updating translations::
1428 * Managing documentation translation with Git::
1431 @node Maintaining without updating translations
1432 @unnumberedsubsubsec Maintaining without updating translations
1434 Keeping translations up to date under heavy changes in the
1435 documentation in English may be almost impossible, especially as
1436 during the former Grand Documentation Project (GDP) or the Grand
1437 Organization Project (GOP) when a lot of contributors brings changes.
1438 In addition, transloators may be (and that) involved in these porjects too.
1440 it is possible -- and even recommended -- to
1441 perform some maintaining that keeps translated documentation usable
1442 and eases future translation updating. The rationale below the tasks
1443 list motivates this plan. The rationale below the tasks
1444 list motivates this plan.
1446 The following tasks are listed in decreasing priority order.
1449 @item Update macros.itexi.
1450 For each obsolete macro definition, if it is possible to update macro
1451 usage in documentation with an automatic text or regexp substitution,
1452 do it and delete the macro definition from macros.itexi; otherwise,
1453 mark this macro definition as obsolete with a comment, and keep it in
1454 macros.itexi until the documentation translation has been updated and
1455 no longer uses this macro.
1457 @item Update @file{*.tely} files completely with
1458 @command{make check-translation} -- you may want to redirect ouptput
1459 to a file because of overwhelming output, or call check-translation.py
1460 on individual files, see @ref{Check state of translation}.
1462 @item In @file{.itelys}, match sections and .itely file names with those from
1463 English docs, which possibly involves moving nodes contents in block
1464 between files, without updating contents itself. In other words, the
1465 game is catching where has gone each section. In Learning manual, and
1466 in Notation Reference sections which have been revised in GDP, there
1467 may be completely new sections: in this case, copy @code{@@node} and
1468 @code{@@section}-command from English docs, and add the marker for
1469 untranslated status @code{@@untranslated} on a single line. Note that
1470 it is not possible to exactly match subsections or subsubsections of
1471 documentation in English, when contents has been deeply revised; in
1472 this case, keep obsolete (sub)subsections in the translation, marking
1473 them with a line @code{@@c obsolete} just before the node.
1475 Emacs with Texinfo mode makes this step easier:
1478 @item without Emacs AucTeX installed, @key{C-c C-s} shows structure of current
1479 Texinfo file in a new buffer *Occur*; to show structure of two files
1480 simultaneously, first split Emacs window in 4 tiles (with @key{C-x 1}
1481 and @key{C-x 2}), press @key{C-c C-s} to show structure of one file
1482 (e.g. the translated file), copy *Occur* contents into *Scratch*, then
1483 press @key{C-c C-s} for the other file.
1485 If you happen to have installed AucTeX, you can either call the macro
1486 by doing @key{M-x texinfo-show-structure} or create a key binding in your
1487 @file{~/.emacs}, by adding the four following lines:
1490 (add-hook 'Texinfo-mode-hook
1492 (define-key Texinfo-mode-map "\C-cs"
1493 'texinfo-show-structure)))
1497 and then obtain the structure in the *Occur* buffer with @key{C-c s}.
1499 @item Do not bother updating @code{@@menu}s when all menu entries are in the same
1500 file, just do @key{C-c C-u C-a} ("update all menus") when you have
1501 updated all the rest of the file.
1503 @item Moving to next or previous node using incremental search: press
1504 @key{C-s} and type @code{node} (or @key{C-s @@node} if the text
1505 contains the word @q{node}) then press @key{C-s} to move to next node
1506 or @key{C-r} to move to previous node. Similar operation can be used
1507 to move to the next/previous section. Note that every cursor move
1508 exits incremental search, and hitting @key{C-s} twice starts
1509 incremental search with the text entered in previous incremental
1512 @item Moving a whole node (or even a sequence of nodes): jump to beginning
1513 of the node (quit incremental search by pressing an arrow), press
1514 @key{C-SPACE}, press @key{C-s node} and repeat @key{C-s} until you
1515 have selected enough text, cut it with @key{C-w} or @key{C-x}, jump to
1516 the right place (moving between nodes with the previous hint is often
1517 useful) and paste with @key{C-y} or @key{C-v}.
1520 @item Update sections finished in the English documentation; check
1522 @uref{http://lilypondwiki.tuxfamily.org/index.php?title=Documentation_coordination}.
1524 @item Update documentation PO. It is recommended not to update
1525 strings which come from documentation that is currently deeply revised
1526 in English, to avoid doing the work more than once.
1528 @item Fix broken cross-references by running (from @file{Documentation/})
1531 make ISOLANG=@var{YOUR-LANGUAGE} fix-xrefs
1535 This step requires a sucessful documentation build (with @command{make
1536 doc}). Some cross-references are broken because they point to a node
1537 that exists in the documentation in English, which has not been added
1538 to the translation; in this case, do not fix the cross-reference but
1539 keep it "broken", so that the resulting HTML link will point to an
1540 existing page of documentation in English.
1543 @subsubheading Rationale
1545 You may wonder if it would not be better to leave translations as-is
1546 until you can really start updating translations. There are several
1547 reasons to do these maintenance tasks right now.
1550 @item This will have to be done sooner or later anyway, before updating
1551 translation of documentation contents, and this can already be done
1552 without needing to be redone later, as sections of documentation in
1553 English are mostly revised once. However, note that not all
1554 documentation sectioning has been revised in one go, so all this
1555 maintenance plan has to be repeated whenever a big reorganization is
1558 @item This just makes translated documentation take advantage of the new
1559 organization, which is better than the old one.
1561 @item Moving and renaming sections to match sectioning of documentation in
1562 English simplify future updating work: it allows updating the
1563 translation by side-by-side comparison, without bothering whether
1564 cross-reference names already exist in the translation.
1566 @item Each maintenance task except @q{Updating PO files} can be done by
1567 the same person for all languages, which saves overall time spent by
1568 translators to achieve this task: the node names and section titles
1569 are in English, so you can do. It is important to take advantage of
1570 this now, as it will be more complicated (but still possible) to do
1571 step 3 in all languages when documentation is compiled with
1572 @command{texi2html} and node names are directly translated in source
1577 @node Managing documentation translation with Git
1578 @unnumberedsubsubsec Managing documentation translation with Git
1580 This policy explains how to manage Git branches and commit
1581 translations to Git.
1584 @item Translation changes matching master branch are preferably made on
1585 @code{lilypond/translation} branch; they may be pushed directly to
1586 @code{master} only if they do not break compilation of LilyPond and
1587 its documentation, and in this case they should be pushed to
1588 @code{lilypond/translation} too. Similarly, changes matching
1589 @code{stable/X.Y} are preferably made on
1590 @code{lilypond/X.Ytranslation}.
1592 @item @code{lilypond/translation} Git branch may be merged into
1593 master only if LilyPond (@command{make all}) and documentation
1594 (@command{make doc}) compile succesfully.
1596 @item @code{master} Git branch may be merged into
1597 @code{lilypond/translation} whenever @command{make} and @command{make
1598 doc} are succesful (in order to ease documentation compilation by
1599 translators), or when significant changes had been made in
1600 documentation in English in master branch.
1602 @item General maintenance may be done by anybody who knows what he does
1603 in documentation in all languages, without informing translators
1604 first. General maintenance include simple text substitutions
1605 (e.g. automated by sed), compilation fixes, updating Texinfo or
1606 lilypond-book commands, updating macros, updating ly code, fixing
1607 cross-references, and operations described in @ref{Maintaining
1608 without updating translations}.
1612 @node Technical background
1613 @subsection Technical background
1615 A number of Python scripts handle a part of the documentation
1616 translation process. All scripts used to maintain the translations
1617 are located in @file{scripts/auxiliar/}.
1620 @item @file{check_translation.py} -- show diff to update a translation,
1621 @item @file{texi-langutils.py} -- quickly and dirtily parse Texinfo files to
1622 make message catalogs and Texinfo skeleton files,
1623 @item @file{texi-skeleton-update.py} -- update Texinfo skeleton files,
1624 @item @file{update-snippets.py} -- synchronize ly snippets with those
1626 @item @file{translations-status.py} -- update translations status pages and word
1627 counts in the file you are reading,
1628 @item @file{tely-gettext.py} -- gettext node names, section titles and references
1629 in the sources; WARNING only use this script once for each file, when support for
1630 "makeinfo --html" has been dropped.
1633 Other scripts are used in the build process, in @file{scripts/build/}:
1636 @item @file{html-gettext.py} -- translate node names, section titles and cross
1637 references in HTML files generated by @command{makeinfo},
1638 @item @file{texi-gettext.py} -- gettext node names, section titles and references
1639 before calling @command{texi2pdf},
1640 @item @file{mass-link.py} -- link or symlink files between English documentation
1641 and documentation in other languages.
1644 Python modules used by scripts in @file{scripts/auxiliar/} or @file{scripts/build/} (but
1645 not by installed Python scripts) are located in @file{python/auxiliar/}:
1647 @item @file{manuals_definitions.py} -- define manual names and name of
1648 cross-reference Texinfo macros,
1649 @item @file{buildlib.py} -- common functions (read piped output
1650 of a shell command, use Git),
1651 @item @file{postprocess_html.py} (module imported by @file{www_post.py}) -- add footer and
1652 tweak links in HTML pages.
1657 @item @file{python/langdefs.py} -- language definitions module