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}
67 Documents for @command{lilypond-book} may freely mix music and text.
72 c2 g'2 \times 2/3 { f8 e d } c'2 g4
76 Options are put in brackets.
78 \begin[fragment,quote,staffsize=26,verbatim]{lilypond}
82 Larger examples can be put into a separate file, and introduced with
85 \lilypondfile[quote,noindent]{screech-boink.ly}
91 Under Unix, you can view the results as follows
96 lilypond-book --output=out lilybook.tex
97 @emph{lilypond-book (GNU LilyPond) 2.5.0}
98 @emph{Reading lilybook.tex...}
99 @emph{..lots of stuff deleted..}
100 @emph{Compiling out/lilybook.tex...}
103 @emph{lots of stuff deleted}
107 To convert the file into a PDF document, run the following commands
110 dvips -Ppdf -u+lilypond -u+ec-mftrace lilybook
114 Running @command{lilypond-book} and @command{latex} creates a lot of
115 temporary files, which would clutter up the working directory. To
116 remedy this, use the @code{--output=@var{dir}} option. It will create
117 the files in a separate subdirectory @file{dir}.
119 Finally the result of the La@TeX{} example shown above.@footnote{This
120 tutorial is processed with Texinfo, so the example gives slightly
121 different results in layout.} This finishes the tutorial section.
125 Documents for @command{lilypond-book} may freely mix music and text.
130 c2 g'2 \times 2/3 { f8 e d } c'2 g4
134 Options are put in brackets.
136 @lilypond[fragment,quote,staffsize=26,verbatim]
140 Larger examples can be put into a separate file, and introduced with
141 @code{\lilypondfile}.
143 @lilypondfile[quote,noindent]{screech-boink.ly}
152 @cindex documents, adding music to
155 @node Integrating LaTeX and music
156 @section Integrating La@TeX{} and music
158 La@TeX{} is the de-facto standard for publishing layouts in the exact
159 sciences. It is built on top of the @TeX{} typesetting engine,
160 providing the best typography available anywhere.
163 @uref{http://@/www@/.ctan@/.org/@/tex@/-archive/@/info/@/lshort/@/english/,
164 @emph{The Not So Short Introduction to La@TeX{}}} for an overview on how
167 Music is entered using
170 \begin[options,go,here]@{lilypond@}
179 \lilypondfile[options,go,here]@{@var{filename}@}
186 \lilypond@{ YOUR LILYPOND CODE @}
189 Running @command{lilypond-book} yields a file that can be further
190 processed with La@TeX{}.
192 We show some examples here. The lilypond environment
195 \begin[quote,fragment,staffsize=26]@{lilypond@}
203 @lilypond[quote,fragment,staffsize=26]
210 \lilypond[quote,fragment,staffsize=11]@{<c' e' g'>@}
216 @lilypond[quote,fragment,staffsize=11]{<c' e' g'>}
219 Currently, you cannot include @code{@{} or @code{@}} within
220 @code{\lilypond@{@}}, so this command is only useful with the
221 @code{fragment} option.
223 The default linewidth of the music will be adjusted by examining the
224 commands in the document preamble, the part of the document before
225 @code{\begin@{document@}}. The @command{lilypond-book} command sends
226 these to La@TeX{} to find out how wide the text is. The line width for
227 the music fragments is then adjusted to the text width. Note that this
228 heuristic algorithm can fail easily; in such cases it is necessary to
229 use the @code{linewidth} music fragment option.
231 @cindex titling and lilypond-book
232 @cindex @code{\header} in La@TeX{} documents
234 Each snippet calls @code{\preLilyPondExample} before and
235 @code{\postLilyPondExample} after the music if those macros have been
238 @cindex Latex, feta symbols
241 To include feta symbols (such as flat, segno, etc) in a LaTeX
242 document, use @code{\input@{titledefs@}}
245 \documentclass[a4paper]@{article@}
256 The font symbol names are defined in the file feta20.tex; to find
257 the location of this file, use the command
263 @cindex outline fonts
266 @cindex invoking dvips
268 For printing the La@TeX{} document you need a DVI to PostScript
269 translator like @command{dvips}. To use @command{dvips} to produce
270 a PostScript file, add the following options to the @command{dvips}
274 -Ppdf -u+lilypond.map -u+ec-mftrace.map
278 PDF can then be produced with a PostScript to PDF translator like
279 @code{ps2pdf} (which is part of GhostScript).
281 @cindex international characters
285 [THE FOLLOWING IS OUT OF DATE. ]
287 LilyPond does not use the La@TeX{} font handling scheme for lyrics and
288 text markups; it uses the EC font family and has limited support for
289 selecting an input encoding with the @code{\encoding} keyword if the
290 output is directly processed (these limitations primarily affect
291 LilyPond's native PostScript output). With @command{lilypond-book}, the
292 encoding issues are completely handled by the document which includes
293 LilyPond snippets; @command{lilypond} outputs all text strings without
294 modification. The drawback is that LilyPond always applies the EC font
295 metrics to those strings for computing the locations within the music
296 snippets; this often causes unpleasant horizontal (and vertical) shifts.
297 With other words, support for encodings other than @w{latin-1} is
298 possible but usually yields badly positioned text. Future versions of
299 LilyPond will fix this.
301 Since @w{latin-1} is the default encoding for LilyPond markup and lyrics
302 it is not necessary to explicitly add @code{\encoding "latin1"} to
303 LilyPond snippets. You might also consider the use of @code{\encoding
304 "TeX"} instead which basically makes LilyPond skip @TeX{} commands
305 (starting with a backslash) and braces in text strings -- it is not
306 recommended, though, since LilyPond gives only a rough approximation to
307 the real string length.
309 As a corrolary of the last paragraphs the following two lines should be
310 present in the La@TeX{} document preamble
315 \usepackage[latin1]@{inputenc@}
316 \usepackage[T1]@{fontenc@}
320 and real @w{latin-1} characters should be used in LilyPond snippets; for
321 example, use @code{ß}, not @code{\ss}.
324 @node Integrating Texinfo and music
325 @section Integrating Texinfo and music
327 Texinfo is the standard format for documentation of the GNU project. An
328 example of a Texinfo document is this manual. The HTML, PDF, and Info
329 versions of the manual are made from the Texinfo document.
331 In the input file, music is specified with
334 @@lilypond[options,go,here]
343 @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
350 @@lilypondfile[options,go,here]@{@var{filename}@}
353 When @command{lilypond-book} is run on it, this results in a Texinfo
354 file (with extension @file{.texi}) containing @code{@@image} tags for
355 HTML and info output. For the printed edition, the raw @TeX{} output of
356 LilyPond is included in the main document.
358 We show two simple examples here. A @code{lilypond} environment
376 @@lilypond[fragment,staffsize=11]@{<c' e' g'>@}
382 @lilypond[fragment,staffsize=11]{<c' e' g'>}
384 Contrary to La@TeX{}, @code{@@lilypond@{...@}} does not generate an
385 in-line image. It always gets a paragraph of its own.
387 When using the Texinfo output format, @command{lilypond-book} also
388 generates bitmaps of the music (in PNG format), so you can make an HTML
389 document with embedded music.
392 @node Integrating HTML and music
393 @section Integrating HTML and music
395 Music is entered using
398 <lilypond fragment relative=2>
399 \key c \minor c4 es g2
404 @command{lilypond-book} then produces an HTML file with appropriate image
405 tags for the music fragments:
407 @lilypond[fragment,relative=2]
408 \key c \minor c4 es g2
411 For inline pictures, use @code{<lilypond ... />}, where the options
412 are separated by a colon from the music, for example
415 Some music in <lilypond relative=2: a b c/> a line of text.
418 To include separate files, say
421 <lilypondfile @var{option1} @var{option2} ...>@var{filename}</lilypondfile>
424 @cindex titling in HTML
425 @cindex preview image
429 @node Music fragment options
430 @section Music fragment options
432 In the following, a ``LilyPond command'' refers to any command described
433 in the previous sections which is handled by @command{lilypond-book} to
434 produce a music snippet. For simplicity, LilyPond commands are only
435 shown in La@TeX{} syntax.
437 Note that the option string is parsed from left to right; if an option
438 occurs multiple times, the last one is taken.
440 The following options are available for LilyPond commands:
443 @item staffsize=@var{ht}
444 Set staff size to @var{ht}, which is measured in points.
447 Produce ragged-right lines with natural spacing (i.e., @code{raggedright
448 = ##t} is added to the LilyPond snippet). This is the default for the
449 @code{\lilypond@{@}} command if no @code{linewidth} option is present.
450 It is also the default for the @code{lilypond} environment if the
451 @code{fragment} option is set, and no line width is explicitly
455 @itemx linewidth=@var{size}\@var{unit}
456 Set line width to @var{size}, using @var{unit} as units. @var{unit} is
457 one of the following strings: @code{cm}, @code{mm}, @code{in}, or
458 @code{pt}. This option affects LilyPond output (this is, the staff
459 length of the music snippet), not the text layout.
461 If used without an argument, set line width to a default value (as
462 computed with a heuristic algorithm).
464 If no @code{linewidth} option is given, @command{lilypond-book} tries to
465 guess a default for @code{lilypond} environments which don't use the
466 @code{raggedright} option.
469 Do not print the time signature.
472 Make @command{lilypond-book} add some boilerplate code so that you can
480 without @code{\layout}, @code{\score}, etc.
483 Don't add additional code to complete LilyPond code in music snippets.
484 Since this is the default, @code{nofragment} is redundant normally.
486 @item indent=@var{size}\@var{unit}
487 Set indentation of the first music system to @var{size}, using
488 @var{unit} as units. @var{unit} is one of the following strings:
489 @code{cm}, @code{mm}, @code{in}, or @code{pt}. This option affects
490 LilyPond, not the text layout.
493 Set indentation of the first music system to zero. This option affects
494 LilyPond, not the text layout. Since no indentation is the default,
495 @code{noindent} is redundant normally.
498 Reduce line length of a music snippet by @math{2*0.4}@dmn{in} and put
499 the output into a quotation block. The value `0.4@dmn{in}' can be
500 controlled with the @code{exampleindent} option.
503 Set the amount by which the @code{quote} option indents a music snippet.
506 @itemx relative=@var{n}
507 Use relative octave mode. By default, notes are specified relative to
508 middle@tie{}C. The optional integer argument specifies the octave of
509 the starting note, where the default @code{1} is middle C.
512 LilyPond also uses @command{lilypond-book} to produce its own
513 documentation. To do that, some more obscure music fragment options are
518 The argument of a LilyPond command is copied to the output file and
519 enclosed in a verbatim block, followed by any text given with the
520 @code{intertext} option (not implemented yet); then the actual music is
521 displayed. This option does not work well with @code{\lilypond@{@}} if
522 it is part of a paragraph.
525 (Only for Texinfo output.) If @command{lilypond} is called with the
526 @option{--header=@/texidoc} option, and the file to be processed is
527 called @file{foo@/.ly}, it creates a file @file{foo@/.texidoc} if there
528 is a @code{texidoc} field in the @code{\header}. The @code{texidoc}
529 option makes @command{lilypond-book} include such files, adding its
530 contents as a documentation block right before the music snippet.
532 Assuming the file @file{foo@/.ly} contains
536 texidoc = "This file demonstrates a single note."
542 and we have this in our Texinfo document @file{test.texinfo}
545 @@lilypondfile[texidoc]@{foo.ly@}
549 the following command line gives the expected result
552 lilypond-book --process="lilypond --format=tex --tex \
553 --header=texidoc test.texinfo
556 Most LilyPond test documents (in the @file{input} directory of the
557 distribution) are small @file{.ly} files which look exactly like this.
560 If a LilyPond input file is included with @code{\lilypondfile}, print
561 the file name right before the music snippet. For HTML output, this is
566 @node Invoking lilypond-book
567 @section Invoking @command{lilypond-book}
569 @command{lilypond-book} produces a file with one of the following
570 extensions: @file{.tex}, @file{.texi}, or @file{.html}, depending on the
571 output format. Both @file{.tex} and @file{.texi} files need further
574 To produce PDF output from the @file{.tex} file, you should do
578 dvips -Ppdf -u+ec-mftrace.map -u+lilypond.map yourfile.dvi
582 To produce a Texinfo document (in any output format), follow the normal
583 procedures for Texinfo (this is, either call @command{texi2dvi} or
584 @command{makeinfo}, depending on the output format you want to create).
585 @xref{Format with texi2dvi, , , texinfo, GNU Texinfo}, and @ref{Creating
586 an Info File, , , texinfo, GNU Texinfo}.
588 @command{lilypond-book} accepts the following command line options:
591 @item -f @var{format}
592 @itemx --format=@var{format}
593 Specify the document type to process: @code{html}, @code{latex}, or
594 @code{texi} (the default). If this option is missing,
595 @command{lilypond-book} tries to detect the format automatically.
597 The @code{texi} document type produces a Texinfo file with music
598 fragments in the DVI output only. For getting images in the HTML
599 version, the format @code{texi-html} must be used instead.
601 [Note: Currently, @code{texi} is the same as @code{texi-html}.]
603 @item -F @var{filter}
604 @itemx --filter=@var{filter}
605 Pipe snippets through @var{filter}.
609 lilypond-book --filter='convert-ly --from=2.0.0' my-book.tely
614 Print a short help message.
617 @itemx --include=@var{dir}
618 Add @var{dir} to the include path.
621 @itemx --output=@var{dir}
622 Place generated files in directory @var{dir}. Running
623 @command{lilypond-book} generates lots of small files that LilyPond will
624 process. To avoid all that garbage in the source directory use the
625 @option{--output} command line option, and change to that directory
626 before running @command{latex} or @command{makeinfo}:
629 lilypond-book --output=out yourfile.lytex
634 @item -P @var{process}
635 @itemx --process=@var{command}
636 Process LilyPond snippets using @var{command}. The default command is
645 Print version information.
650 The Texinfo command @code{@@pagesizes} is not interpreted. Similarly,
651 La@TeX{} commands that change margins and line widths after the preamble
654 Only the first @code{\score} of a LilyPond block is processed.
657 The size of a music block is limited to 1.5 KB, due to technical
658 problems with the Python regular expression engine. For longer files,
659 use @code{\lilypondfile}.
662 @node Filename extensions
663 @section Filename extensions
665 You can use any filename extension for the input file, but if you do not
666 use the recommended extension for a particular format you may need to
667 manually specify the output format. @xref{Invoking lilypond-book}, for
668 details. Otherwise, @command{lilypond-book} automatically selects the
669 output format based on the input filename's extension.
672 @multitable @columnfractions .2 .5
673 @item @strong{extension} @tab @strong{output format}
675 @item @file{.html} @tab HTML
676 @item @file{.itely} @tab Texinfo
677 @item @file{.latex} @tab La@TeX{}
678 @item @file{.lytex} @tab La@TeX{}
679 @item @file{.tely} @tab Texinfo
680 @item @file{.tex} @tab La@TeX{}
681 @item @file{.texi} @tab Texinfo
682 @item @file{.texinfo} @tab Texinfo
683 @item @file{.xml} @tab HTML