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 --psfonts=psfonts lilybook.tex
97 @emph{lilypond-book (GNU LilyPond) 2.6.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 -h psfonts 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 will call the following macros if they have been defined by
237 @code{\preLilyPondExample} called before the music
239 @code{\postLilyPondExample} called after the music
241 @code{\betweenLilyPondSystem[1]} is called between systems if
242 @code{lilypond-book} has split the snippet into several postscript
243 files. It must be defined as taking one parameter and will be
244 passed the number of files already included in this snippet.
245 @cindex Latex, feta symbols
248 To include feta symbols (such as flat, segno, etc) in a LaTeX
249 document, use @code{\input@{titledefs@}}
252 \documentclass[a4paper]@{article@}
263 The font symbol names are defined in the file feta20.tex; to find
264 the location of this file, use the command
270 @cindex outline fonts
273 @cindex invoking dvips
275 For printing the La@TeX{} document you need a DVI to PostScript
276 translator like @command{dvips}. To use @command{dvips} to produce
277 a PostScript file, add the following options to the @command{dvips}
285 where the @command{psfonts} file is obtained from
286 @command{lilypond-book}, @xref{Invoking lilypond-book} for details. PDF
287 can then be produced with a PostScript to PDF translator like
288 @code{ps2pdf} (which is part of GhostScript).
290 @cindex international characters
294 @node Integrating Texinfo and music
295 @section Integrating Texinfo and music
297 Texinfo is the standard format for documentation of the GNU project. An
298 example of a Texinfo document is this manual. The HTML, PDF, and Info
299 versions of the manual are made from the Texinfo document.
301 In the input file, music is specified with
304 @@lilypond[options,go,here]
313 @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
320 @@lilypondfile[options,go,here]@{@var{filename}@}
323 When @command{lilypond-book} is run on it, this results in a Texinfo
324 file (with extension @file{.texi}) containing @code{@@image} tags for
325 HTML and info output. For the printed edition, the raw @TeX{} output of
326 LilyPond is included in the main document.
328 We show two simple examples here. A @code{lilypond} environment
346 @@lilypond[fragment,staffsize=11]@{<c' e' g'>@}
352 @lilypond[fragment,staffsize=11]{<c' e' g'>}
354 Contrary to La@TeX{}, @code{@@lilypond@{...@}} does not generate an
355 in-line image. It always gets a paragraph of its own.
357 When using the Texinfo output format, @command{lilypond-book} also
358 generates bitmaps of the music (in PNG format), so you can make an HTML
359 document with embedded music.
362 @node Integrating HTML and music
363 @section Integrating HTML and music
365 Music is entered using
368 <lilypond fragment relative=2>
369 \key c \minor c4 es g2
374 @command{lilypond-book} then produces an HTML file with appropriate image
375 tags for the music fragments:
377 @lilypond[fragment,relative=2]
378 \key c \minor c4 es g2
381 For inline pictures, use @code{<lilypond ... />}, where the options
382 are separated by a colon from the music, for example
385 Some music in <lilypond relative=2: a b c/> a line of text.
388 To include separate files, say
391 <lilypondfile @var{option1} @var{option2} ...>@var{filename}</lilypondfile>
394 @cindex titling in HTML
395 @cindex preview image
399 @node Music fragment options
400 @section Music fragment options
402 In the following, a ``LilyPond command'' refers to any command described
403 in the previous sections which is handled by @command{lilypond-book} to
404 produce a music snippet. For simplicity, LilyPond commands are only
405 shown in La@TeX{} syntax.
407 Note that the option string is parsed from left to right; if an option
408 occurs multiple times, the last one is taken.
410 The following options are available for LilyPond commands:
413 @item staffsize=@var{ht}
414 Set staff size to @var{ht}, which is measured in points.
417 Produce ragged-right lines with natural spacing (i.e., @code{raggedright
418 = ##t} is added to the LilyPond snippet). This is the default for the
419 @code{\lilypond@{@}} command if no @code{linewidth} option is present.
420 It is also the default for the @code{lilypond} environment if the
421 @code{fragment} option is set, and no line width is explicitly
425 Produce lines with packed spacing (i.e., @code{packed = ##t} is added
426 to the LilyPond snippet).
429 @itemx linewidth=@var{size}\@var{unit}
430 Set line width to @var{size}, using @var{unit} as units. @var{unit} is
431 one of the following strings: @code{cm}, @code{mm}, @code{in}, or
432 @code{pt}. This option affects LilyPond output (this is, the staff
433 length of the music snippet), not the text layout.
435 If used without an argument, set line width to a default value (as
436 computed with a heuristic algorithm).
438 If no @code{linewidth} option is given, @command{lilypond-book} tries to
439 guess a default for @code{lilypond} environments which don't use the
440 @code{raggedright} option.
443 Do not print the time signature.
446 Make @command{lilypond-book} add some boilerplate code so that you can
454 without @code{\layout}, @code{\score}, etc.
457 Don't add additional code to complete LilyPond code in music snippets.
458 Since this is the default, @code{nofragment} is redundant normally.
460 @item indent=@var{size}\@var{unit}
461 Set indentation of the first music system to @var{size}, using
462 @var{unit} as units. @var{unit} is one of the following strings:
463 @code{cm}, @code{mm}, @code{in}, or @code{pt}. This option affects
464 LilyPond, not the text layout.
467 Set indentation of the first music system to zero. This option affects
468 LilyPond, not the text layout. Since no indentation is the default,
469 @code{noindent} is redundant normally.
472 Reduce line length of a music snippet by @math{2*0.4}@dmn{in} and put
473 the output into a quotation block. The value `0.4@dmn{in}' can be
474 controlled with the @code{exampleindent} option.
477 Set the amount by which the @code{quote} option indents a music snippet.
480 @itemx relative=@var{n}
481 Use relative octave mode. By default, notes are specified relative to
482 middle@tie{}C. The optional integer argument specifies the octave of
483 the starting note, where the default @code{1} is middle C.
486 LilyPond also uses @command{lilypond-book} to produce its own
487 documentation. To do that, some more obscure music fragment options are
492 The argument of a LilyPond command is copied to the output file and
493 enclosed in a verbatim block, followed by any text given with the
494 @code{intertext} option (not implemented yet); then the actual music is
495 displayed. This option does not work well with @code{\lilypond@{@}} if
496 it is part of a paragraph.
499 (Only for Texinfo output.) If @command{lilypond} is called with the
500 @option{--header=@/texidoc} option, and the file to be processed is
501 called @file{foo@/.ly}, it creates a file @file{foo@/.texidoc} if there
502 is a @code{texidoc} field in the @code{\header}. The @code{texidoc}
503 option makes @command{lilypond-book} include such files, adding its
504 contents as a documentation block right before the music snippet.
506 Assuming the file @file{foo@/.ly} contains
510 texidoc = "This file demonstrates a single note."
516 and we have this in our Texinfo document @file{test.texinfo}
519 @@lilypondfile[texidoc]@{foo.ly@}
523 the following command line gives the expected result
526 lilypond-book --process="lilypond --format=tex --tex \
527 --header=texidoc test.texinfo
530 Most LilyPond test documents (in the @file{input} directory of the
531 distribution) are small @file{.ly} files which look exactly like this.
534 If a LilyPond input file is included with @code{\lilypondfile}, print
535 the file name right before the music snippet. For HTML output, this is
539 This option includes fonts in all of the generated EPS-files for this
540 snippet. This should be used if the snippet uses any font that LaTeX
541 cannot find on its own.
546 @node Invoking lilypond-book
547 @section Invoking @command{lilypond-book}
549 @command{lilypond-book} produces a file with one of the following
550 extensions: @file{.tex}, @file{.texi}, or @file{.html}, depending on the
551 output format. Both @file{.tex} and @file{.texi} files need further
554 @command{lilypond-book} can also create a PSFONTS file, which is required
555 by @command{dvips} to produce Postscript and PDF files. You can call
556 this file whatever you want as long as you refer to the same file when
557 you call @command{dvips}.
559 To produce PDF output from the lilypond-book file (here called
560 @code{yourfile.lytex}), you should do
563 lilypond-book --psfonts=tempfonts.ps yourfile.lytex
565 dvips -h tempfonts.ps -Ppdf yourfile.dvi
569 To produce a Texinfo document (in any output format), follow the normal
570 procedures for Texinfo (this is, either call @command{texi2dvi} or
571 @command{makeinfo}, depending on the output format you want to
574 @xref{Format with texi2dvi, , , texinfo, GNU Texinfo}, and @ref{Creating
575 an Info File, , , texinfo, GNU Texinfo}.
578 See the documentation of Texinfo for further details.
582 @command{lilypond-book} accepts the following command line options:
585 @item -f @var{format}
586 @itemx --format=@var{format}
587 Specify the document type to process: @code{html}, @code{latex}, or
588 @code{texi} (the default). If this option is missing,
589 @command{lilypond-book} tries to detect the format automatically.
591 The @code{texi} document type produces a Texinfo file with music
592 fragments in the DVI output only. For getting images in the HTML
593 version, the format @code{texi-html} must be used instead.
595 [Note: Currently, @code{texi} is the same as @code{texi-html}.]
597 @item -F @var{filter}
598 @itemx --filter=@var{filter}
599 Pipe snippets through @var{filter}. @code{lilypond-book} will
600 not --filter and --process at the same time.
604 lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely
609 Print a short help message.
612 @itemx --include=@var{dir}
613 Add @var{dir} to the include path.
616 @itemx --output=@var{dir}
617 Place generated files in directory @var{dir}. Running
618 @command{lilypond-book} generates lots of small files that LilyPond will
619 process. To avoid all that garbage in the source directory use the
620 @option{--output} command line option, and change to that directory
621 before running @command{latex} or @command{makeinfo}:
624 lilypond-book --output=out yourfile.lytex
629 @item -P @var{process}
630 @itemx --process=@var{command}
631 Process LilyPond snippets using @var{command}. The default command is
632 @code{lilypond}. @code{lilypond-book} will not --filter and --process
635 @itemx --psfonts=FILE
636 extract all PostScript fonts into FILE for LaTeX. This is necessary
637 for @command{dvips -h FILE}.
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