@end ignore
-@c @node Merging text and music with lilypond-book
-@c @chapter Merging text and music with lilypond-book
-@c fix this node name , this is too long.
-
-@node Insert music snippets into your texts using lilypond-book
-@chapter Insert music snippets into your texts using lilypond-book
+@node lilypond-book manual
+@chapter lilypond-book manual
If you want to add pictures of music to a document, you can simply do
-it the way you would do with other types of pictures. You write
-LilyPond code, process it separately to embedded PostScript or
-@code{png}, and include it as a picture into your La@TeX{} or
-@code{html} source.
+it the way you would do with other types of pictures. The pictures
+are created separately, yielding PostScript pictures or PNG images,
+and those are included into a La@TeX{} or HTML document.
-@command{lilypond-book} provides you with an alternative and easier
-way; it allows you to insert snippets of LilyPond code into your
-La@TeX{}, @code{html} or @code{texi} document. @code{lilypond-book}
-introduces some extra LilyPond specific constructs, that integrate
-seamlessly with the rest of your source document.
+@command{lilypond-book} provides a way to automate this process: this
+program extracts snippets of music from your document, runs LilyPond
+on them, and outputs the document with pictures substituted for the
+music. The line width and font size definitions for the music are
+adjusted to match the layout of your document.
+This procedure may be applied to La@TeX{}, @code{html} or Texinfo
+documents. A tutorial on using lilypond-book is in @ref{Integrating
+text and music}. For more information about La@TeX{}
+@uref{http://www.ctan.org/tex-archive/info/lshort/english/,The not so
+Short Introduction to LaTeX} provides a introction to using La@TeX{}.
-@command{lilypond-book} runs LilyPond on fragments of LilyPond in a
-La@TeX{} or Texinfo file, and includes the results into a document that
-can be processed with La@TeX{}, @command{makeinfo} or
-@command{texi2dvi}. The result is a text document containing formatted
-music integrated.
+@menu
+* Integrating Texinfo and music::
+* Integrating LaTeX and music::
+* Integrating HTML and music::
+* Music fragment options::
+* Invoking lilypond-book::
+@end menu
-More precisely, if a La@TeX{} file contains
-@example
- \begin@{lilypond@}
- CONTENTS
- \end@{lilypond@}
-
-@end example
-or
-@example
- \lilypond@{CONTENTS@}
-@end example
-then LilyPond is run on CONTENTS. @command{lilypond-book} puts the
-result back into the latex file. When you run the result through latex,
-you get a document that mixes text and music. lilypond-book will insert
-line width and font size definitions before @code{CONTENTS}, so the
-music samples will match the layout of your document.
-
-Very often, if you mix music and text, the music is only a few
-notes or at most a few bars. This music should be as short as possible
-and not stretched to be aligned to the right margin. lilypond-book does
-this automatically if you don't use a @code{\score} block in
-@code{CONTENTS}. For example: @code{\lilypond@{\context Voice <c' e' g'>
-@}}.
-
-You can also use @code{lilypondfile} to include another file:
-@example
- \lilypondfile@{foo.ly@}
-@end example
-All three forms can take several options. They are specified in brackets
-as follows:
-@example
- \lilypondfile[options, go, here]@{ .. @}
- \begin[options, go, here]@{lilypond@} .. \end@{lilypond@}
- \lilypond[options, go,here]@{ .. @}
-@end example
+@cindex texinfo
+@cindex latex
+@cindex texinfo
+@cindex @code{texi}
+@cindex html
+@cindex documents, adding music to
-In the Texinfo version, bitmaps of the music are also generated, so you
-can make a HTML document with embedded music.
+@node Integrating Texinfo and music
+@section Integrating Texinfo and music
-@section Texinfo reference
+Music is specified like this:
-You specify the LilyPond code like this:
@example
@@lilypond[options, go, here]
YOUR LILYPOND CODE
@@end lilypond
-@@lilypond[option, go, here]@{ YOUR LILYPOND CODE @}
-@@lilypondfile[options, go,here]@{@var{filename}@}
+@@lilypond[options, go, here]@{ YOUR LILYPOND CODE @}
+@@lilypondfile[options, go, here]@{@var{filename}@}
@end example
-We show two simple examples here. First a complete block:
+When lilypond-book is run on it, this results in a texinfo file. We
+show two simple examples here. First a complete block:
+
@example
@@lilypond[26pt]
-c' d' e' f' g'2 g'
+ c' d' e' f' g'2 g'
@@end lilypond
@end example
-produces this music:
+@noindent
+produces
+
@lilypond
-c' d' e' f' g'2 g'
+ c' d' e' f' g'2 g'
@end lilypond
Then the short version:
+
@example
-@@lilypond[11pt]@{<c' e' g'>@}
+@@lilypond[11pt]@{<<c' e' g'>>@}
@end example
-and its music:
+@noindent
+produces
+
+@lilypond[11pt]{ <<c' e' g'>> }
-@lilypond[11pt]{<c' e' g'>}
+@command{lilypond-book} knows the default margins and a few paper
+sizes. One of these commands should be in the beginning of the document:
-@command{lilypond-book} knows the default margins, and a few paper
-sizes. One of these commands should be in the beginning of the document:
@itemize @bullet
@item @code{@@afourpaper}
@item @code{@@afourlatex}
@item @code{@@afourwide}
@item @code{@@smallbook}
@end itemize
+
+@noindent
@code{@@pagesizes} are not yet supported.
-@section La@TeX{} reference
+When producing texinfo, lilypond-book also generates bitmaps of the
+music, so you can make a HTML document with embedded music.
+
+
+@c @TeX{} in node name seems to barf
+@node Integrating LaTeX and music
+@section Integrating LaTeX and music
+
+
+For La@TeX{}, music is entered using
-You specify the LilyPond code like this:
@example
-\begin[option, go, here]@{lilypond@}
- YOUR LILYPOND CODE
+\begin[options, go, here]@{lilypond@}
+ YOUR LILYPOND CODE
\end@{lilypond@}
@end example
@example
\lilypondfile[options, go,here]@{@var{filename}@}
@end example
-or
+
+@noindent
+or
+
@example
\lilypond@{ YOUR LILYPOND CODE @}
@end example
-We show some examples here.
+Running lilypond-book yields a file that can be processed with
+La@TeX{}. We show some examples here:
@example
\begin[26pt]@{lilypond@}
-c' d' e' f' g'2 g'2
+ c' d' e' f' g'2 g'2
\end@{lilypond@}
@end example
-produces this music:
+@noindent
+produces
@lilypond[26pt]
-c' d' e' f' g'2 g'2
+ c' d' e' f' g'2 g'2
@end lilypond
Then the short version:
+
@example
-\lilypond[11pt]@{<c' e' g'>@}
+\lilypond[11pt]@{<<c' e' g'>>@}
@end example
-and its music:
+@noindent
+produces
-@lilypond[11pt]{<c' e' g'>}
+@lilypond[11pt]{<<c' e' g'>>}
+The linewidth of the music will be adjust by examining the commands in
+the document preamble, the part of the document before
+@code{\begin@{document@}}: @command{lilypond-book} sends these to
+La@TeX{} to find out how wide the text is. The line width variable for
+the music fragments are adjusted to the text width.
-You can use whatever commands you like in the document preamble,
-that is the part of the document before @code{\begin@{document@}}.
-@command{lilypond-book} will send it to La@TeX{} to find out how wide
-the text is and adjust the linewidth variable in the paper definition of
-you music according to that.
+After @code{\begin@{document@}}, the column changing commands
+@code{\onecolumn} , @code{\twocolumn} commands and the
+@code{multicols} environment from the multicol package are also
+interpreted.
-After @code{\begin@{document@}} you must be a little more careful
-when you use commands that change the width of the text and how
-many columns there are. @command{lilypond-book} know about the
-@code{\onecolumn} and @code{\twocolumn} commands and the @code{multicols}
-environment from the multicol package.
+The titling from the @code{\header} section of the fragments can be
+imported by adding the following to the top of the La@TeX{} file:
-The music will be surrounded by @code{\preLilypondExample} and
-@code{\postLilypondExample}. The variables are
-defined to nothing by default, and the user can redefine them
-to whatever he wants.
+@example
+\input titledefs.tex
+\def\preLilyPondExample@{\def\mustmakelilypondtitle@{@}@}
+@end example
+The music will be surrounded by @code{\preLilyPondExample} and
+@code{\postLilyPondExample}, which are defined to be empty by default.
-@section HTML reference
+@node Integrating HTML and music
+@section Integrating HTML and music
-You specify the LilyPond code like this:
+Music is entered using
-@quotation
@example
<lilypond relative1 verbatim>
\key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
-</lilypond>
+</lilypond>
@end example
-@end quotation
-
-produces
-@quotation
+@noindent
+of which lilypond-book will produce a HTML with appropriate image tags for the
+music fragments:
+
@example
<lilypond relative1 verbatim>
\key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
-</lilypond>
+</lilypond>
@end example
+
@lilypond[relative1]
\key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
@end lilypond
-@end quotation
-
-Inline picture:
-@quotation
+For inline pictures, use @code{<lilypond ... />} syntax, eg.
@example
Some music in <lilypond a b c/> a line of text.
@end example
-@end quotation
-@c Huh? ugh, can't show inline pictures in texinfo?
-
-@c Some music in @lilypond{a b c} a line of text.
+A special feature not (yet) available in other output formats, is the
+@code{<ly2dvifile>} tag, for example,
+@example
+ <ly2dvifile>trip.ly</ly2dvifile>
+@end example
+This runs @file{trip.ly} through ly2dvi (see also @ref{Invoking
+ly2dvi}), and substitutes a preview image in the output. The image
+links to a separate HTML file, so clicking it will take the viewer to
+a menu, with links to images, midi and printouts.
+@cindex ly2dvi
+@cindex titling in THML
+@cindex preview image
+@cindex thumbnail
+@node Music fragment options
+@section Music fragment options
-@section Options
+The commands for lilypond-book have room to specify one or more of the
+following options:
@table @code
-@item eps
-This will create the music as eps graphics and include it into the
-document with the @code{\includegraphics} command. It works in
-La@TeX{} only.
-
-This enables you to place music examples in the running text (and not in
-a separate paragraph). To avoid that La@TeX{} places the music on a line
-of its own, there should be no empty lines between the normal text and
-the LilyPond environment. For inline music, you probably also need a
-smaller music font size (eg. 11 pt or 13 pt)
-
-
@item verbatim
- CONTENTS is copied into the source enclosed in a verbatim block,
- followed by any text given with the @code{intertext} option, then
- the actual music is displayed. This option does not work with
- the short version of the LilyPond blocks:
+CONTENTS is copied into the source enclosed in a verbatim block,
+followed by any text given with the @code{intertext} option, then
+the actual music is displayed. This option does not work with
+the short version of the music blocks:
- @code{ @@lilypond@{ CONTENTS @} } and @code{ \lilypond@{ CONTENTS @} }
+@code{ @@lilypond@{ CONTENTS @} } and @code{ \lilypond@{ CONTENTS @} }
@item smallverbatim
- like @code{verbatim}, but in a smaller font.
+works like @code{verbatim}, but in a smaller font.
@item intertext="@var{text}"
- Used in conjunction with @code{verbatim} option: this puts
-@var{text} between the code and the music.
+is used in conjunction with @code{verbatim} option: This puts
+@var{text} between the code and the music (without indentation).
+
@item filename="@var{filename}"
- Save the LilyPond code to @var{filename}. By default, a hash value
+saves the LilyPond code to @var{filename}. By default, a hash value
of the code is used.
-@item @code{11pt}
+@item 11pt
@lilypond[11pt, eps]
- \relative c'{
- r16 [c d e][f d e c] [g'8 c][b-\prall c] |
- [d16 g, a b][c a b g][d'8 g f-\prall g]
- }
+\relative c' {
+ r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
+ d16[ g, a b] c[ a b g] d'8[ g f\prall g]
+}
@end lilypond
-@item @code{13pt}
+
+@item 13pt
@lilypond[13pt, eps]
- \relative c'{
- r16 [c d e][f d e c] [g'8 c][b-\prall c] |
- [d16 g, a b][c a b g][d'8 g f-\prall g]
- }
+\relative c' {
+ r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
+ d16[ g, a b] c[ a b g] d'8[ g f\prall g]
+}
@end lilypond
-@item @code{16pt}
+
+@item 16pt
@lilypond[16pt, eps]
- \relative c'{
- r16 [c d e][f d e c] [g'8 c][b-\prall c] |
- [d16 g, a b][c a b g][d'8 g f-\prall g]
- }
+\relative c' {
+ r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
+}
@end lilypond
-@item @code{20pt}
+
+@item 20pt
@lilypond[20pt, eps]
- \relative c'{
- r16 [c d e][f d e c] [g'8 c][b-\prall c] |
- [d16 g, a b][c a b g][d'8 g f-\prall g]
- }
+\relative c' {
+ r16 [c d e][f d e c] [g'8 c][b-\prall c] |
+}
@end lilypond
-@item @code{26pt}
+
+@item 26pt
@lilypond[26pt, eps]
- \relative c'{
- r16 [c d e][f d e c] [g'8 c][b-\prall c] |
- }
+\relative c' {
+ r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
+}
@end lilypond
-@item singleline
- Produce a single naturally spaced, unjustified line. (i.e.: linewidth = -1).
+@item raggedright
+produces naturally spaced lines (i.e., @code{raggedright = ##t}); this
+works well for small music fragments.
+
@item multiline
- The opposite of @code{singleline}: justify and break lines.
+is the opposite of @code{singleline}: it justifies and breaks lines.
+
@item linewidth=@var{size}@var{unit}
- Set linewidth to @var{size}, where @var{unit} = cm, mm, in or pt.
+sets linewidth to @var{size}, where @var{unit} = cm, mm, in, or pt.
+This option affects LilyPond output, not the text layout.
+
+@item notime
+prevents printing time signature.
+
@item fragment
-@item nofragment
- Override @command{lilypond-book} auto detection of what type of code is in the
- LilyPond block, voice contents or complete code.
+@itemx nofragment
+overrides @command{lilypond-book} auto detection of what type of code is
+in the LilyPond block, voice contents or complete code.
+
@item indent=@var{size}@var{unit}
- Set first line indent to @var{size}, where @var{unit} = cm, mm, in or pt.
+sets indentation of the first music system to @var{size},
+where @var{unit} = cm, mm, in, or pt. This option affects LilyPond,
+not the text layout. For single-line fragments the default is to
+use no indentation.
+
@item noindent
- Set first line indent to zero.
+sets indentation of the first music system to zero. This option
+affects LilyPond, not the text layout.
+
+@item notexidoc
+prevents including @code{texidoc}. This is only for Texinfo output.
+
+In Texinfo, the music fragment is normally preceded by the
+@code{texidoc} field from the @code{\header}. The LilyPond test
+documents are composed from small @file{.ly} files in this way:
+
+@example
+ \header @{
+ texidoc = "this file demonstrates a single note"
+ @}
+ \score @{ \notes @{ c'4 @} @}
+@end example
+
+@item quote
+instructs @command{lilypond-book} to put La@TeX{} and Texinfo output
+into a quotation block.
+
@item printfilename
- Prints the file name before the music example. Useful in conjunction
+prints the file name before the music example. Useful in conjunction
with @code{\lilypondfile}.
+
@item relative, relative @var{N}
- Use relative octave mode. By default, notes are specified relative
- central C. The optional integer argument specifies how many octaves
- higher (positive number) or lower (negative number) to place the
- starting note.
+uses relative octave mode. By default, notes are specified relative
+central C. The optional integer argument specifies the octave of the
+starting note, where the default @code{1} is central C.
@end table
-@section Invocation
-When you run @command{lilypond-book} it will generate lots of small
-files that LilyPond will process. So to avoid all the garbage in
-your source directory, you should either change to a temporary
-directory, or use the @code{--outdir} command line options:
+@node Invoking lilypond-book
+@section Invoking lilypond-book
-@code{cd out && lilypond-book ../yourfile.tex}
+Running @command{lilypond-book} generates lots of small files that
+LilyPond will process. To avoid all that garbage in the source
+directory, it is advisable to change to a temporary directory first:
+@example
+cd out && lilypond-book ../yourfile.tex
+@end example
-@code{lilypond-book --outdir=out yourfile.tex}
+@noindent
+or to use the @option{--outdir} command line option, and change to
+that director before running La@TeX{} or @file{makeinfo}:
+@example
+lilypond-book --outdir=out yourfile.tex
+cd out && latex yourfile.latex
+@end example
-For latex input, the file to give to latex has extension @file{.latex}.
+For La@TeX{} input, the file to give to La@TeX{} has extension @file{.latex}.
Texinfo input will be written to a file with extension @file{.texi}.
-If you use @code{--outdir}, you should also @code{cd} to that directory
-before running LaTeX or makeinfo. This may seem a little kludgey, but
-both Latex and makeinfo expect picture files (the music) to be in the
-current working directory. Moreover, if you do this, LaTeX will not
-clutter you normal working directory with output files.
-
@cindex titling and lilypond-book
@cindex lilypond-book and titling
-@cindex \header in LaTeX documents
+@cindex @code{\header} in La@TeX{} documents
-If you want to add titling from the @code{\header} section of the
-files, you should add the following to the top of your LaTeX
+To add titling from the @code{\header} section of the files, add the
+following to the top of the La@TeX{} file:
@example
\input titledefs.tex
-\def\preLilypondExample@{\def\mustmakelilypondtitle@{@}@}
+\def\preLilyPondExample@{\def\mustmakelilypondtitle@{@}@}
@end example
-lilypond-book accepts the following command-line options:
+@cindex outline fonts
+@cindex type1 fonts
+@cindex dvips
+@cindex invoking dvips
+
+For printing the LaTeX document, you will need to use dvips. For
+producing PS with scalable fonts, add the following options to the dvips
+command line:
+@example
+ -Ppdf -u +lilypond.map
+@end example
+
+
+
+@command{lilypond-book} accepts the following command line options:
+
@table @code
-@item @option{-f}, @option{--format=}
- Specify the document type to process: @code{html}, @code{latex} or
-@code{texi} (default). @command{lilypond-book} usually figures this
+@item @option{-f @var{format}}, @option{--format=@var{format}}
+Specify the document type to process: @code{html}, @code{latex} or
+@code{texi} (the default). @command{lilypond-book} usually figures this
out automatically.
-@item --default-music-fontsize=@var{sz}pt
- Set the fontsize to use for LilyPond if no fontsize is given
- as option.
-@item --force-music-fontsize=@var{sz}pt
- Force all LilyPond to use this fontsize, overriding options
- given to @code{\begin@{lilypond@}}
-@item -I @var{DIR}, --include=@var{DIR}
- Add @var{DIR} to the include path.
-@item -M, --dependencies
- Write dependencies to @file{filename.dep}
-@item --dep-prefix=@code{PREF}
- prepend @code{PREF} before each @code{-M} dependency
-@item -n, --no-lily
- don't run LilyPond, but do generate the @code{.ly} files
-@item --no-music
- strip all LilyPond blocks from the file.
-@item --no-pictures
- don't generate pictures when processing Texinfo.
-@item --read-lys
- don't write ly files. This way you can do
-@example
- lilypond-book file.tely
- convert-ly
- lilypond-book --read-lys
-@end example
-[TODO not a useful option unless you can undump the input file]
-
-@item --outname=@var{FILE}
- The name of La@TeX{} file to output. If this option is not given,
- the output name is derived from the input name.
-@item --outdir=@var{DIR}
- place generated files in @var{DIR}.
-@item --version
- print version information
-@item --help
- Print a short help message
+The @code{texi} document type produces a texinfo file with music
+fragments in the DVI output only. For getting images in the HTML
+version, the format
+@code{texi-html} must be used.
+
+@item @option{--default-music-fontsize=@var{sz}pt}
+Set the music font size to use if no fontsize is given as option.
+
+@item @option{--force-music-fontsize=@var{sz}pt}
+Force all music to use this fontsize, overriding options given to
+@code{\begin@{lilypond@}}.
+
+@item @option{-I @var{dir}}, @option{--include=@var{dir}}
+Add @var{DIR} to the include path.
+
+@item @option{-M}, @option{--dependencies}
+Write dependencies to @file{filename.dep}.
+
+@item @option{--dep-prefix=@var{pref}}
+Prepend @var{pref} before each @option{-M} dependency.
+
+@item @option{-n}, @option{--no-lily}
+Generate the @code{.ly} files, but do not process them.
+
+@item @option{--no-music}
+Strip all music from the input file.
+
+@item @option{--no-pictures}
+Do not generate pictures when processing Texinfo.
+
+@item @option{--outname=@var{file}}
+The name of La@TeX{} file to output. If this option is not given,
+the output name is derived from the input name.
+
+@item @option{--outdir=@var{dir}}
+Place generated files in @var{dir}.
+
+@item @option{--version}
+Print version information.
+
+@item @option{--help}
+Print a short help message.
@end table
+
@section Bugs
-
-The La@TeX{} \includeonly@{...@} command is ignored.
-The Texinfo command @code{pagesize} is on the TODO list for LilyPond
-1.6, but changing the linewidth in other ways will not give you a
-straight right margin.
+The La@TeX{} @code{\includeonly@{...@}} command is ignored.
+
+The Texinfo command @code{pagesize} is not interpreted. Almost all
+La@TeX{} commands that change margins and line widths are ignored.
-Almost all La@TeX{} commands that change margins and line widths are
-ignored.
+The size of a music block is limited to 1.5 kb, due to technical
+problems with the Python regular expression engine. For longer files,
+use @code{\lilypondfile}. Using @code{\lilypondfile} also makes
+upgrading files (through convert-ly, see @ref{Invoking convert-ly})
+easier.
-There is no way to automatically apply convert-ly to fragments inside a
-lilypond-book file.
+@command{lilypond-book} processes all music fragments in one big run.
+The state of the GUILE interpreter is not reset between fragments;
+this means that changes made to global GUILE definitions, e.g. done
+with @code{set!} or @code{set-cdr!}, can leak from one fragment into
+the next fragment.
projects / lilypond.git / blobdiff