1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: f77212d801fa4603bf596a19cecf5a068f1d9d85
6 When revising a translation, copy the HEAD committish of the
7 version that you are working on. For details, see the Contributors'
8 Guide, node Updating translation committishes..
13 @c Note: keep this node named so that `info lilypond-book' brings you here.
15 @chapter A @command{lilypond-book} használata
16 @translationof lilypond-book
18 Amennyiben egy dokumentumba kottapéldákat szeretnénk beszúrni, megtehetjük,
19 hogy azok képeit egyesével létrehozzuk a LilyPond segítségével PostScript
20 vagy PNG formátumban, és mint bármilyen más képeket, beillesztjük azokat egy
21 @LaTeX{} vagy HTML dokumentumba.
23 A @command{lilypond-book} ennek a folyamatnak az automatizálására szolgál:
24 ez a program kiszedi a LilyPond kódrészleteket egy dokumentumból, lefordítja
25 őket a @command{lilypond} segítségével, és az így kapott képeket beilleszti
26 az eredeti kódrészletek helyére. A kottakép méretei igazodnak a dokumentum
29 A @command{lilypond-book} egy különálló parancssori program; a parancssoros
30 programok futtatásának módját a @ref{Parancssori használat} írja le bővebben.
32 A @command{lilypond-book} jelenleg a @LaTeX{}, HTML, Texinfo és DocBook
33 formátumokat támogatja.
41 @cindex dokumentumok, kottapéldák
42 @cindex HTML, kottapéldák
43 @cindex Texinfo, kottapéldák
44 @cindex DocBook, kottapéldák
45 @cindex @LaTeX{}, kottapéldák
48 * Egy kottapéldákat tartalmazó dokumentum::
49 * Zene és szöveg integrációja::
50 * Kottapéldák paraméterei::
51 * A lilypond-book futtatása::
52 * Fájlkiterjesztések::
53 * lilypond-book sablonok::
54 * Közös tartalomjegyzék::
55 * További módszerek zene és szöveg kombinálására::
59 @node Egy kottapéldákat tartalmazó dokumentum
60 @section Egy kottapéldákat tartalmazó dokumentum
61 @translationof An example of a musicological document
64 Bizonyos dokumentumok kottapéldákat tartalmaznak. Ezek között vannak
65 zenetudományi értekezések, énekeskönyvek, vagy ehhez hasonló kézikönyvek.
66 Ezeket úgy is el lehet készíteni, hogy a szövegbe beillesztjük a kottaábrákat.
67 Azonban ahhoz, hogy ne kelljen minden egyes kottarészlet szedését külön
68 elvégezni, a HTML, @LaTeX{}, Texinfo és DocBook formátumú dokumentumok esetén
69 mód nyílik ennek automatizálására.
71 Egy @code{lilypond-book} nevű parancsfájl a LilyPond nyelvén írt
72 kódrészleteket szépen formázott kottapéldákká alakítja át. Íme egy rövid,
73 magyarázatokkal ellátott @LaTeX{} példa.
79 \documentclass[a4paper]{article}
83 A \verb+lilypond-book+ segítségével feldolgozott dokumentumok
84 kottapéldákat tartalmazhatnak. Például:
88 c2 e2 \times 2/3 { f8 a b } a2 e4
92 A beállításokat szögletes zárójelbe kell tenni:
94 \begin{lilypond}[fragment,quote,staffsize=26,verbatim]
98 A nagyobb kottapéldákat ki lehet emelni külön fájlba, majd beilleszteni
99 őket a \verb+\lilypondfile+ paranccsal:
101 \lilypondfile[quote,noindent]{screech-boink.ly}
107 @subheading Feldolgozás
109 A fenti dokumentumot egy @file{lilybook.lytex} nevű fájlba mentve futtassuk le
110 a következő parancsokat:
112 @c keep space after @version{} so TeX doesn't choke
114 lilypond-book --output=out --pdf lilybook.lytex
115 @emph{lilypond-book (GNU LilyPond) @version{} }
116 @emph{Reading lilybook.lytex...}
118 @emph{Compiling lilybook.tex...}
123 @emph{(az @command{xpdf} helyére értelemszerűen tetszőleges PDF-nézegető
127 A @command{lilypond-book} és a @command{latex} rengeteg ideiglenes fájlt
128 hoznak létre. Annak érdekében, hogy ezek külön alkönyvtárba kerüljenek, a
129 @code{--output=@var{alkönyvtár}} opciót kell megadni.
131 Lent látható a fenti @LaTeX{} példa kimenete.@footnote{Ezt a dokumentumot a
132 Texinfo generálta, így apró eltérések lehetnek.} Ezzel elsajátítottuk a
133 lilypond-book használatának alapjait.
139 A @command{lilypond-book} segítségével feldolgozott dokumentumok
140 kottapéldákat tartalmazhatnak. Például:
144 c2 e2 \times 2/3 { f8 a b } a2 e4
148 A beállításokat szögletes zárójelbe kell tenni:
150 @lilypond[fragment,quote,staffsize=26,verbatim]
154 A nagyobb kottapéldákat ki lehet emelni külön fájlba, majd beilleszteni
155 őket a @code{\lilypondfile} paranccsal:
157 @lilypondfile[quote,noindent]{screech-boink.ly}
162 @node Integrating music and text
163 @section Integrating music and text
165 Here we explain how to integrate LilyPond with various output formats.
177 @LaTeX{} is the de-facto standard for publishing layouts in the exact
178 sciences. It is built on top of the @TeX{} typesetting engine,
179 providing the best typography available anywhere.
182 @uref{http://@/www@/.ctan@/.org/@/tex@/-archive/@/info/@/lshort/@/english/,
183 @emph{The Not So Short Introduction to @LaTeX{}}} for an overview on how
186 Music is entered using
189 \begin@{lilypond@}[options,go,here]
198 \lilypondfile[options,go,here]@{@var{filename}@}
205 \lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
208 Additionally, @code{\lilypondversion} displays the current version
210 Running @command{lilypond-book} yields a file that can be further
211 processed with @LaTeX{}.
213 We show some examples here. The @code{lilypond} environment
216 \begin@{lilypond@}[quote,fragment,staffsize=26]
224 @lilypond[quote,fragment,staffsize=26]
231 \lilypond[quote,fragment,staffsize=11]@{<c' e' g'>@}
237 @lilypond[quote,fragment,staffsize=11]{<c' e' g'>}
240 Currently, you cannot include @code{@{} or @code{@}} within
241 @code{\lilypond@{@}}, so this command is only useful with the
242 @code{fragment} option.
244 The default line width of the music will be adjusted by examining the
245 commands in the document preamble, the part of the document before
246 @code{\begin@{document@}}. The @command{lilypond-book} command sends
247 these to @LaTeX{} to find out how wide the text is. The line width for
248 the music fragments is then adjusted to the text width. Note that this
249 heuristic algorithm can fail easily; in such cases it is necessary to
250 use the @code{line-width} music fragment option.
252 @cindex titling and lilypond-book
253 @cindex \header in @LaTeX{} documents
255 Each snippet will call the following macros if they have been defined by
259 @item @code{\preLilyPondExample} called before the music,
261 @item @code{\postLilyPondExample} called after the music,
263 @item @code{\betweenLilyPondSystem[1]} is called between systems if
264 @code{lilypond-book} has split the snippet into several PostScript
265 files. It must be defined as taking one parameter and will be
266 passed the number of files already included in this snippet.
267 The default is to simply insert a @code{\linebreak}.
273 @cindex Latex, feta symbols
276 To include feta symbols (such as flat, segno, etc) in a LaTeX
277 document, use @code{\input@{titledefs@}}
280 \documentclass[a4paper]@{article@}
291 The font symbol names are defined in the file feta20.tex; to find
292 the location of this file, use the command
302 Sometimes it is useful to display music elements (such as ties and slurs)
303 as if they continued after the end of the fragment. This can be done by
304 breaking the staff and suppressing inclusion of the rest of the LilyPond
307 In @LaTeX{}, define @code{\betweenLilyPondSystem} in such a way that
308 inclusion of other systems is terminated once the required number of
309 systems are included. Since @code{\betweenLilyPondSystem} is first
310 called @emph{after} the first system, including only the first system
314 \def\betweenLilyPondSystem#1@{\endinput@}
316 \begin@{lilypond@}[fragment]
317 c'1\( e'( c'~ \break c' d) e f\)
321 If a greater number of systems is requested, a @TeX{} conditional must
322 be used before the @code{\endinput}. In this example, replace @q{2} by
323 the number of systems you want in the output.
326 \def\betweenLilyPondSystem#1@{
327 \ifnum#1<2\else\expandafter\endinput\fi
332 (Since @code{\endinput} immediately stops the processing of the current
333 input file we need @code{\expandafter} to delay the call of @code{\endinput}
334 after executing @code{\fi} so that the @code{\if}-@code{\fi} clause is
337 Remember that the definition of @code{\betweenLilyPondSystem} is
338 effective until @TeX{} quits the current group (such as the @LaTeX{}
339 environment) or is overridden by another definition (which is, in
340 most cases, for the rest of the document). To reset your
344 \let\betweenLilyPondSystem\undefined
348 in your @LaTeX{} source.
350 This may be simplified by defining a @TeX{} macro
353 \def\onlyFirstNSystems#1@{
354 \def\betweenLilyPondSystem##1@{%
355 \ifnum##1<#1\else\expandafter\endinput\fi@}
360 and then saying only how many systems you want before each fragment,
363 \onlyFirstNSystems@{3@}
364 \begin@{lilypond@}...\end@{lilypond@}
365 \onlyFirstNSystems@{1@}
366 \begin@{lilypond@}...\end@{lilypond@}
371 There are specific @command{lilypond-book} command line options and
372 other details to know when processing @LaTeX{} documents, see
373 @ref{Invoking lilypond-book}.
379 Texinfo is the standard format for documentation of the GNU project. An
380 example of a Texinfo document is this manual. The HTML, PDF, and Info
381 versions of the manual are made from the Texinfo document.
383 In the input file, music is specified with
386 @@lilypond[options,go,here]
395 @@lilypond[options,go,here]@{ YOUR LILYPOND CODE @}
402 @@lilypondfile[options,go,here]@{@var{filename}@}
405 Additionally, @code{@@lilypondversion} displays the current version
408 When @command{lilypond-book} is run on it, this results in a Texinfo
409 file (with extension @file{.texi}) containing @code{@@image} tags for
410 HTML, Info and printed output. @command{lilypond-book} generates images
411 of the music in EPS and PDF formats for use in the printed output, and
412 in PNG format for use in HTML and Info output.
414 We show two simple examples here. A @code{lilypond} environment
432 @@lilypond[fragment,staffsize=11]@{<c' e' g'>@}
438 @lilypond[fragment,staffsize=11]{<c' e' g'>}
440 Contrary to @LaTeX{}, @code{@@lilypond@{...@}} does not generate an
441 in-line image. It always gets a paragraph of its own.
447 Music is entered using
450 <lilypond fragment relative=2>
451 \key c \minor c4 es g2
456 @command{lilypond-book} then produces an HTML file with appropriate image
457 tags for the music fragments:
459 @lilypond[fragment,relative=2]
460 \key c \minor c4 es g2
463 For inline pictures, use @code{<lilypond ... />}, where the options
464 are separated by a colon from the music, for example
467 Some music in <lilypond relative=2: a b c/> a line of text.
470 To include separate files, say
473 <lilypondfile @var{option1} @var{option2} ...>@var{filename}</lilypondfile>
476 For a list of options to use with the @code{lilypond} or
477 @code{lilypondfile} tags, see @ref{Music fragment options}.
479 Additionally, @code{<lilypondversion/>} displays the current version
483 @cindex titling in HTML
484 @cindex preview image
490 For inserting LilyPond snippets it is good to keep the conformity of our
491 DocBook document, thus allowing us to use DocBook editors, validation
492 etc. So we don't use custom tags, only specify a convention based on the
493 standard DocBook elements.
495 @subheading Common conventions
497 For inserting all type of snippets we use the @code{mediaobject} and
498 @code{inlinemediaobject} element, so our snippets can be formatted
499 inline or not inline. The snippet formatting options are always
500 provided in the @code{role} property of the innermost element (see in
501 next sections). Tags are chosen to allow DocBook editors format the
502 content gracefully. The DocBook files to be processed with
503 @command{lilypond-book} should have the extension @file{.lyxml}.
505 @subheading Including a LilyPond file
507 This is the most simple case. We must use the @file{.ly} extension for
508 the included file, and insert it as a standard @code{imageobject}, with
509 the following structure:
514 <imagedata fileref="music1.ly" role="printfilename" />
519 Note that you can use @code{mediaobject} or @code{inlinemediaobject}
520 as the outermost element as you wish.
522 @subheading Including LilyPond code
524 Including LilyPond code is possible by using a @code{programlisting},
525 where the language is set to @code{lilypond} with the following
531 <programlisting language="lilypond" role="fragment verbatim staffsize=16 ragged-right relative=2">
532 \context Staff \with @{
533 \remove Time_signature_engraver
534 \remove Clef_engraver@}
541 As you can see, the outermost element is a @code{mediaobject} or
542 @code{inlinemediaobject}, and there is a @code{textobject} containing
543 the @code{programlisting} inside.
545 @subheading Processing the DocBook document
547 Running @command{lilypond-book} on our @file{.lyxml} file will create a
548 valid DocBook document to be further processed with @file{.xml}
549 extension. If you use
550 @uref{http://@/dblatex@/.sourceforge@/.net@/,dblatex}, it will create a
551 PDF file from this document automatically. For HTML (HTML Help,
552 JavaHelp etc.) generation you can use the official DocBook XSL
553 stylesheets, however, it is possible that you have to make some
554 customization for it.
557 @node Music fragment options
558 @section Music fragment options
560 In the following, a @q{LilyPond command} refers to any command described
561 in the previous sections which is handled by @command{lilypond-book} to
562 produce a music snippet. For simplicity, LilyPond commands are only
563 shown in @LaTeX{} syntax.
565 Note that the option string is parsed from left to right; if an option
566 occurs multiple times, the last one is taken.
568 The following options are available for LilyPond commands:
571 @item staffsize=@var{ht}
572 Set staff size to @var{ht}, which is measured in points.
575 Produce ragged-right lines with natural spacing, i.e.,
576 @code{ragged-right = ##t} is added to the LilyPond snippet. This is the
577 default for the @code{\lilypond@{@}} command if no @code{line-width}
578 option is present. It is also the default for the @code{lilypond}
579 environment if the @code{fragment} option is set, and no line width is
580 explicitly specified.
583 For single-line snippets, allow the staff length to be stretched to
584 equal that of the line width, i.e., @code{ragged-right = ##f} is
585 added to the LilyPond snippet.
588 @itemx line-width=@var{size}\@var{unit}
589 Set line width to @var{size}, using @var{unit} as units. @var{unit} is
590 one of the following strings: @code{cm}, @code{mm}, @code{in}, or
591 @code{pt}. This option affects LilyPond output (this is, the staff
592 length of the music snippet), not the text layout.
594 If used without an argument, set line width to a default value (as
595 computed with a heuristic algorithm).
597 If no @code{line-width} option is given, @command{lilypond-book} tries to
598 guess a default for @code{lilypond} environments which don't use the
599 @code{ragged-right} option.
602 Do not print the time signature, and turns off the timing (time signature,
603 bar lines) in the score.
606 Make @command{lilypond-book} add some boilerplate code so that you can
614 without @code{\layout}, @code{\score}, etc.
617 Do not add additional code to complete LilyPond code in music snippets.
618 Since this is the default, @code{nofragment} is redundant normally.
620 @item indent=@var{size}\@var{unit}
621 Set indentation of the first music system to @var{size}, using
622 @var{unit} as units. @var{unit} is one of the following strings:
623 @code{cm}, @code{mm}, @code{in}, or @code{pt}. This option affects
624 LilyPond, not the text layout.
627 Set indentation of the first music system to zero. This option affects
628 LilyPond, not the text layout. Since no indentation is the default,
629 @code{noindent} is redundant normally.
632 Reduce line length of a music snippet by @math{2*0.4}@dmn{in} and put
633 the output into a quotation block. The value @q{0.4@dmn{in}} can be
634 controlled with the @code{exampleindent} option.
637 Set the amount by which the @code{quote} option indents a music snippet.
640 @itemx relative=@var{n}
641 Use relative octave mode. By default, notes are specified relative to
642 middle@tie{}C. The optional integer argument specifies the octave of
643 the starting note, where the default @code{1} is middle C.
644 @code{relative} option only works when @code{fragment} option is set,
645 so @code{fragment} is automatically implied by @code{relative},
646 regardless of the presence of any @code{(no)fragment} option in the
650 LilyPond also uses @command{lilypond-book} to produce its own
651 documentation. To do that, some more obscure music fragment options are
656 The argument of a LilyPond command is copied to the output file and
657 enclosed in a verbatim block, followed by any text given with the
658 @code{intertext} option (not implemented yet); then the actual music is
659 displayed. This option does not work well with @code{\lilypond@{@}} if
660 it is part of a paragraph.
662 If @code{verbatim} is used in a @code{lilypondfile} command, it is
663 possible to enclose verbatim only a part of the source file. If the
664 source file contain a comment containing @samp{begin verbatim} (without
665 quotes), quoting the source in the verbatim block will start after the
666 last occurrence of such a comment; similarly, quoting the source verbatim
667 will stop just before the first occurrence of a comment containing
668 @samp{end verbatim}, if there is any. In the following source file
669 example, the music will be interpreted in relative mode, but the
670 verbatim quote will not show the @code{relative} block, i.e.
673 \relative c' @{ % begin verbatim
680 will be printed with a verbatim block like
688 If you would like to translate comments and variable names in verbatim
689 output but not in the sources, you may set the environment variable
690 @code{LYDOC_LOCALEDIR} to a directory path; the directory should
691 contain a tree of @file{.mo} message catalogs with @code{lilypond-doc}
695 (Only for Texinfo output.) Prepend line @code{\version
696 @@w@{"@@version@{@}"@}} to @code{verbatim} output.
699 (Only for Texinfo output.) If @command{lilypond} is called with the
700 @option{--header=@/texidoc} option, and the file to be processed is
701 called @file{foo.ly}, it creates a file @file{foo.texidoc} if there
702 is a @code{texidoc} field in the @code{\header}. The @code{texidoc}
703 option makes @command{lilypond-book} include such files, adding its
704 contents as a documentation block right before the music snippet.
706 Assuming the file @file{foo.ly} contains
710 texidoc = "This file demonstrates a single note."
716 and we have this in our Texinfo document @file{test.texinfo}
719 @@lilypondfile[texidoc]@{foo.ly@}
723 the following command line gives the expected result
726 lilypond-book --pdf --process="lilypond \
727 -dbackend=eps --header=texidoc" test.texinfo
730 Most LilyPond test documents (in the @file{input} directory of the
731 distribution) are small @file{.ly} files which look exactly like this.
733 For localization purpose, if the Texinfo document contains
734 @code{@@documentlanguage @var{LANG}} and @file{foo.ly} header
735 contains a @code{texidoc@var{LANG}} field, and if @command{lilypond}
736 is called with @option{--header=@/texidoc@var{LANG}}, then
737 @file{foo.texidoc@var{LANG}} will be included instead of
741 (Only for Texinfo output.) This option works similarly to
742 @code{texidoc} option: if @command{lilypond} is called with the
743 @option{--header=@/doctitle} option, and the file to be processed is
744 called @file{foo.ly} and contains a @code{doctitle} field in the
745 @code{\header}, it creates a file @file{foo.doctitle}. When
746 @code{doctitle} option is used, the contents of @file{foo.doctitle},
747 which should be a single line of @var{text}, is inserted in the
748 Texinfo document as @code{@@lydoctitle @var{text}}.
749 @code{@@lydoctitle} should be a macro defined in the Texinfo document.
750 The same remark about @code{texidoc} processing with localized
751 languages also applies to @code{doctitle}.
754 (Only for Texinfo output.) Do not translate comments and variable
755 names in the snippet quoted verbatim.
758 If a LilyPond input file is included with @code{\lilypondfile}, print
759 the file name right before the music snippet. For HTML output, this
760 is a link. Only the base name of the file is printed, i.e. the
761 directory part of the file path is stripped.
766 @node Invoking lilypond-book
767 @section Invoking @command{lilypond-book}
769 @command{lilypond-book} produces a file with one of the following
770 extensions: @file{.tex}, @file{.texi}, @file{.html} or @file{.xml},
771 depending on the output format. All of @file{.tex}, @file{.texi} and
772 @file{.xml} files need further processing.
774 @subheading Format-specific instructions
776 @subsubheading @LaTeX{}
778 There are two ways of processing your @LaTeX{} document for printing or
779 publishing: getting a PDF file directly with PDF@LaTeX{}, or getting a
780 PostScript file with @LaTeX{} via a DVI to PostScript translator like
781 @command{dvips}. The first way is simpler and recommended@footnote{Note
782 that PDF@LaTeX{} and @LaTeX{} may not be both usable to compile any
783 @LaTeX{} document, that is why we explain the two ways.}, and whichever
784 way you use, you can easily convert between PostScript and PDF with
785 tools, like @command{ps2pdf} and @command{pdf2ps} included in
788 To produce a PDF file through PDF@LaTeX{}, use
791 lilypond-book --pdf yourfile.lytex
792 pdflatex yourfile.tex
795 @cindex outline fonts
798 @cindex invoking dvips
799 To produce PDF output via @LaTeX{}/@command{dvips}/@command{ps2pdf}, you
803 lilypond-book yourfile.lytex
805 dvips -Ppdf yourfile.dvi
810 The @file{.dvi} file created by this process will not contain
811 note heads. This is normal; if you follow the instructions, they
812 will be included in the @file{.ps} and @file{.pdf} files.
814 Running @command{dvips} may produce some warnings about fonts; these
815 are harmless and may be ignored. If you are running @command{latex} in
816 twocolumn mode, remember to add @code{-t landscape} to the
817 @command{dvips} options.
819 @subsubheading Texinfo
821 To produce a Texinfo document (in any output format), follow the normal
822 procedures for Texinfo; this is, either call @command{texi2pdf} or
823 @command{texi2dvi} or @command{makeinfo}, depending on the output format
826 @xref{Format with texi2dvi, , , texinfo, GNU Texinfo}, and @ref{Creating
827 an Info File, , , texinfo, GNU Texinfo}.
830 See the documentation of Texinfo for further details.
834 @subheading Command line options
836 @command{lilypond-book} accepts the following command line options:
839 @item -f @var{format}
840 @itemx --format=@var{format}
841 Specify the document type to process: @code{html}, @code{latex},
842 @code{texi} (the default) or @code{docbook}. If this option is missing,
843 @command{lilypond-book} tries to detect the format automatically, see
844 @ref{Filename extensions}. Currently, @code{texi} is the same as
847 @c This complicated detail is not implemented, comment it out -jm
849 The @code{texi} document type produces a Texinfo file with music
850 fragments in the printed output only. For getting images in the HTML
851 version, the format @code{texi-html} must be used instead.
854 @item -F @var{filter}
855 @itemx --filter=@var{filter}
856 Pipe snippets through @var{filter}. @code{lilypond-book} will
857 not --filter and --process at the same time. For example,
860 lilypond-book --filter='convert-ly --from=2.0.0 -' my-book.tely
865 Print a short help message.
868 @itemx --include=@var{dir}
869 Add @var{dir} to the include path. @command{lilypond-book} also looks
870 for already compiled snippets in the include path, and does not write
871 them back to the output directory, so in some cases it is necessary to
872 invoke further processing commands such as @command{makeinfo} or
873 @command{latex} with the same @code{-I @var{dir}} options.
876 @itemx --output=@var{dir}
877 Place generated files in directory @var{dir}. Running
878 @command{lilypond-book} generates lots of small files that LilyPond will
879 process. To avoid all that garbage in the source directory, use the
880 @option{--output} command line option, and change to that directory
881 before running @command{latex} or @command{makeinfo}.
884 lilypond-book --output=out yourfile.lytex
889 @itemx --skip-lily-check
890 Do not fail if no lilypond output is found. It is used for LilyPond
891 Info documentation without images.
893 @itemx --skip-png-check
894 Do not fail if no PNG images are found for EPS files. It is used for
895 LilyPond Info documentation without images.
897 @itemx --lily-output-dir=@var{dir}
898 Write lily-XXX files to directory @var{dir}, link into @code{--output}
899 directory. Use this option to save building time for documents in
900 different directories which share a lot of identical snippets.
902 @itemx --info-images-dir=@var{dir}
903 Format Texinfo output so that Info will look for images of music in
906 @itemx --latex-program=@var{prog}
907 Run executable @command{prog} instead of @command{latex}. This is
908 useful if your document is processed with @command{xelatex}, for
911 @itemx --left-padding=@var{amount}
912 Pad EPS boxes by this much. @var{amount} is measured in millimeters,
913 and is 3.0 by default. This option should be used if the lines of
914 music stick out of the right margin.
916 The width of a tightly clipped system can vary, due to notation
917 elements that stick into the left margin, such as bar numbers and
918 instrument names. This option will shorten each line and move each
919 line to the right by the same amount.
921 @item -P @var{command}
922 @itemx --process=@var{command}
923 Process LilyPond snippets using @var{command}. The default command is
924 @code{lilypond}. @code{lilypond-book} will not @code{--filter} and
925 @code{--process} at the same time.
928 Create PDF files for use with PDF@LaTeX{}.
930 @itemx --use-source-file-names
931 Write snippet output files with the same base name as their source file.
932 This option works only for snippets included with @code{lilypondfile}
933 and only if directories implied by @code{--output-dir} and
934 @code{--lily-output-dir} options are different.
942 Print version information.
947 The Texinfo command @code{@@pagesizes} is not interpreted. Similarly,
948 @LaTeX{} commands that change margins and line widths after the preamble
951 Only the first @code{\score} of a LilyPond block is processed.
954 @node Filename extensions
955 @section Filename extensions
957 You can use any filename extension for the input file, but if you do not
958 use the recommended extension for a particular format you may need to
959 manually specify the output format; for details, see @ref{Invoking
960 lilypond-book}. Otherwise, @command{lilypond-book} automatically
961 selects the output format based on the input filename's extension.
964 @multitable @columnfractions .2 .5
965 @item @strong{extension} @tab @strong{output format}
967 @item @file{.html} @tab HTML
968 @item @file{.htmly} @tab HTML
969 @item @file{.itely} @tab Texinfo
970 @item @file{.latex} @tab @LaTeX{}
971 @item @file{.lytex} @tab @LaTeX{}
972 @item @file{.lyxml} @tab DocBook
973 @item @file{.tely} @tab Texinfo
974 @item @file{.tex} @tab @LaTeX{}
975 @item @file{.texi} @tab Texinfo
976 @item @file{.texinfo} @tab Texinfo
977 @item @file{.xml} @tab HTML
981 If you use the same filename extension for the input file than the
982 extension @command{lilypond-book} uses for the output file, and if the
983 input file is in the same directory as @command{lilypond-book} working
984 directory, you must use @code{--output} option to make
985 @command{lilypond-book} running, otherwise it will exit with an error
986 message like @qq{Output would overwrite input file}.
989 @node lilypond-book templates
990 @section lilypond-book templates
992 These templates are for use with @code{lilypond-book}. If you're not familiar
993 with this program, please refer to
998 You can include LilyPond fragments in a LaTeX document.
1001 \documentclass[]@{article@}
1013 More LaTeX text, and options in square brackets.
1015 \begin@{lilypond@}[fragment,relative=2,quote,staffsize=26,verbatim]
1023 You can include LilyPond fragments in Texinfo; in fact, this entire manual
1024 is written in Texinfo.
1027 \input texinfo @c -*-texinfo-*-
1039 More Texinfo text, and options in brackets.
1041 @@lilypond[verbatim,fragment,ragged-right]
1052 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
1058 Documents for lilypond-book may freely mix music and text. For
1068 Another bit of lilypond, this time with options:
1070 <lilypond fragment quote staffsize=26 verbatim>
1084 \documentclass{article}
1085 \usepackage{ifxetex}
1087 %xetex specific stuff
1088 \usepackage{xunicode,fontspec,xltxtra}
1089 \setmainfont[Numbers=OldStyle]{Times New Roman}
1092 %This can be empty if you are not going to use pdftex
1093 \usepackage[T1]{fontenc}
1094 \usepackage[utf8]{inputenc}
1095 \usepackage{mathptmx}%Times
1096 \usepackage{helvet}%Helvetica
1098 %Here you can insert all packages that pdftex also understands
1099 \usepackage[ngerman,finnish,english]{babel}
1100 \usepackage{graphicx}
1103 \title{A short document with LilyPond and xelatex}
1106 Normal \textbf{font} commands inside the \emph{text} work,
1107 because they \textsf{are supported by \LaTeX{} and XeteX.}
1108 If you want to use specific commands like \verb+\XeTeX+, you
1109 should include them again in a \verb+\ifxetex+ environment.
1110 You can use this to print the \ifxetex \XeTeX{} command \else
1111 XeTeX command \fi which is not known to normal \LaTeX .
1113 In normal text you can easily use LilyPond commands, like this:
1122 The fonts of snippets set with LilyPond will have to be set from
1124 of the snippet. For this you should read the AU on how to use
1127 \selectlanguage{ngerman}
1128 Auch Umlaute funktionieren ohne die \LaTeX -Befehle, wie auch alle
1130 seltsamen Zeichen: __ ______, wenn sie von der Schriftart
1131 unterst__tzt werden.
1136 @node Sharing the table of contents
1137 @section Sharing the table of contents
1139 These functions already exist in the OrchestralLily package:
1142 @url{http://repo.or.cz/w/orchestrallily.git}
1145 For greater flexibility in text handling, some users prefer to
1146 export the table of contents from lilypond and read it into
1149 @subsubheading Exporting the ToC from LilyPond
1151 This assumes that your score has multiple movements in the same lilypond
1155 #(define (oly:create-toc-file layout pages)
1156 (let* ((label-table (ly:output-def-lookup layout 'label-page-table)))
1157 (if (not (null? label-table))
1158 (let* ((format-line (lambda (toc-item)
1159 (let* ((label (car toc-item))
1160 (text (caddr toc-item))
1161 (label-page (and (list? label-table)
1162 (assoc label label-table)))
1163 (page (and label-page (cdr label-page))))
1164 (format #f "~a, section, 1, @{~a@}, ~a" page text label))))
1165 (formatted-toc-items (map format-line (toc-items)))
1166 (whole-string (string-join formatted-toc-items ",\n"))
1167 (output-name (ly:parser-output-name parser))
1168 (outfilename (format "~a.toc" output-name))
1169 (outfile (open-output-file outfilename)))
1170 (if (output-port? outfile)
1171 (display whole-string outfile)
1172 (ly:warning (_ "Unable to open output file ~a for the TOC information") outfilename))
1173 (close-output-port outfile)))))
1176 #(define (page-post-process layout pages) (oly:create-toc-file layout pages))
1180 @subsubheading Importing the ToC into LaTeX
1182 In LaTeX, the header should include:
1184 @c no, this doesn't require the smallexample, but since the other
1185 @c two blocks on this page use it, I figured I might as well
1186 @c user it here as well, for consistency. -gp
1188 \usepackage@{pdfpages@}
1189 \includescore@{nameofthescore@}
1193 where @code{\includescore} is defined as:
1196 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1197 % \includescore@{PossibleExtension@}
1198 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1200 % Read in the TOC entries for a PDF file from the corresponding .toc file.
1201 % This requires some heave latex tweaking, since reading in things from a file
1202 % and inserting it into the arguments of a macro is not (easily) possible
1204 % Solution by Patrick Fimml on #latex on April 18, 2009:
1205 % \readfile@{filename@}@{\variable@}
1206 % reads in the contents of the file into \variable (undefined if file
1208 \newread\readfile@@f
1209 \def\readfile@@line#1@{%
1210 @{\catcode`\^^M=10\global\read\readfile@@f to \readfile@@tmp@}%
1211 \edef\do@{\noexpand\g@@addto@@macro@{\noexpand#1@}@{\readfile@@tmp@}@}\do%
1212 \ifeof\readfile@@f\else%
1213 \readfile@@line@{#1@}%
1216 \def\readfile#1#2@{%
1217 \openin\readfile@@f=#1 %
1219 \typeout@{No TOC file #1 available!@}%
1222 \readfile@@line@{#2@}%
1224 \closein\readfile@@f%
1228 \newcommand@{\includescore@}[1]@{
1229 \def\oly@@fname@{\oly@@basename\@@ifmtarg@{#1@}@{@}@{_#1@}@}
1230 \let\oly@@addtotoc\undefined
1231 \readfile@{\oly@@xxxxxxxxx@}@{\oly@@addtotoc@}
1232 \ifx\oly@@addtotoc\undefined
1233 \includepdf[pages=-]@{\oly@@fname@}
1235 \edef\includeit@{\noexpand\includepdf[pages=-,addtotoc=@{\oly@@addtotoc@}]
1236 @{\oly@@fname@}@}\includeit
1242 @node Alternate methods of mixing text and music
1243 @section Alternative methods of mixing text and music
1245 Other means of mixing text and music (without
1246 @command{lilypond-book}) are discussed in
1247 @ref{LilyPond output in other programs}.