1 @c -*- coding: latin-1; mode: texinfo; -*-
8 ** AARGH. We also have tutorial.itely: Integrating text and music.
10 Could also do with a cleanup. Lost inspiration to fix this manual
11 where to describe what?
16 @c Note: keep this node named so that `info lilypond-book' brings you here.
18 @chapter @command{lilypond-book}: Integrating text and music
20 If you want to add pictures of music to a document, you can simply do it
21 the way you would do with other types of pictures. The pictures are
22 created separately, yielding PostScript output or PNG images, and those
23 are included into a La@TeX{} or HTML document.
25 @command{lilypond-book} provides a way to automate this process: This
26 program extracts snippets of music from your document, runs
27 @command{lilypond} on them, and outputs the document with pictures
28 substituted for the music. The line width and font size definitions for
29 the music are adjusted to match the layout of your document.
31 This procedure may be applied to La@TeX{}, HTML or Texinfo documents.
34 * An example of a musicological document::
35 * Integrating LaTeX and music::
36 * Integrating Texinfo and music::
37 * Integrating HTML and music::
38 * Music fragment options::
39 * Invoking lilypond-book::
40 * Filename extensions::
44 @node An example of a musicological document
45 @section An example of a musicological document
48 @cindex La@TeX{}, music in
49 @cindex HTML, music in
50 @cindex Texinfo, music in
51 Some texts contain music examples. These texts are musicological
52 treatises, songbooks, or manuals like this. Such texts can be made by
53 hand, simply by importing a PostScript figure into the word processor.
54 However, there is an automated procedure to reduce the amount of work
55 involved in HTML, La@TeX{}, and Texinfo documents.
57 A script called @code{lilypond-book} will extract the music fragments,
58 format them, and put back the resulting notation. Here we show a small
59 example for use with La@TeX{}. The example also contains explanatory
60 text, so we will not comment on it further.
64 \documentclass[a4paper]{article}
68 Documents for @command{lilypond-book} may freely mix music and text.
73 c2 g'2 \times 2/3 { f8 e d } c'2 g4
77 Options are put in brackets.
79 \begin[fragment,quote,staffsize=26,verbatim]{lilypond}
83 Larger examples can be put into a separate file, and introduced with
86 \lilypondfile[quote,noindent]{screech-boink.ly}
92 Under Unix, you can view the results as follows
97 lilypond-book --output=out --psfonts lilybook.tex
98 @emph{lilypond-book (GNU LilyPond) 2.6.0}
99 @emph{Reading lilybook.tex...}
100 @emph{..lots of stuff deleted..}
101 @emph{Compiling out/lilybook.tex...}
104 @emph{lots of stuff deleted}
108 To convert the file into a PDF document, run the following commands
111 dvips -o -Ppdf -h lilybook.psfonts lilybook
115 Running @command{lilypond-book} and @command{latex} creates a lot of
116 temporary files, which would clutter up the working directory. To
117 remedy this, use the @code{--output=@var{dir}} option. It will create
118 the files in a separate subdirectory @file{dir}.
120 Running dvips will produce many warnings about fonts. They are not
121 harmful; please ignore them.
123 Finally the result of the La@TeX{} example shown above.@footnote{This
124 tutorial is processed with Texinfo, so the example gives slightly
125 different results in layout.} This finishes the tutorial section.
129 Documents for @command{lilypond-book} may freely mix music and text.
134 c2 g'2 \times 2/3 { f8 e d } c'2 g4
138 Options are put in brackets.
140 @lilypond[fragment,quote,staffsize=26,verbatim]
144 Larger examples can be put into a separate file, and introduced with
145 @code{\lilypondfile}.
147 @lilypondfile[quote,noindent]{screech-boink.ly}
156 @cindex documents, adding music to
159 @node Integrating LaTeX and music
160 @section Integrating La@TeX{} and music
162 La@TeX{} is the de-facto standard for publishing layouts in the exact
163 sciences. It is built on top of the @TeX{} typesetting engine,
164 providing the best typography available anywhere.
167 @uref{http://@/www@/.ctan@/.org/@/tex@/-archive/@/info/@/lshort/@/english/,
168 @emph{The Not So Short Introduction to La@TeX{}}} for an overview on how
171 Music is entered using
174 \begin[options,go,here]@{lilypond@}
183 \lilypondfile[options,go,here]@{@var{filename}@}
190 \lilypond@{ YOUR LILYPOND CODE @}
193 Running @command{lilypond-book} yields a file that can be further
194 processed with La@TeX{}. Since @command{lilypond-book} produces
195 lilypond snippets as @code{\includegraphics@{NAME.eps@}}, you must
199 \usepackage@{graphics@}
206 \usepackage@{graphicx@}
210 to the preamble of the LaTeX document.
212 We show some examples here. The lilypond environment
215 \begin[quote,fragment,staffsize=26]@{lilypond@}
223 @lilypond[quote,fragment,staffsize=26]
230 \lilypond[quote,fragment,staffsize=11]@{<c' e' g'>@}
236 @lilypond[quote,fragment,staffsize=11]{<c' e' g'>}
239 Currently, you cannot include @code{@{} or @code{@}} within
240 @code{\lilypond@{@}}, so this command is only useful with the
241 @code{fragment} option.
243 The default linewidth of the music will be adjusted by examining the
244 commands in the document preamble, the part of the document before
245 @code{\begin@{document@}}. The @command{lilypond-book} command sends
246 these to La@TeX{} to find out how wide the text is. The line width for
247 the music fragments is then adjusted to the text width. Note that this
248 heuristic algorithm can fail easily; in such cases it is necessary to
249 use the @code{linewidth} music fragment option.
251 @cindex titling and lilypond-book
252 @cindex @code{\header} in La@TeX{} documents
254 Each snippet will call the following macros if they have been defined by
257 @code{\preLilyPondExample} called before the music
259 @code{\postLilyPondExample} called after the music
261 @code{\betweenLilyPondSystem[1]} is called between systems if
262 @code{lilypond-book} has split the snippet into several postscript
263 files. It must be defined as taking one parameter and will be
264 passed the number of files already included in this snippet.
270 @cindex Latex, feta symbols
273 To include feta symbols (such as flat, segno, etc) in a LaTeX
274 document, use @code{\input@{titledefs@}}
277 \documentclass[a4paper]@{article@}
288 The font symbol names are defined in the file feta20.tex; to find
289 the location of this file, use the command
297 @cindex outline fonts
300 @cindex invoking dvips
302 For printing the La@TeX{} document you need a DVI to PostScript
303 translator like @command{dvips}. To use @command{dvips} to produce
304 a PostScript file, add the following options to the @command{dvips}
308 -o -Ppdf -h @var{file}.psfonts
312 where the @var{file}@command{psfonts} file is obtained from
313 @command{lilypond-book}, @xref{Invoking lilypond-book} for details. PDF
314 can then be produced with a PostScript to PDF translator like
315 @code{ps2pdf} (which is part of GhostScript). Running @command{dvips}
316 will produce some warnings about fonts; these are harmless and may
319 @cindex international characters
323 @node Integrating Texinfo and music
324 @section Integrating Texinfo and music
326 Texinfo is the standard format for documentation of the GNU project. An
327 example of a Texinfo document is this manual. The HTML, PDF, and Info
328 versions of the manual are made from the Texinfo document.
330 In the input file, music is specified with
333 @@lilypond[options,go,here]
342 @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
349 @@lilypondfile[options,go,here]@{@var{filename}@}
352 When @command{lilypond-book} is run on it, this results in a Texinfo
353 file (with extension @file{.texi}) containing @code{@@image} tags for
354 HTML and info output. For the printed edition, the raw @TeX{} output of
355 LilyPond is included in the main document.
357 We show two simple examples here. A @code{lilypond} environment
375 @@lilypond[fragment,staffsize=11]@{<c' e' g'>@}
381 @lilypond[fragment,staffsize=11]{<c' e' g'>}
383 Contrary to La@TeX{}, @code{@@lilypond@{...@}} does not generate an
384 in-line image. It always gets a paragraph of its own.
386 When using the Texinfo output format, @command{lilypond-book} also
387 generates bitmaps of the music (in PNG format), so you can make an HTML
388 document with embedded music.
391 @node Integrating HTML and music
392 @section Integrating HTML and music
394 Music is entered using
397 <lilypond fragment relative=2>
398 \key c \minor c4 es g2
403 @command{lilypond-book} then produces an HTML file with appropriate image
404 tags for the music fragments:
406 @lilypond[fragment,relative=2]
407 \key c \minor c4 es g2
410 For inline pictures, use @code{<lilypond ... />}, where the options
411 are separated by a colon from the music, for example
414 Some music in <lilypond relative=2: a b c/> a line of text.
417 To include separate files, say
420 <lilypondfile @var{option1} @var{option2} ...>@var{filename}</lilypondfile>
423 @cindex titling in HTML
424 @cindex preview image
428 @node Music fragment options
429 @section Music fragment options
431 In the following, a ``LilyPond command'' refers to any command described
432 in the previous sections which is handled by @command{lilypond-book} to
433 produce a music snippet. For simplicity, LilyPond commands are only
434 shown in La@TeX{} syntax.
436 Note that the option string is parsed from left to right; if an option
437 occurs multiple times, the last one is taken.
439 The following options are available for LilyPond commands:
442 @item staffsize=@var{ht}
443 Set staff size to @var{ht}, which is measured in points.
446 Produce ragged-right lines with natural spacing (i.e., @code{raggedright
447 = ##t} is added to the LilyPond snippet). This is the default for the
448 @code{\lilypond@{@}} command if no @code{linewidth} option is present.
449 It is also the default for the @code{lilypond} environment if the
450 @code{fragment} option is set, and no line width is explicitly
454 Produce lines with packed spacing (i.e., @code{packed = ##t} is added
455 to the LilyPond snippet).
458 @itemx linewidth=@var{size}\@var{unit}
459 Set line width to @var{size}, using @var{unit} as units. @var{unit} is
460 one of the following strings: @code{cm}, @code{mm}, @code{in}, or
461 @code{pt}. This option affects LilyPond output (this is, the staff
462 length of the music snippet), not the text layout.
464 If used without an argument, set line width to a default value (as
465 computed with a heuristic algorithm).
467 If no @code{linewidth} option is given, @command{lilypond-book} tries to
468 guess a default for @code{lilypond} environments which don't use the
469 @code{raggedright} option.
472 Do not print the time signature, and turns off the timing (key signature,
473 bar lines) in the score.
476 Make @command{lilypond-book} add some boilerplate code so that you can
484 without @code{\layout}, @code{\score}, etc.
487 Don't add additional code to complete LilyPond code in music snippets.
488 Since this is the default, @code{nofragment} is redundant normally.
490 @item indent=@var{size}\@var{unit}
491 Set indentation of the first music system to @var{size}, using
492 @var{unit} as units. @var{unit} is one of the following strings:
493 @code{cm}, @code{mm}, @code{in}, or @code{pt}. This option affects
494 LilyPond, not the text layout.
497 Set indentation of the first music system to zero. This option affects
498 LilyPond, not the text layout. Since no indentation is the default,
499 @code{noindent} is redundant normally.
502 Reduce line length of a music snippet by @math{2*0.4}@dmn{in} and put
503 the output into a quotation block. The value `0.4@dmn{in}' can be
504 controlled with the @code{exampleindent} option.
507 Set the amount by which the @code{quote} option indents a music snippet.
510 @itemx relative=@var{n}
511 Use relative octave mode. By default, notes are specified relative to
512 middle@tie{}C. The optional integer argument specifies the octave of
513 the starting note, where the default @code{1} is middle C.
516 LilyPond also uses @command{lilypond-book} to produce its own
517 documentation. To do that, some more obscure music fragment options are
522 The argument of a LilyPond command is copied to the output file and
523 enclosed in a verbatim block, followed by any text given with the
524 @code{intertext} option (not implemented yet); then the actual music is
525 displayed. This option does not work well with @code{\lilypond@{@}} if
526 it is part of a paragraph.
529 (Only for Texinfo output.) If @command{lilypond} is called with the
530 @option{--header=@/texidoc} option, and the file to be processed is
531 called @file{foo@/.ly}, it creates a file @file{foo@/.texidoc} if there
532 is a @code{texidoc} field in the @code{\header}. The @code{texidoc}
533 option makes @command{lilypond-book} include such files, adding its
534 contents as a documentation block right before the music snippet.
536 Assuming the file @file{foo@/.ly} contains
540 texidoc = "This file demonstrates a single note."
546 and we have this in our Texinfo document @file{test.texinfo}
549 @@lilypondfile[texidoc]@{foo.ly@}
553 the following command line gives the expected result
556 lilypond-book --process="lilypond --format=tex --tex \
557 --header=texidoc test.texinfo
560 Most LilyPond test documents (in the @file{input} directory of the
561 distribution) are small @file{.ly} files which look exactly like this.
564 If a LilyPond input file is included with @code{\lilypondfile}, print
565 the file name right before the music snippet. For HTML output, this is
569 This option includes fonts in all of the generated EPS-files for this
570 snippet. This should be used if the snippet uses any font that LaTeX
571 cannot find on its own.
576 @node Invoking lilypond-book
577 @section Invoking @command{lilypond-book}
579 @command{lilypond-book} produces a file with one of the following
580 extensions: @file{.tex}, @file{.texi}, or @file{.html}, depending on the
581 output format. Both @file{.tex} and @file{.texi} files need further
584 @command{lilypond-book} can also create a PSFONTS file, which is required
585 by @command{dvips} to produce Postscript and PDF files. You can call
586 this file whatever you want as long as you refer to the same file when
587 you call @command{dvips}.
589 To produce PDF output from the lilypond-book file (here called
590 @code{yourfile.lytex}), you should do
593 lilypond-book --psfonts yourfile.lytex
595 dvips -o -h yourfile.psfonts -Ppdf yourfile.dvi
599 To produce a Texinfo document (in any output format), follow the normal
600 procedures for Texinfo (this is, either call @command{texi2dvi} or
601 @command{makeinfo}, depending on the output format you want to
604 @xref{Format with texi2dvi, , , texinfo, GNU Texinfo}, and @ref{Creating
605 an Info File, , , texinfo, GNU Texinfo}.
608 See the documentation of Texinfo for further details.
612 @command{lilypond-book} accepts the following command line options:
615 @item -f @var{format}
616 @itemx --format=@var{format}
617 Specify the document type to process: @code{html}, @code{latex}, or
618 @code{texi} (the default). If this option is missing,
619 @command{lilypond-book} tries to detect the format automatically.
621 The @code{texi} document type produces a Texinfo file with music
622 fragments in the DVI output only. For getting images in the HTML
623 version, the format @code{texi-html} must be used instead.
625 [Note: Currently, @code{texi} is the same as @code{texi-html}.]
627 @item -F @var{filter}
628 @itemx --filter=@var{filter}
629 Pipe snippets through @var{filter}. @code{lilypond-book} will
630 not --filter and --process at the same time.
634 lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely
639 Print a short help message.
642 @itemx --include=@var{dir}
643 Add @var{dir} to the include path.
646 @itemx --output=@var{dir}
647 Place generated files in directory @var{dir}. Running
648 @command{lilypond-book} generates lots of small files that LilyPond will
649 process. To avoid all that garbage in the source directory use the
650 @option{--output} command line option, and change to that directory
651 before running @command{latex} or @command{makeinfo}:
654 lilypond-book --output=out yourfile.lytex
659 @item -P @var{process}
660 @itemx --process=@var{command}
661 Process LilyPond snippets using @var{command}. The default command is
662 @code{lilypond}. @code{lilypond-book} will not --filter and --process
666 extract all PostScript fonts into @file{@var{file}.psfonts} for dvips.
667 This is necessary for @command{dvips -h @var{file}.psfonts}.
675 Print version information.
680 The Texinfo command @code{@@pagesizes} is not interpreted. Similarly,
681 La@TeX{} commands that change margins and line widths after the preamble
684 Only the first @code{\score} of a LilyPond block is processed.
687 @node Filename extensions
688 @section Filename extensions
690 You can use any filename extension for the input file, but if you do not
691 use the recommended extension for a particular format you may need to
692 manually specify the output format. @xref{Invoking lilypond-book}, for
693 details. Otherwise, @command{lilypond-book} automatically selects the
694 output format based on the input filename's extension.
697 @multitable @columnfractions .2 .5
698 @item @strong{extension} @tab @strong{output format}
700 @item @file{.html} @tab HTML
701 @item @file{.itely} @tab Texinfo
702 @item @file{.latex} @tab La@TeX{}
703 @item @file{.lytex} @tab La@TeX{}
704 @item @file{.tely} @tab Texinfo
705 @item @file{.tex} @tab La@TeX{}
706 @item @file{.texi} @tab Texinfo
707 @item @file{.texinfo} @tab Texinfo
708 @item @file{.xml} @tab HTML