Rename aux 'directories' to 'auxiliar' for Windows compatibility

[lilypond.git] / Documentation / TRANSLATION

diff --git a/Documentation/TRANSLATION b/Documentation/TRANSLATION
index 54c2444ef2ff68510469f85c0c626d98dbab3d92..82798c5d45106c3436d46e8ef32b3522d0995dfa 100644 (file)
--- a/Documentation/TRANSLATION
+++ b/Documentation/TRANSLATION
@@ -47,6 +47,10 @@ The reader is supposed to be familiar with Git, for example by
 having experience from lilypond.org translation; see
 http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=web/master
 
 having experience from lilypond.org translation; see
 http://git.sv.gnu.org/gitweb/?p=lilypond.git;a=blob_plain;f=README;hb=web/master
 

+If you do not have this experience, you may want to read the first two
+chapters of Git User's Manual at
+http://www.kernel.org/pub/software/scm/git/docs/user-manual.html
+

 
 REQUIREMENTS
 
 
 REQUIREMENTS
 


@@ -89,7 +93,7 @@ Cd into Documentation and run:
 where <MY-LANGUAGE> is the ISO 639 language code.
 
 Add a language definition for your language in
 where <MY-LANGUAGE> is the ISO 639 language code.
 
 Add a language definition for your language in

-buildscripts/langdefs.py.
+python/langdefs.py.

 
 See next section about what files to translate and the following
 detailed instructions after the next section.
 
 See next section about what files to translate and the following
 detailed instructions after the next section.


@@ -111,63 +115,64 @@ 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
 Word counts (excluding lilypond snippets) are given for each file.
 
 -1- Documentation index and Tutorial

-415   user/lilypond-learning.tely
+429   user/lilypond-learning.tely

 6365  user/tutorial.itely
 23    user/dedication.itely
 6365  user/tutorial.itely
 23    user/dedication.itely

-409   user/macros.itexi
+423   user/macros.itexi

 171   index.html.in
 171   index.html.in

-3748  po/lilypond-doc.pot (translate to po/<MY_LANGUAGE>.po)
-11131 total
+6346  po/lilypond-doc.pot (translate to po/<MY_LANGUAGE>.po)
+---   ../lilypond-texi2html.init (section TRANSLATIONS)
+13757 total

 
 -2- Introduction and beginning of Application Usage
 411   user/preface.itely
 3855  user/introduction.itely
 
 -2- Introduction and beginning of Application Usage
 411   user/preface.itely
 3855  user/introduction.itely

-393   user/lilypond-program.tely
-1867  user/install.itely (partial translation)
+407   user/lilypond-program.tely
+1928  user/install.itely (partial translation)

 1149  user/setup.itely
 1149  user/setup.itely

-2896  user/running.itely
-10571 total
+2827  user/running.itely
+10577 total

 
 -3- Learning manual
 10318 user/fundamental.itely -- Fundamental concepts
 
 -3- Learning manual
 10318 user/fundamental.itely -- Fundamental concepts

-12353 user/tweaks.itely -- Tweaking output
-3005  user/working.itely -- Working on LilyPond files
+14775 user/tweaks.itely -- Tweaking output
+3007  user/working.itely -- Working on LilyPond files

 483   user/templates.itely -- Templates
 483   user/templates.itely -- Templates

-26159 total
+28583 total

 
 -4- Notation reference
 
 -4- Notation reference

-680   user/lilypond.tely
+695   user/lilypond.tely

 91    user/notation.itely -- Musical notation
 91    user/notation.itely -- Musical notation

-3147  user/pitches.itely
-6312  user/rhythms.itely
-1110  user/expressive.itely
-556   user/repeats.itely
-1452  user/simultaneous.itely
-1690  user/staff.itely
-902   user/editorial.itely
-2410  user/text.itely
+3123  user/pitches.itely
+5236  user/rhythms.itely
+1146  user/expressive.itely
+555   user/repeats.itely
+1455  user/simultaneous.itely
+1701  user/staff.itely
+895   user/editorial.itely
+2286  user/text.itely

 76    user/specialist.itely -- Specialist notation
 76    user/specialist.itely -- Specialist notation

-2679  user/vocal.itely
-1326  user/chords.itely
+2670  user/vocal.itely
+1464  user/chords.itely

 702   user/piano.itely
 810   user/percussion.itely
 826   user/guitar.itely
 66    user/strings.itely
 242   user/bagpipes.itely
 702   user/piano.itely
 810   user/percussion.itely
 826   user/guitar.itely
 66    user/strings.itely
 242   user/bagpipes.itely

-4240  user/ancient.itely
-5661  user/input.itely -- Input syntax
+4487  user/ancient.itely
+5873  user/input.itely -- Input syntax

 2164  user/non-music.itely -- Non-musical notation
 2164  user/non-music.itely -- Non-musical notation

-8297  user/spacing.itely -- Spacing issues
-11197 user/changing-defaults.itely -- Changing defaults
-5206  user/programming-interface.itely -- Interfaces for programmers
-1155  user/notation-appendices.itely -- Notation manual tables
+8451  user/spacing.itely -- Spacing issues
+11391 user/changing-defaults.itely -- Changing defaults
+5202  user/programming-interface.itely -- Interfaces for programmers
+1190  user/notation-appendices.itely -- Notation manual tables

 250   user/cheatsheet.itely -- Cheat sheet
 250   user/cheatsheet.itely -- Cheat sheet

-63247 total
+63047 total

 
 -5- Application usage
 
 -5- Application usage

-3194  user/lilypond-book.itely -- LilyPond-book
+3248  user/lilypond-book.itely -- LilyPond-book

 1171  user/converters.itely -- Converting from other formats
 1171  user/converters.itely -- Converting from other formats

-4365  total
+4419  total

 
 -6- Appendices whose translation is optional
 310   user/literature.itely
 
 -6- Appendices whose translation is optional
 310   user/literature.itely


@@ -361,7 +366,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
 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):
 
 Finally, a command runs the three update processes above for all
 enabled languages (from Documentation):


@@ -661,25 +670,38 @@ which works regardless of the branch checked out.
 TECHNICAL BACKGROUND
 
 A number of Python scripts handle a part of the documentation
 TECHNICAL BACKGROUND
 
 A number of Python scripts handle a part of the documentation

-translation process.  All are located in buildscripts/, except
-langdefs.py which is in python/
+translation process.
+All scripts used to maintain the translations
+are located in scripts/auxiliar/:

 
 

-* buildlib.py -- module containing common functions (read piped output
-of a shell command, use Git)
-* langdefs.py  -- language definitions module

 * check_translation.py  -- show diff to update a translation
 * texi-langutils.py  -- quickly and dirtily parse Texinfo files to
 make message catalogs and Texinfo skeleton files
 * texi-skeleton-update.py -- update Texinfo skeleton files
 * check_translation.py  -- show diff to update a translation
 * texi-langutils.py  -- quickly and dirtily parse Texinfo files to
 make message catalogs and Texinfo skeleton files
 * texi-skeleton-update.py -- update Texinfo skeleton files

+* 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.
+* tely-gettext.py -- gettext node names, section titles and references
+in the sources; WARNING only use this script when support for
+"makeinfo --html" has been dropped.
+
+Other scripts are used in the build process, in scripts/build/:

 * html-gettext.py -- translate node names, section titles and cross
 references in HTML files generated by makeinfo
 * html-gettext.py -- translate node names, section titles and cross
 references in HTML files generated by makeinfo

-* add_html_footer.py (module imported by www_post.py) -- add footer and
-tweak links in HTML pages

 * texi-gettext.py -- gettext node names, section titles and references
 before calling texi2pdf
 * mass-link.py -- link or symlink files between English documentation
 and documentation in other languages
 * texi-gettext.py -- gettext node names, section titles and references
 before calling texi2pdf
 * mass-link.py -- link or symlink files between English documentation
 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.
+
+Python modules used by scripts in scripts/auxiliar/ or scripts/build/ (but
+not by installed Python scripts) are located in python/auxiliar/:
+* manuals_definitions.py -- define manual names and name of
+cross-reference Texinfo macros
+* buildlib.py -- common functions (read piped output
+of a shell command, use Git)
+* postprocess_html.py (module imported by www_post.py) -- add footer and
+tweak links in HTML pages
+
+And finally
+* python/langdefs.py  -- language definitions module