X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Flilypond-book.itely;h=9d166bb43d631f64301dd762cb20ee7e30817a6e;hb=39c0e8adb498996f5e414b1d0bc3a20ac81aa619;hp=7fc46d3f1500d25410de85ab8abf1a3f37eea469;hpb=5c14a087ca6cbd665fd631452b7b1283ba0387c3;p=lilypond.git
diff --git a/Documentation/user/lilypond-book.itely b/Documentation/user/lilypond-book.itely
index 7fc46d3f15..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
@@ -45,12 +45,12 @@ documents.
@cindex @LaTeX{}, music in
@menu
-* An example of a musicological document::
-* Integrating music and text::
-* Music fragment options::
-* Invoking lilypond-book::
-* Filename extensions::
-* Alternate methods of mixing text and music::
+* An example of a musicological document::
+* Integrating music and text::
+* Music fragment options::
+* Invoking lilypond-book::
+* Filename extensions::
+* Alternate methods of mixing text and music::
@end menu
@@ -165,10 +165,10 @@ Larger examples can be put into a separate file, and introduced with
Here we explain how to integrate LilyPond with various output formats.
@menu
-* LaTeX::
-* Texinfo::
-* HTML::
-* DocBook::
+* LaTeX::
+* Texinfo::
+* HTML::
+* DocBook::
@end menu
@node LaTeX
@@ -205,8 +205,10 @@ or
\lilypond@{ YOUR LILYPOND CODE @}
@end example
+Additionally, @code{\lilypondversion} displays the current version
+of lilypond.
Running @command{lilypond-book} yields a file that can be further
-processed with @LaTeX{}.
+processed with @LaTeX{}.
We show some examples here. The @code{lilypond} environment
@@ -253,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,
@@ -304,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.
@@ -357,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
@@ -392,6 +395,9 @@ or
@@lilypondfile[options,go,here]@{@var{filename}@}
@end example
+Additionally, @code{@@lilypondversion} displays the current version
+of lilypond.
+
When @command{lilypond-book} is run on it, this results in a Texinfo
file (with extension @file{.texi}) containing @code{@@image} tags for
HTML, Info and printed output. @command{lilypond-book} generates images
@@ -438,7 +444,6 @@ Music is entered using
\key c \minor c4 es g2
@end example
-
@noindent
@command{lilypond-book} then produces an HTML file with appropriate image
tags for the music fragments:
@@ -454,12 +459,17 @@ are separated by a colon from the music, for example
Some music in a line of text.
@end example
+
To include separate files, say
@example
@var{filename}
@end example
+Additionally, @code{} displays the current version
+of lilypond.
+
+
@cindex titling in HTML
@cindex preview image
@cindex thumbnail
@@ -496,7 +506,7 @@ the following structure:
@end example
-Note that you can use @code{mediaobject} or @code{inlinemediaobject}
+Note that you can use @code{mediaobject} or @code{inlinemediaobject}
as the outermost element as you wish.
@subheading Including LilyPond code
@@ -511,7 +521,7 @@ structure:
\context Staff \with @{
\remove Time_signature_engraver
- \remove Clef_engraver@}
+ \remove Clef_engraver@}
@{ c4( fis) @}
@@ -564,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
@@ -650,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.
@@ -669,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.
@@ -701,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
@@ -735,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
@@ -901,7 +917,7 @@ music stick out of the right margin.
The width of a tightly clipped system can vary, due to notation
elements that stick into the left margin, such as bar numbers and
-instrument names. This option will shorten each line and move each
+instrument names. This option will shorten each line and move each
line to the right by the same amount.
@@ -962,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}.
@@ -973,9 +989,9 @@ This section shows methods to integrate text and music, different than
the automated method with @command{lilypond-book}.
@menu
-* Many quotes from a large score::
-* Inserting LilyPond output into OpenOffice.org::
-* Inserting LilyPond output into other programs::
+* Many quotes from a large score::
+* Inserting LilyPond output into OpenOffice.org::
+* Inserting LilyPond output into other programs::
@end menu
@node Many quotes from a large score