7 ** AARGH.e We also have tutorial.itely: Integrating text and music.
9 Could also do with a cleanup. Lost inspiration to fix this manual
10 where to describe what?
15 @node lilypond-book manual
16 @chapter lilypond-book manual
18 If you want to add pictures of music to a document, you can simply do
19 it the way you would do with other types of pictures. The pictures
20 are created separately, yielding PostScript pictures or PNG images,
21 and those are included into a La@TeX{} or HTML document.
23 @command{lilypond-book} provides a way to automate this process: this
24 program extracts snippets of music from your document, runs LilyPond
25 on them, and outputs the document with pictures substituted for the
26 music. The line width and font size definitions for the music are
27 adjusted to match the layout of your document.
29 This procedure may be applied to La@TeX{}, @code{html} or Texinfo
30 documents. A tutorial on using lilypond-book is in @ref{Integrating
31 text and music}. For more information about La@TeX{}
32 @uref{http://www.ctan.org/tex-archive/info/lshort/english/,The not so
33 Short Introduction to LaTeX} provides a introction to using La@TeX{}.
39 * Integrating Texinfo and music::
40 * Integrating LaTeX and music::
41 * Integrating HTML and music::
42 * Music fragment options::
43 * Invoking lilypond-book::
53 @cindex documents, adding music to
56 @node Integrating Texinfo and music
57 @section Integrating Texinfo and music
59 Music is specified like this:
62 @@lilypond[options, go, here]
65 @@lilypond[options, go, here]@{ YOUR LILYPOND CODE @}
66 @@lilypondfile[options, go, here]@{@var{filename}@}
69 When lilypond-book is run on it, this results in a texinfo file. We
70 show two simple examples here. First a complete block:
85 Then the short version:
88 @@lilypond[11pt]@{<c' e' g'>@}
94 @lilypond[11pt]{ <c' e' g'> }
96 @command{lilypond-book} knows the default margins and a few paper
97 sizes. One of these commands should be in the beginning of the document:
100 @item @code{@@afourpaper}
101 @item @code{@@afourlatex}
102 @item @code{@@afourwide}
103 @item @code{@@smallbook}
107 @code{@@pagesizes} are not yet supported.
109 When producing texinfo, lilypond-book also generates bitmaps of the
110 music, so you can make a HTML document with embedded music.
113 @c @TeX{} in node name seems to barf
114 @node Integrating LaTeX and music
115 @section Integrating LaTeX and music
118 For La@TeX{}, music is entered using
121 \begin[options, go, here]@{lilypond@}
127 \lilypondfile[options, go,here]@{@var{filename}@}
134 \lilypond@{ YOUR LILYPOND CODE @}
137 Running lilypond-book yields a file that can be processed with
138 La@TeX{}. We show some examples here:
141 \begin[26pt]@{lilypond@}
153 Then the short version:
156 \lilypond[11pt]@{<c' e' g'>@}
162 @lilypond[11pt]{<c' e' g'>}
164 The linewidth of the music will be adjust by examining the commands in
165 the document preamble, the part of the document before
166 @code{\begin@{document@}}: @command{lilypond-book} sends these to
167 La@TeX{} to find out how wide the text is. The line width variable for
168 the music fragments are adjusted to the text width.
170 After @code{\begin@{document@}}, the column changing commands
171 @code{\onecolumn} , @code{\twocolumn} commands and the
172 @code{multicols} environment from the multicol package are also
175 The titling from the @code{\header} section of the fragments can be
176 imported by adding the following to the top of the La@TeX{} file:
180 \def\preLilyPondExample@{\def\mustmakelilypondtitle@{@}@}
183 The music will be surrounded by @code{\preLilyPondExample} and
184 @code{\postLilyPondExample}, which are defined to be empty by default.
186 @node Integrating HTML and music
187 @section Integrating HTML and music
189 Music is entered using
192 <lilypond relative1 verbatim>
193 \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
198 of which lilypond-book will produce a HTML with appropriate image tags for the
202 <lilypond relative1 verbatim>
203 \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
208 \key c \minor r8 c16 b c8 g as c16 b c8 d | g,4
211 For inline pictures, use @code{<lilypond ... />} syntax, eg.
213 Some music in <lilypond a b c/> a line of text.
216 A special feature not (yet) available in other output formats, is the
217 @code{<ly2dvifile>} tag, for example,
219 <ly2dvifile>trip.ly</ly2dvifile>
221 This runs @file{trip.ly} through @code{lilypond} (see also
222 @ref{Invoking lilypond}), and substitutes a preview image in the
223 output. The image links to a separate HTML file, so clicking it will
224 take the viewer to a menu, with links to images, midi and printouts.
226 @cindex titling in THML
227 @cindex preview image
230 @node Music fragment options
231 @section Music fragment options
233 The commands for lilypond-book have room to specify one or more of the
238 CONTENTS is copied into the source enclosed in a verbatim block,
239 followed by any text given with the @code{intertext} option, then
240 the actual music is displayed. This option does not work with
241 the short version of the music blocks:
243 @code{ @@lilypond@{ CONTENTS @} } and @code{ \lilypond@{ CONTENTS @} }
246 works like @code{verbatim}, but in a smaller font.
248 @item intertext="@var{text}"
249 is used in conjunction with @code{verbatim} option: This puts
250 @var{text} between the code and the music (without indentation).
252 @item filename="@var{filename}"
253 saves the LilyPond code to @var{filename}. By default, a hash value
259 r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
260 d16[ g, a b] c[ a b g] d'8[ g f\prall g]
267 r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
268 d16[ g, a b] c[ a b g] d'8[ g f\prall g]
275 r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
282 r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
289 r16 c[ d e] f[ d e c] g'8[ c] b[\prall c] |
294 produces naturally spaced lines (i.e., @code{raggedright = ##t}); this
295 works well for small music fragments.
298 is the opposite of @code{singleline}: it justifies and breaks lines.
300 @item linewidth=@var{size}@var{unit}
301 sets linewidth to @var{size}, where @var{unit} = cm, mm, in, or pt.
302 This option affects LilyPond output, not the text layout.
305 prevents printing time signature.
309 overrides @command{lilypond-book} auto detection of what type of code is
310 in the LilyPond block, voice contents or complete code.
312 @item indent=@var{size}@var{unit}
313 sets indentation of the first music system to @var{size},
314 where @var{unit} = cm, mm, in, or pt. This option affects LilyPond,
315 not the text layout. For single-line fragments the default is to
320 \begin[indent=5cm,raggedright]@{lilypond@}
327 sets indentation of the first music system to zero. This option
328 affects LilyPond, not the text layout.
331 prevents including @code{texidoc}. This is only for Texinfo output.
333 In Texinfo, the music fragment is normally preceded by the
334 @code{texidoc} field from the @code{\header}. The LilyPond test
335 documents are composed from small @file{.ly} files in this way:
339 texidoc = "this file demonstrates a single note"
341 \score @{ \notes @{ c'4 @} @}
345 instructs @command{lilypond-book} to put La@TeX{} and Texinfo output
346 into a quotation block.
349 prints the file name before the music example. Useful in conjunction
350 with @code{\lilypondfile}.
352 @item relative, relative @var{N}
353 uses relative octave mode. By default, notes are specified relative
354 central C. The optional integer argument specifies the octave of the
355 starting note, where the default @code{1} is central C.
359 @node Invoking lilypond-book
360 @section Invoking lilypond-book
362 Running @command{lilypond-book} generates lots of small files that
363 LilyPond will process. To avoid all that garbage in the source
364 directory, it is advisable to change to a temporary directory first:
366 cd out && lilypond-book ../yourfile.tex
370 or to use the @option{--outdir} command line option, and change to
371 that director before running La@TeX{} or @file{makeinfo}:
374 lilypond-book --outdir=out yourfile.tex
375 cd out && latex yourfile.latex
378 For La@TeX{} input, the file to give to La@TeX{} has extension @file{.latex}.
379 Texinfo input will be written to a file with extension @file{.texi}.
381 @cindex titling and lilypond-book
382 @cindex lilypond-book and titling
383 @cindex @code{\header} in La@TeX{} documents
385 To add titling from the @code{\header} section of the files, add the
386 following to the top of the La@TeX{} file:
389 \def\preLilyPondExample@{\def\mustmakelilypondtitle@{@}@}
392 @cindex outline fonts
395 @cindex invoking dvips
397 For printing the LaTeX document, you will need to use dvips. For
398 producing PS with scalable fonts, add the following options to the dvips
401 -Ppdf -u +lilypond.map
406 @command{lilypond-book} accepts the following command line options:
409 @item @option{-f @var{format}}, @option{--format=@var{format}}
410 Specify the document type to process: @code{html}, @code{latex} or
411 @code{texi} (the default). @command{lilypond-book} usually figures this
414 The @code{texi} document type produces a texinfo file with music
415 fragments in the DVI output only. For getting images in the HTML
417 @code{texi-html} must be used.
419 @item @option{--default-music-fontsize=@var{sz}pt}
420 Set the music font size to use if no fontsize is given as option.
422 @item @option{--force-music-fontsize=@var{sz}pt}
423 Force all music to use this fontsize, overriding options given to
424 @code{\begin@{lilypond@}}.
426 @item @option{-I @var{dir}}, @option{--include=@var{dir}}
427 Add @var{DIR} to the include path.
429 @item @option{-M}, @option{--dependencies}
430 Write dependencies to @file{filename.dep}.
432 @item @option{--dep-prefix=@var{pref}}
433 Prepend @var{pref} before each @option{-M} dependency.
435 @item @option{-n}, @option{--no-lily}
436 Generate the @code{.ly} files, but do not process them.
438 @item @option{--no-music}
439 Strip all music from the input file.
441 @item @option{--no-pictures}
442 Do not generate pictures when processing Texinfo.
444 @item @option{--outname=@var{file}}
445 The name of La@TeX{} file to output. If this option is not given,
446 the output name is derived from the input name.
448 @item @option{--outdir=@var{dir}}
449 Place generated files in @var{dir}.
451 @item @option{--version}
452 Print version information.
454 @item @option{--help}
455 Print a short help message.
462 The La@TeX{} @code{\includeonly@{...@}} command is ignored.
464 The Texinfo command @code{pagesize} is not interpreted. Almost all
465 La@TeX{} commands that change margins and line widths are ignored.
467 Only the first @code{\score} of a LilyPond block is processed.
469 The size of a music block is limited to 1.5 kb, due to technical
470 problems with the Python regular expression engine. For longer files,
471 use @code{\lilypondfile}. Using @code{\lilypondfile} also makes
472 upgrading files (through convert-ly, see @ref{Invoking convert-ly})
475 @command{lilypond-book} processes all music fragments in one big run.
476 The state of the GUILE interpreter is not reset between fragments;
477 this means that changes made to global GUILE definitions, e.g. done
478 with @code{set!} or @code{set-cdr!}, can leak from one fragment into