Merge branch 'master' of git://git.sv.gnu.org/lilypond

[lilypond.git] / Documentation / TRANSLATION

diff --git a/Documentation/TRANSLATION b/Documentation/TRANSLATION
index cc999b6dd0de72c753cf5cd042c79c5003908c53..cc3487d8b19f2fa9b3905603d4c382d7b8a111ac 100644 (file)
--- a/Documentation/TRANSLATION
+++ b/Documentation/TRANSLATION
@@ -74,95 +74,79 @@ Translation of Documentation/foo/bar should be
 Documentation/<LANG>/foo/bar.
 Unmentioned files should not be translated.
 
 Documentation/<LANG>/foo/bar.
 Unmentioned files should not be translated.
 

-Priorities:  1. delivery, 2. 3. 4. 5. later, 6. optional.
+Priorities:
+  1. delivery
+  2. 3. 4. 5. later
+  6. optional

 
 Files marked with priority 3, 4 or 5 may be submitted individually.
 
 Files marked with priority 3, 4 or 5 may be submitted individually.

+Word counts (excluding lilypond snippets) are given for each file.

 
 

--1- Documentation index, Tutorial and Cheat Sheet
-1 user/lilypond.tely
-1 user/tutorial.itely
-1 user/dedication.itely
-1 user/cheatsheet.itely
-1 index.html.in
-  po/<MY-LANGUAGE>.po
+-1- Documentation index and Tutorial
+396   user/lilypond-learning.tely
+5593  user/tutorial.itely
+23    user/dedication.itely
+216   index.html.in
+2022  po/lilypond-doc.pot (translate to po/<MY_LANGUAGE>.po)
+8250  total

 
 In addition, user/macros.itexi may be translated in case typographic
 rules used in this file are different in your language.
 
 
 In addition, user/macros.itexi may be translated in case typographic
 rules used in this file are different in your language.
 

--2- User manual introduction
-2 user/preface.itely
-2 user/introduction.itely
+-2- Introduction and beginning of Application Usage
+411   user/preface.itely
+3198  user/introduction.itely
+374   user/lilypond-program.tely
+1477  user/install.itely (partial translation)
+947   user/setup.itely
+2860  user/running.itely
+9267  total

 
 -3- Learning manual
 
 -3- Learning manual

-3 user/putting.itely -- Putting it all together
-3 user/working.itely -- Working on LilyPond files
-3 user/tweaks.itely -- Tweaking output
+8626  user/fundamental.itely -- Fundamental concepts
+12134 user/tweaks.itely -- Tweaking output
+2985  user/working.itely -- Working on LilyPond files
+483   user/templates.itely -- Templates
+24228 total

 
 -4- Notation reference
 
 -4- Notation reference

-4 user/basic-notation.itely -- Basic notation
-4 user/instrument-notation.itely -- Instrument-specific notation
-4 user/advanced-notation.itely -- Advanced notation
-4 user/changing-defaults.itely -- Changing defaults
-4 user/non-music.itely -- Non-musical notation
-4 user/spacing.itely -- Spacing issues
-4 user/programming-interface.itely -- Interfaces for programmers
-4 user/scheme-tutorial.itely -- Scheme tutorial
-
--5- Program usage
-5 user/lilypond-program.tely
-5 user/install.itely -- How to install or compile
-5 user/running.itely -- Running LilyPond
-5 user/lilypond-book.itely -- LilyPond-book
-5 user/converters.itely -- Converting from other formats
+539   user/lilypond.tely
+91    user/notation.itely -- Musical notation
+2808  user/pitches.itely
+7336  user/rhythms.itely
+1681  user/expressive.itely
+725   user/repeats.itely
+916   user/simultaneous.itely
+1861  user/staff.itely
+879   user/editorial.itely
+2336  user/text.itely
+54    user/specialist.itely -- Specialist notation
+2630  user/vocal.itely
+1275  user/chords.itely
+702   user/piano.itely
+481   user/percussion.itely
+826   user/guitar.itely
+66    user/strings.itely
+242   user/bagpipes.itely
+4289  user/ancient.itely
+2458  user/input.itely -- Input syntax
+2164  user/non-music.itely -- Non-musical notation
+8399  user/spacing.itely -- Spacing issues
+5149  user/changing-defaults.itely -- Changing defaults
+4547  user/programming-interface.itely -- Interfaces for programmers
+935   user/notation-appendices.itely -- Notation manual tables
+250   user/cheatsheet.itely -- Cheat sheet
+53639 total
+
+-5- Application usage
+2917  user/lilypond-book.itely -- LilyPond-book
+975   user/converters.itely -- Converting from other formats
+3892  total

 
 -6- Appendices whose translation is optional
 
 -6- Appendices whose translation is optional

-6 user/literature.itely
-6 user/templates.itely
-6 user/notation-appendices.itely
-
-* WORD COUNTS FOR CATEGORIES
-
-LANG=C wc --words $(grep ^1 TRANSLATION | cut -d ' ' -f 2)
-  777 user/lilypond.tely
- 6322 user/tutorial.itely
-   63 user/dedication.itely
-  632 user/cheatsheet.itely
-  361 index.html.in
- 8155 total
-
-LANG=C wc --words $(grep ^2 TRANSLATION | cut -d ' ' -f 2)
-  451 user/preface.itely
- 4170 user/introduction.itely
- 4621 total
-
-LANG=C wc --words $(grep ^3 TRANSLATION | cut -d ' ' -f 2)
- 2230 user/putting.itely
- 3232 user/working.itely
- 2327 user/tweaks.itely
- 7789 total
-
-LANG=C wc --words $(grep ^4 TRANSLATION | cut -d ' ' -f 2)
- 12391 user/basic-notation.itely
- 15779 user/instrument-notation.itely
-  9530 user/advanced-notation.itely
-  7386 user/changing-defaults.itely
-  3884 user/non-music.itely
-  8318 user/spacing.itely
-  4781 user/programming-interface.itely
-   915 user/scheme-tutorial.itely
- 62984 total
-
-LANG=C wc --words $(grep ^5 TRANSLATION | cut -d ' ' -f 2)
- 3566 user/running.itely
- 3549 user/lilypond-book.itely
- 1062 user/converters.itely
- 8177 total
-
-LANG=C wc --words $(grep ^6 TRANSLATION | cut -d ' ' -f 2)
-  339 user/literature.itely
- 4648 user/templates.itely
-  836 user/notation-appendices.itely
- 5823 total
+299   user/literature.itely
+960   user/scheme-tutorial.itely (needs to be revised first)
+1259  total

 
 
 TRANSLATION DETAILED INSTRUCTIONS
 
 
 TRANSLATION DETAILED INSTRUCTIONS


@@ -171,7 +155,7 @@ Please follow all these instructions with care to ensure quality work.
 
 All files should be encoded in UTF-8.
 
 
 All files should be encoded in UTF-8.
 

-* USER MANUAL
+* LEARNING MANUAL AND OTHER TEXINFO DOCUMENTATION

 
 Any title which comes with one of the following commands must not be
 translated directly in the Texinfo source
 
 Any title which comes with one of the following commands must not be
 translated directly in the Texinfo source


@@ -218,6 +202,22 @@ Otherwise the music snippet would be reset to the same contents as the
 English version at next 'make snippet-update' run (see UPDATING A
 TRANSLATION below).
 
 English version at next 'make snippet-update' run (see UPDATING A
 TRANSLATION below).
 

+When you encounter
+
+  @lilypondfile[<number of fragment options>,texidoc]{FILENAME.ly}
+
+in the source, open input/lsr/FILENAME.ly, translate the texidoc
+string it contains, enclose it with 'texidoc<MY-LANGUAGE> = "' and
+'"', and write it into input/texidocs/FILENAME.texidoc -- please keep
+possibly existing translations in other languages!  For instance,
+input/texidocs/FILENAME.texidoc may contain
+
+texidoces = "
+Spanish translation blah
+"
+texidocde = "German translation foo
+"
+

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


@@ -230,12 +230,13 @@ please ask the Translation meister and/or the Documentation Editor on
 lilypond-devel@gnu.org.
 
 
 lilypond-devel@gnu.org.
 
 

-* PROGRAM USAGE MANUAL
+* REFERENCE NOTATION AND PROGRAM USAGE MANUAL

 
 

-Copy user/lilypond-program.tely into <MY-LANGUAGE>/user, then
-translate this file and run skeleton-update (see UPDATE A TRANSLATION
-below).  Your are now ready to translate program usage manual exactly
-like the user manual.
+Copy user/lilypond.tely (or user/lilypond-program.tely, respectively)
+into <MY-LANGUAGE>/user, then translate this file and run
+skeleton-update (see UPDATE A TRANSLATION below).  Your are now ready
+to translate notation reference (program usage manual, respectively)
+exactly like the learning manual.

 
 
 * DOCUMENTATION INDEX index.html.in
 
 
 * DOCUMENTATION INDEX index.html.in


@@ -253,14 +254,45 @@ replace 'make' with 'make -C Documentation') and run
     make ISOLANG=<MY_LANGUAGE> check-translation
 
 This presents a diff of the original files since the most recent
     make ISOLANG=<MY_LANGUAGE> check-translation
 
 This presents a diff of the original files since the most recent

-revision of the translation.  To check a single file, run
+revision of the translation.  To check a single file, cd into
+Documentation and run
+
+    make CHECKED_FILES=<MY-LANGUAGE>/user/foo.itely check-translation
+
+
+Small tip: to see only which files need to be updated, do
+
+    make ISOLANG=<MY_LANGUAGE> check-translation | grep 'diff --git'

 
 

-    python buildscripts/check_translation.py Documentation/<MY-LANGUAGE>/user/foo.itely

 
 

+Global state of the translation is recorded in
+Documentation/translations.html.in, which is used to generate
+Translations status page.  To update that page, do from Documentation/
+
+    make translation-status
+
+This will also leave out/translations-status.txt, which contains
+up-to-dateness percentages for each translated file.

 
 
 UPDATE A TRANSLATION
 
 
 
 UPDATE A TRANSLATION
 

+Instead of running check-translation, you can run update-translation,
+which will run your favorite text editor to update files.  First, make
+sure environment variable EDITOR is set to a text editor command, then
+run from Documentation
+
+    make ISOLANG=<MY-LANGUAGE> update-translation
+
+or to update a single file
+
+    make CHECKED_FILES=<MY-LANGUAGE>/user/foo.itely update-translation
+
+For each file to be udpated, update-translation will open your text
+editor with this file and a diff of the file in English; if the diff
+cannot be generated or is bigger than the file in English itself, the
+full file in English will be opened instead.
+

 Texinfo skeleton files, i.e. .itely files not yet translated,
 containing only the Texinfo structure can be updated automatically:
 whenever 'make check-translation' shows that such files should be
 Texinfo skeleton files, i.e. .itely files not yet translated,
 containing only the Texinfo structure can be updated automatically:
 whenever 'make check-translation' shows that such files should be


@@ -318,3 +350,5 @@ before calling texi2pdf
 and documentation in other languages
 * update-snippets.py -- synchronize ly snippets with those from
 English docs
 and documentation in other languages
 * update-snippets.py -- synchronize ly snippets with those from
 English docs

+* translations-status.py -- update translations status pages and word
+counts in the file you are reading