[ << Documentation work ][Top][Contents][ Website work >> ]
[ < Starting translation in a new language ][ Up : Translating the documentation ][]

5.9.2 Documentation translation details

Please follow all the instructions with care to ensure quality work.

All files should be encoded in UTF-8.

Files to be translated  
Translating the Web site and other Texinfo documentation  
Adding a Texinfo manual  
[ << Documentation work ][Top][Contents][ Website work >> ]
[ < Documentation translation details ][ Up : Documentation translation details ][]

Files to be translated

Translation of ‘Documentation/en/foo/bar’ should be ‘Documentation/LANG/foo/bar’. Unmentioned files should not be translated.

Files of priority 1 should be submitted along all files generated by starting a new language in the same commit and thus a unique patch, and the translation of files marked with priority 2 should be committed to Git at the same time and thus sent in a single patch. Priority 1 files are required before requesting a language-specific mailing list lilypond-xyz@gnu.org. Files marked with priority 3 or more may be submitted individually. For knowing how to commit your work to Git, then make patches of your new translations as well as corrections and updates, see Working with source code.

  1. the website: ‘web.texi’, ‘web/introduction.itexi’, and ‘web/download.itexi’. Additionally, also translate ‘macros.itexi’, ‘po/lilypond-doc.pot’, and ‘search-box.ihtml’.
  2. the tutorial: ‘web/manuals.itexi’, ‘learning.tely’, ‘learning/installing.itely’, ‘learning/tutorial.itely’, and ‘learning/common-notation.itely’
  3. fundamental concepts in ‘learning/fundamental.itely’, as well as ‘usage.tely’, ‘usage/running.itely’, ‘usage/updating.itely’, and ‘web/community.itexi’
  4. ‘learning/tweaks.itely’, ‘learning/templates.itely’, and ‘usage/suggestions.itely’
  5. the Notation reference: ‘notation.tely’, all of ‘notation/*.itely’, and the Snippets’ titles and descriptions
  6. ‘usage/lilypond-book.itely’ and ‘usage/external.itely’
  7. the appendices, whose translation is optional: ‘essay.tely’ and ‘essay/*.itely’, as well as ‘extending.tely’ and ‘extending/*.itely’
[ << Documentation work ][Top][Contents][ Website work >> ]
[ < Files to be translated ][ Up : Documentation translation details ][]

Translating the Web site and other Texinfo documentation

Every piece of text should be translated in the source file, except Texinfo comments, text in @lilypond blocks and a few cases mentioned below.

Node names are translated, but the original node name in English should be kept as the argument of @translationof put after the section title; that is, every piece in the original file like 

@node Foo bar
@section_command Bar baz

should be translated as 

@node translation of Foo bar
@section_command translation of Bar baz
@translationof Foo bar

The argument of @rglos commands and the first argument of @rglosnamed commands must not be translated, as it is the node name of an entry in Music Glossary.

Every time you translate a node name in a cross-reference, i.e., the argument of commands @ref, @rprogram, @rlearning, @rlsr, @ruser or the first argument of their *named variants, you should make sure the target node is defined in the correct source file; if you do not intend to translate the target node right now, you should at least write the node definition (that is, the @node @section_commmand @translationof trio mentioned above) in the expected source file and define all its parent nodes; for each node you have defined this way but have not translated, insert a line that contains @untranslated. That is, you should end up for each untranslated node with something like 

@node translation of Foo bar
@section_command translation of Bar baz
@translationof Foo bar

@untranslated

Note: you do not have to translate the node name of a cross-reference to a node that you do not have translated. If you do, you must define an “empty” node like explained just above; this will produce a cross-reference with the translated node name in output, although the target node will still be in English. On the opposite, if all cross-references that refer to an untranslated node use the node name in English, then you do not have to define such an “empty” node, and the cross-reference text will appear in English in the output. The choice between these two strategies implies its particular maintenance requirements and is left to the translators, although the opinion of the Translation meister leans towards not translating these cross-references.

Please think of the fact that it may not make sense translating everything in some Texinfo files, and you may take distance from the original text; for instance, in the translation of the web site section Community, you may take this into account depending on what you know the community in your language is willing to support, which is possible only if you personally assume this support, or there exists a public forum or mailing list listed in Community for LilyPond in your language:

In any case, please mark in your work the sections which do not result from the direct translation of a piece of English translation, using comments i.e., lines starting with ‘@c’.

Finally, press in Emacs <C-c C-u C-a> to update or generate menus. This process should be made easier in the future, when the helper script texi-langutils.py and the makefile target are updated.

Some pieces of text manipulated by build scripts that appear in the output are translated in a ‘.po’ file – just like LilyPond output messages – in ‘Documentation/po’. The Gettext domain is named lilypond-doc, and unlike lilypond domain it is not managed through the Free Translation Project.

Take care of using typographic rules for your language, especially in ‘macros.itexi’.

If you wonder whether a word, phrase or larger piece of text should be translated, whether it is an argument of a Texinfo command or a small piece sandwiched between two Texinfo commands, try to track whether and where it appears in PDF and/or HTML output as visible text. This piece of advice is especially useful for translating ‘macros.itexi’.

Please keep verbatim copies of music snippets (in @lilypond blocks). However, some music snippets containing text that shows in the rendered music, and sometimes translating this text really helps the user to understand the documentation; in this case, and only in this case, you may as an exception translate text in the music snippet, and then you must add a line immediately before the @lilypond block, starting with 

@c KEEP LY

Otherwise the music snippet would be reset to the same content as the English version at next make snippet-update run – see Updating documentation translation.

When you encounter 

@lilypondfile[<number of fragment options>,texidoc]{filename.ly}

in the source, open ‘Documentation/snippets/filename.ly’, translate the texidoc header field it contains, enclose it with texidocMY-LANGUAGE = " and ", and write it into ‘Documentation/MY-LANGUAGE/texidocs/filename.texidoc’. Additionally, you may translate the snippet’s title in doctitle header field, in case doctitle is a fragment option used in @lilypondfile; you can do this exactly the same way as texidoc. For instance, ‘Documentation/MY-LANGUAGE/texidocs/filename.texidoc’ may contain 

doctitlees = "Spanish title baz"
texidoces = "
Spanish translation blah
"

@example blocks need not be verbatim copies, e.g., variable names, file names and comments should be translated.

Finally, please carefully apply every rule exposed in Texinfo introduction and usage policy, and Documentation policy. If one of these rules conflicts with a rule specific to your language, please ask the Translation meister and/or the Documentation Editors on lilypond-devel@gnu.org list.

[ << Documentation work ][Top][Contents][ Website work >> ]
[ < Translating the Web site and other Texinfo documentation ][ Up : Documentation translation details ][]

Adding a Texinfo manual

In order to start translating a new manual, simply copy the English files within your language directory and translate them.

For example, if you want to translate the first chapter of the Learning Manual: 

cp Documentation/en/learning.tely Documentation/LANG/learning.tely
cp Documentation/en/learning/tutorial.itely Documentation/LANG/tutorial.itely
[ << Documentation work ][Top][Contents][ Website work >> ]
[ < Translating the Web site and other Texinfo documentation ][ Up : Documentation translation details ][]

<< Back to Documentation Index

LilyPond — Contributor’s Guide v2.24.4 (stable-branch).