]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/TRANSLATION
Revert "DOC -- Index editorial, pitches, staff. Ralph Palmer's work"
[lilypond.git] / Documentation / TRANSLATION
index 0954bda7f668d6a24af60a9c73d43eef9dd2c978..107c361ac144f24ca8c6c293a79ebafdd7d32a3e 100644 (file)
@@ -111,68 +111,69 @@ 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 and Tutorial
-396   user/lilypond-learning.tely
-5593  user/tutorial.itely
+429   user/lilypond-learning.tely
+6365  user/tutorial.itely
 23    user/dedication.itely
-100   user/macros.itexi
-216   index.html.in
-2022  po/lilypond-doc.pot (translate to po/<MY_LANGUAGE>.po)
-8250  total
+423   user/macros.itexi
+171   index.html.in
+6420  po/lilypond-doc.pot (translate to po/<MY_LANGUAGE>.po)
+---   ../lilypond-texi2html.init (section TRANSLATIONS)
+13831 total
 
 -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
+3855  user/introduction.itely
+407   user/lilypond-program.tely
+1930  user/install.itely (partial translation)
+1149  user/setup.itely
+2827  user/running.itely
+10579 total
 
 -3- Learning manual
-8626  user/fundamental.itely -- Fundamental concepts
-12134 user/tweaks.itely -- Tweaking output
-2985  user/working.itely -- Working on LilyPond files
+10318 user/fundamental.itely -- Fundamental concepts
+14581 user/tweaks.itely -- Tweaking output
+3007  user/working.itely -- Working on LilyPond files
 483   user/templates.itely -- Templates
-24228 total
+28389 total
 
 -4- Notation reference
-539   user/lilypond.tely
+695   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
+3086  user/pitches.itely
+5013  user/rhythms.itely
+1146  user/expressive.itely
+555   user/repeats.itely
+1455  user/simultaneous.itely
+1635  user/staff.itely
+906   user/editorial.itely
+2286  user/text.itely
+76    user/specialist.itely -- Specialist notation
+2670  user/vocal.itely
+1333  user/chords.itely
 702   user/piano.itely
-481   user/percussion.itely
+810   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
+4486  user/ancient.itely
+5805  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
+8444  user/spacing.itely -- Spacing issues
+11291 user/changing-defaults.itely -- Changing defaults
+5202  user/programming-interface.itely -- Interfaces for programmers
+1155  user/notation-appendices.itely -- Notation manual tables
 250   user/cheatsheet.itely -- Cheat sheet
-53639 total
+62390 total
 
 -5- Application usage
-2917  user/lilypond-book.itely -- LilyPond-book
-975   user/converters.itely -- Converting from other formats
-3892  total
+3185  user/lilypond-book.itely -- LilyPond-book
+1171  user/converters.itely -- Converting from other formats
+4356  total
 
 -6- Appendices whose translation is optional
-299   user/literature.itely
+310   user/literature.itely
 960   user/scheme-tutorial.itely (needs to be revised first)
-1259  total
+1270  total
 
 
 TRANSLATION DETAILED INSTRUCTIONS
@@ -228,7 +229,7 @@ beginning with
 
 @c KEEP LY
 
-Otherwise the music snippet would be reset to the same contents as the
+Otherwise the music snippet would be reset to the same content as the
 English version at next 'make snippet-update' run (see UPDATING A
 TRANSLATION below).
 
@@ -299,6 +300,11 @@ Small tip: to see only which files need to be updated, do
 
     make ISOLANG=<MY_LANGUAGE> check-translation | grep 'diff --git'
 
+To avoid printing terminal colors control characters, which is often
+desirable when you redirect output to a file, run
+
+    make ISOLANG=<MY_LANGUAGE> NO_COLOR=1 check-translation
+
 
 Global state of the translation is recorded in
 Documentation/translations.html.in, which is used to generate
@@ -348,7 +354,7 @@ Translation meister runs this command.
 
 Updating music snippets can quickly become cumbersome, as most
 snippets should be identical in all languages.  Fortunately, there is
-a script than can do this odd job for you (run from Documentation):
+a script that can do this odd job for you (run from Documentation):
 
     make ISOLANG=<MY_LANGUAGE> snippet-update
 
@@ -356,7 +362,11 @@ This script overwrites music snippets in <MY_LANGUAGE>/user/every.itely
 with music snippets from user/every.itely.  It ignores skeleton files,
 and keeps intact music snippets preceded with a line starting with '@c
 KEEP LY'; it reports an error for each .itely that has not the same
-music snippet count in both languages.
+music snippet count in both languages.  Always use this script with a
+lot of care, i.e. run it on a clean Git working tree, and check the
+changes it made with "git diff" before committing; if you don't do so,
+some @lilypond snippets might be broken or make no sense in their
+context.
 
 Finally, a command runs the three update processes above for all
 enabled languages (from Documentation):
@@ -397,21 +407,35 @@ between files, without updating contents itself.  In other words, the
 game is catching where has gone each section.  In Learning manual, and
 in Notation Reference sections which have been revised in GDP, there
 may be completely new sections: in this case, copy @node and
-@section-command from English docs, and put the usual tricky line
-'UNTRANSLATED NODE: IGNORE ME'.  Note that it is not possible to
-exactly match subsections or subsubsections of documentation in
-English, when contents has been deeply revised; in this case, kee
-obsolete (sub)subsections in the translation.
+@section-command from English docs, and add the marker for
+untranslated status '@untranslated' on a single line.  Note that it is
+not possible to exactly match subsections or subsubsections of
+documentation in English, when contents has been deeply revised; in
+this case, keep obsolete (sub)subsections in the translation, marking
+them with a line '@c obsolete' just before the node.
+
+4) update sections finished in GDP; check sections status at GDP website.
 
-* Hints for Emacs users (without Emacs AucTeX installed)
+
+* Hints for Emacs users
 
 Emacs with Texinfo mode makes this step easier:
 
-- C-c C-s shows structure of current Texinfo file in a new buffer
-*Occur*; to show structure of two files simultaneously, first split
-Emacs window in 4 tiles (with C-x 1 and C-x 2), press C-c C-s to
-show structure of one file (e.g. the translated file), copy *Occur*
-contents into *Scratch*, then press C-c C-s for the other file.
+- without Emacs AucTeX installed, C-c C-s shows structure of current
+Texinfo file in a new buffer *Occur*; to show structure of two files 
+simultaneously, first split Emacs window in 4 tiles (with C-x 1 and 
+C-x 2), press C-c C-s to show structure of one file (e.g. the translated
+file), copy *Occur* contents into *Scratch*, then press C-c C-s for the 
+other file.
+If you happen to have installed AucTeX, you can either call the macro
+by doing M-x texinfo-show-structure or create a key binding in your
+~/.emacs, by adding the four following lines:
+       (add-hook 'Texinfo-mode-hook
+                 '(lambda ()
+                    (define-key Texinfo-mode-map "\C-cs"
+                     'texinfo-show-structure)))
+and then obtain the structure in the *Occur* buffer with C-c s
+
 
 - Do not bother updating @menus when all menu entries are in the same
 file ; make sure there is at least a (possibly empty) @menu block
@@ -460,7 +484,7 @@ English are mostly revised once.  However, note that not all
 documentation sectioning has been revised in one go, so all this
 maintenance plan has to be repeated whenever a big reorganization is
 made. Currently (in May 2008), only chapters 3-7 in Notation Reference
-and Application Usage have not be reorganized yet.
+and Application Usage have not been reorganized yet.
 
 - This just makes translated documentation take advantage of the new
 organization, which is far better than the old one.
@@ -559,7 +583,7 @@ branch BRANCH.
 Note that it is possible to check out another branch while having
 uncommitted changes, but it is not recommended unless you know what
 you are doing; it is recommended to run 'git status' to check this
-kind of issue before checking ouy another branch.
+kind of issue before checking out another branch.
 
 When pulling using SHORTHAND, do not forget to check first that the
 right branch is checked out, i.e. the branch named A in the first part