Doc: rename translation branch.

[lilypond.git] / Documentation / contributor / doc-work.itexi

diff --git a/Documentation/contributor/doc-work.itexi b/Documentation/contributor/doc-work.itexi
index 5d90b8430fa9f4574401f64b462bc2429070cc55..dabb13beb4b581609003bce4fd6e6c7f0b60138f 100644 (file)
--- a/Documentation/contributor/doc-work.itexi
+++ b/Documentation/contributor/doc-work.itexi
@@ -255,6 +255,13 @@ but instead:
 @@subsection @@code@{Foo@} Bar
 @end example
 
+@item
+With the exception of @code{@@} commands, the section name must
+match the node name exactly.
+
+@item
+No commas may be used in the node names.
+
 @item
 If a heading is desired without creating a @code{@@node}, please use
 the following:
@@ -369,7 +376,7 @@ Inspirational headwords are produced with:
 LSR snippets are linked with:
 
 @example
-@@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
+@@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
 @{filename.ly@}
 @end example
 
@@ -496,8 +503,6 @@ easier/faster processing), use this header:
 \paper @{
   indent = 0\mm
   line-width = 160\mm - 2.0 * 0.4\in
-  ragged-right = ##t
-  force-assignment = #""
   line-width = #(- line-width (* mm  3.000000))
 @}
 
@@ -1411,24 +1416,7 @@ In order to save build time, a script is available to build only
 one section of the documentation in English with a default html
 appearance.
 
-The script is available as:
-
-@example
-scripts/auxiliar/doc-section.sh
-@end example
-
-This script will require customization for your site if your
-LilyPond git repository is anyplace but @code{$HOME/lilypond}.
-
-Assuming that no customization is required, you can setup the
-single section build with:
-
-@example
-mkdir $HOME/lilypond/tempdocs
-cp $HOME/lilypond/Documentation/out/version.itexi $HOME/lilypond/tempdocs
-@end example
-
-You can then build a section of the documentation with:
+You can build a section of the documentation with:
 
 @example
 scripts/auxiliar/doc-section.sh MANUAL SECTION
@@ -1444,6 +1432,25 @@ Notation Reference, use the command:
 scripts/auxiliar/doc-section.sh notation pitches
 @end example
 
+You can then see the generated document for the section at
+
+@example
+tempdocs/pitches/out/pitches.html
+@end example
+
+According to
+@uref{http://code.google.com/p/lilypond/issues/detail?id=1236,Lilypond issue 1236},
+the location of the lilypond git tree is taken from @code{$LILYPOND_GIT}
+if specified, otherwise it is auto-detected.
+
+It is assumed that compilation takes place in the @file{build/}
+subdirectory, but this can be overridden by setting the environment
+variable @code{LILYPOND_BUILD_DIR}.
+
+Similarly, output defaults to @file{build/tempdocs/} but this can be
+overridden by setting the environment variable
+@code{LILYPOND_TEMPDOCS}.
+
 This script will not work for building sections of the
 Contributors' guide.  For building sections of the Contributors'
 Guide, use:
@@ -1461,8 +1468,8 @@ use:
 scripts/auxiliar/cg-section.sh doc-work
 @end example
 
-Like @code{doc-section.sh}, @code{cg-section.sh} may need to be customized
-for your installation.
+@code{cg-section.sh} uses the same environment variables and
+corresponding default values as @code{doc-section.sh}.
 
 @subheading Stripping whitespace and generating menus
 
@@ -1535,7 +1542,7 @@ take some time before your request or contribution is handled.
 @node Getting started with documentation translation
 @subsection Getting started with documentation translation
 
-First, get the sources of branch @code{lilypond/translation} from the
+First, get the sources of branch @code{translation} from the
 Git repository, see @ref{Starting with Git}.
 
 @menu
@@ -2228,19 +2235,19 @@ translations to Git.
 
 @itemize
 @item Translation changes matching master branch are preferably made on
-@code{lilypond/translation} branch; they may be pushed directly to
+@code{translation} branch; they may be pushed directly to
 @code{master} only if they do not break compilation of LilyPond and
 its documentation, and in this case they should be pushed to
-@code{lilypond/translation} too.  Similarly, changes matching
+@code{translation} too.  Similarly, changes matching
 @code{stable/X.Y} are preferably made on
 @code{lilypond/X.Ytranslation}.
 
-@item @code{lilypond/translation} Git branch may be merged into
+@item @code{translation} Git branch may be merged into
 master only if LilyPond (@command{make all}) and documentation
 (@command{make doc}) compile successfully.
 
 @item @code{master} Git branch may be merged into
-@code{lilypond/translation} whenever @command{make} and @command{make
+@code{translation} whenever @command{make} and @command{make
 doc} are successful (in order to ease documentation compilation by
 translators), or when significant changes had been made in
 documentation in English in master branch.