X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond-book.itely;h=9d166bb43d631f64301dd762cb20ee7e30817a6e;hb=1423508c355989fa26a8cfe5985b0d6e1ab0a538;hp=2a426ceddd7ce658aa337c3e32f725296cca6687;hpb=1a9669b56e068f0e42ea7b463fb00799916794c4;p=lilypond.git diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely index 2a426ceddd..9d166bb43d 100644 --- a/Documentation/user/lilypond-book.itely +++ b/Documentation/user/lilypond-book.itely @@ -7,7 +7,7 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c \version "2.11.61" +@c \version "2.12.0" @c Note: keep this node named so that `info lilypond-book' brings you here. @node LilyPond-book @@ -205,7 +205,7 @@ or \lilypond@{ YOUR LILYPOND CODE @} @end example -Additionally, @code{\lilypondversion} displays the the current version +Additionally, @code{\lilypondversion} displays the current version of lilypond. Running @command{lilypond-book} yields a file that can be further processed with @LaTeX{}. @@ -255,7 +255,7 @@ use the @code{line-width} music fragment option. Each snippet will call the following macros if they have been defined by the user: -@itemize bullet +@itemize @bullet @item @code{\preLilyPondExample} called before the music, @item @code{\postLilyPondExample} called after the music, @@ -306,7 +306,7 @@ output. In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that inclusion of other systems is terminated once the required number of -systems are included. Since @code{\betweenLilypondSystem} is first +systems are included. Since @code{\betweenLilyPondSystem} is first called @emph{after} the first system, including only the first system is trivial. @@ -359,6 +359,7 @@ and then saying only how many systems you want before each fragment, \begin@{lilypond@}...\end@{lilypond@} @end example + @seealso There are specific @command{lilypond-book} command line options and other details to know when processing @LaTeX{} documents, see @@ -394,7 +395,7 @@ or @@lilypondfile[options,go,here]@{@var{filename}@} @end example -Additionally, @code{@@lilypondversion} displays the the current version +Additionally, @code{@@lilypondversion} displays the current version of lilypond. When @command{lilypond-book} is run on it, this results in a Texinfo @@ -465,7 +466,7 @@ To include separate files, say @var{filename} @end example -Additionally, @code{} displays the the current version +Additionally, @code{} displays the current version of lilypond. @@ -573,11 +574,6 @@ For single-line snippets, allow the staff length to be stretched to equal that of the line width, i.e., @code{ragged-right = ##f} is added to the LilyPond snippet. -@c does this option still exist in lilypond? -jm -@item packed -Produce lines with packed spacing, i.e., @code{packed = ##t} is added -to the LilyPond snippet. - @item line-width @itemx line-width=@var{size}\@var{unit} Set line width to @var{size}, using @var{unit} as units. @var{unit} is @@ -659,7 +655,7 @@ source file contain a comment containing @samp{begin verbatim} (without quotes), quoting the source in the verbatim block will start after the last occurrence of such a comment; similarly, quoting the source verbatim will stop just before the first occurrence of a comment containing -@samp{end verbatim}, it there is any. In the following source file +@samp{end verbatim}, if there is any. In the following source file example, the music will be interpreted in relative mode, but the verbatim quote will not show the @code{relative} block, i.e. @@ -678,6 +674,13 @@ will be printed with a verbatim block like f2 e @end example +@noindent +If you would like to translate comments and variable names in verbatim +output but not in the sources, you may set the environment variable +@code{LYDOC_LOCALEDIR} to a directory path; the directory should +contain a tree of @file{.mo} message catalogs with @code{lilypond-doc} +as a domain. + @item addversion (Only for Texinfo output.) Prepend line @code{\version @@w@{"@@version@{@}"@}} to @code{verbatim} output. @@ -710,8 +713,8 @@ and we have this in our Texinfo document @file{test.texinfo} the following command line gives the expected result @example -lilypond-book --process="lilypond --format=tex --tex \ - --header=texidoc test.texinfo +lilypond-book --pdf --process="lilypond \ + -dbackend=eps --header=texidoc" test.texinfo @end example Most LilyPond test documents (in the @file{input} directory of the @@ -744,6 +747,10 @@ Texinfo document as @code{@@lydoctitle @var{text}}. The same remark about @code{texidoc} processing with localized languages also applies to @code{doctitle}. +@item nogettext +(Only for Texinfo output.) Do not translate comments and variable +names in the snippet quoted verbatim. + @item printfilename If a LilyPond input file is included with @code{\lilypondfile}, print the file name right before the music snippet. For HTML output, this @@ -971,7 +978,7 @@ If you use the same filename extension for the input file than the extension @command{lilypond-book} uses for the output file, and if the input file is in the same directory as @command{lilypond-book} working directory, you must use @code{--output} option to make -@command{lilypond-book} running, otherwise the will exit with an error +@command{lilypond-book} running, otherwise it will exit with an error message like @qq{Output would overwrite input file}.