1 @c -*- coding: utf-8; mode: texinfo; -*-
4 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
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 @node General input and output
14 @chapter General input and output
16 This section deals with general LilyPond input and output issues,
17 rather than specific notation.
21 * Titles and headers::
22 * Working with input files::
23 * Controlling output::
25 * Extracting musical information::
30 @section Input structure
32 The main format of input for LilyPond are text files. By convention,
33 these files end with @file{.ly}.
36 * Structure of a score::
37 * Multiple scores in a book::
38 * Multiple output files from one input file::
44 @node Structure of a score
45 @subsection Structure of a score
49 A @code{\score} block must contain a single music expression
50 delimited by curly brackets:
58 @warning{There must be @strong{only one} outer music expression in
59 a @code{\score} block, and it @strong{must} be surrounded by
62 This single music expression may be of any size, and may contain
63 other music expressions to any complexity. All of these examples
64 are music expressions:
70 @lilypond[verbatim,quote]
77 @lilypond[verbatim,quote]
79 \new Staff { c'4 c' c' c' }
80 \new Staff { d'4 d' d' d' }
88 \new Staff @{ \flute @}
89 \new Staff @{ \oboe @}
92 \new Staff @{ \violinI @}
93 \new Staff @{ \violinII @}
99 Comments are one exception to this general rule. (For others see
100 @ref{File structure}.) Both single-line comments and comments
101 delimited by @code{%@{ .. %@}} may be placed anywhere within an
102 input file. They may be placed inside or outside a @code{\score}
103 block, and inside or outside the single music expression within a
106 Remember that even in a file containing only a @code{\score} block, it
107 is implicitly enclosed in a \book block. A \book block in a source
108 file produces at least one output file, and by default the name of the
109 output file produced is derived from the name of the input file, so
110 @file{fandangoforelephants.ly} will produce
111 @file{fandangoforelephants.pdf}.
113 (For more details about @code{\book} blocks, see
114 @ref{Multiple scores in a book},
115 @ref{Multiple output files from one input file} @ref{File structure}.)
119 @rlearning{Working on input files},
120 @rlearning{Music expressions explained},
121 @rlearning{Score is a (single) compound musical expression}.
124 @node Multiple scores in a book
125 @subsection Multiple scores in a book
128 @cindex movements, multiple
130 A document may contain multiple pieces of music and text. Examples
131 of these are an etude book, or an orchestral part with multiple
132 movements. Each movement is entered with a @code{\score} block,
140 and texts are entered with a @code{\markup} block,
150 All the movements and texts which appear in the same @file{.ly} file
151 will normally be typeset in the form of a single output file.
165 One important exception is within lilypond-book documents,
166 where you explicitly have to add a @code{\book} block, otherwise only
167 the first @code{\score} or @code{\markup} will appear in the output.
169 The header for each piece of music can be put inside the @code{\score}
170 block. The @code{piece} name from the header will be printed before
171 each movement. The title for the entire book can be put inside the
172 @code{\book}, but if it is not present, the @code{\header} which is at
173 the top of the file is inserted.
177 title = "Eight miniatures"
178 composer = "Igor Stravinsky"
182 \header @{ piece = "Romanze" @}
185 ..text of second verse..
188 ..text of third verse..
192 \header @{ piece = "Menuetto" @}
198 Pieces of music may be grouped into book parts using @code{\bookpart}
199 blocks. Book parts are separated by a page break, and can start with a
200 title, like the book itself, by specifying a @code{\header} block.
206 subtitle = "First part"
213 subtitle = "Second part"
220 @node Multiple output files from one input file
221 @subsection Multiple output files from one input file
223 If you want multiple output files from the same @file{.ly} file,
224 then you can add multiple @code{\book} blocks, where each
225 such \book block will result in a separate output file.
226 If you do not specify any @code{\book} block in the
227 input file, LilyPond will implicitly treat the whole
228 file as a single \book block, see
229 @ref{File structure}.
231 When producing multiple files from a single source file, Lilypond
232 ensures that none of the output files from any @code{\book} block
233 overwrites the output file produced by a preceding @code{\book} from
236 It does this by adding a suffix to the output name for each
237 @code{\book} which uses the default output file name derived from the
240 The default behaviour is to append a version-number suffix for each
241 name which may clash, so
246 \layout @{ @dots{} @}
250 \layout @{ @dots{} @}
254 \layout @{ @dots{} @}
258 in source file @file{eightminiatures.ly}
263 @file{eightminiatures.pdf},
265 @file{eightminiatures-1.pdf} and
267 @file{eightminiatures-2.pdf}.
270 @node Output file names
271 @subsection Output file names
273 @funindex \bookOutputSuffix
274 @funindex \bookOutputName
276 Lilypond provides facilities to allow you to control what file names
277 are used by the various back-ends when producing output files.
279 In the previous section, we saw how Lilypond prevents name-clashes when
280 producing several ouputs from a single source file. You also have the
281 ability to specify your own suffixes for each @code{\book} block, so
282 for example you can produce files called
283 @file{eightminiatures-Romanze.pdf}, @file{eightminiatures-Menuetto.pdf}
284 and @file{eightminiatures-Nocturne.pdf} by adding a
285 @code{\bookOutputSuffix} declaration inside each @code{\book} block.
289 \bookOutputSuffix "Romanze"
291 \layout @{ @dots{} @}
294 \bookOutputSuffix "Menuetto"
296 \layout @{ @dots{} @}
299 \bookOutputSuffix "Nocturne"
301 \layout @{ @dots{} @}
305 You can also specify a different output filename for @code{book} block,
306 by using @code{\bookOutputName} declarations
310 \bookOutputName "Romanze"
312 \layout @{ @dots{} @}
315 \bookOutputName "Menuetto"
317 \layout @{ @dots{} @}
320 \bookOutputName "Nocturne"
322 \layout @{ @dots{} @}
326 The file above will produce these output files:
332 @file{Menuetto.pdf} and
339 @subsection File structure
349 A @file{.ly} file may contain any number of toplevel expressions, where a
350 toplevel expression is one of the following:
354 An output definition, such as @code{\paper}, @code{\midi}, and
355 @code{\layout}. Such a definition at the toplevel changes the default
356 book-wide settings. If more than one such definition of
357 the same type is entered at the top level any definitions in the later
358 expressions have precedence.
361 A direct scheme expression, such as
362 @code{#(set-default-paper-size "a7" 'landscape)} or
363 @code{#(ly:set-option 'point-and-click #f)}.
366 A @code{\header} block. This sets the global header block. This
367 is the block containing the definitions for book-wide settings, like
368 composer, title, etc.
371 A @code{\score} block. This score will be collected with other
372 toplevel scores, and combined as a single @code{\book}.
373 This behavior can be changed by setting the variable
374 @code{toplevel-score-handler} at toplevel. The default handler is
375 defined in the init file @file{../scm/lily.scm}.
378 A @code{\book} block logically combines multiple movements
379 (i.e., multiple @code{\score} blocks) in one document. If there
380 are a number of @code{\score}s, one output file will be created
381 for each @code{\book} block, in which all corresponding movements
382 are concatenated. The only reason to explicitly specify
383 @code{\book} blocks in a @file{.ly} file is if you wish to create
384 multiple output files from a single input file. One exception is
385 within lilypond-book documents, where you explicitly have to add
386 a @code{\book} block if you want more than a single @code{\score}
387 or @code{\markup} in the same example. This behavior can be
388 changed by setting the variable @code{toplevel-book-handler} at
389 toplevel. The default handler is defined in the init file
390 @file{../scm/lily.scm}.
393 A @code{\bookpart} block. A book may be divided into several parts,
394 using @code{\bookpart} blocks, in order to ease the page breaking,
395 or to use different @code{\paper} settings in different parts.
398 A compound music expression, such as
403 This will add the piece in a @code{\score} and format it in a
404 single book together with all other toplevel @code{\score}s and music
405 expressions. In other words, a file containing only the above
406 music expression will be translated into
423 This behavior can be changed by setting the variable
424 @code{toplevel-music-handler} at toplevel. The default handler is
425 defined in the init file @file{../scm/lily.scm}.
428 A markup text, a verse for example
431 2. The first line verse two.
435 Markup texts are rendered above, between or below the scores or music
436 expressions, wherever they appear.
446 This can be used later on in the file by entering @code{\foo}. The
447 name of a variable should have alphabetic characters only; no
448 numbers, underscores or dashes.
452 The following example shows three things that may be entered at
457 % Don't justify the output
469 At any point in a file, any of the following lexical instructions can
473 @item @code{\version}
474 @item @code{\include}
475 @item @code{\sourcefilename}
476 @item @code{\sourcefileline}
478 A single-line comment, introduced by a leading @code{%} sign.
481 A multi-line comment delimited by @code{%@{ .. %@}}.
487 Whitespace between items in the input stream is generally ignored,
488 and may be freely omitted or extended to enhance readability.
489 However, whitespace should always be used in the following
490 circumstances to avoid errors:
493 @item Around every opening and closing curly bracket.
494 @item After every command or variable, i.e. every item that
495 begins with a @code{\} sign.
496 @item After every item that is to be interpreted as a Scheme
497 expression, i.e. every item that begins with a @code{#}@tie{}sign.
498 @item To separate all elements of a Scheme expression.
499 @item In @code{lyricmode} to separate all the terms in both
500 @code{\override} and @code{\set} commands. In particular, spaces
501 must be used around the dot and the equals sign in commands like
502 @code{\override Score . LyricText #'font-size = #5} and before and
503 after the entire command.
510 @rlearning{How LilyPond input files work}.
513 @node Titles and headers
514 @section Titles and headers
516 Almost all printed music includes a title and the composer's name;
517 some pieces include a lot more information.
520 * Creating titles headers and footers::
521 * Custom headers footers and titles::
522 * Creating footnotes::
523 * Reference to page numbers::
524 * Table of contents::
528 @node Creating titles headers and footers
529 @subsection Creating titles headers and footers
532 * Title blocks explained::
533 * Default layout of book and score title blocks::
534 * Default layout of headers and footers::
538 @node Title blocks explained
539 @unnumberedsubsubsec Title blocks explained
541 @c TODO: figure out how \bookpart titles work
543 There are two types of title blocks: the main title block that appears
544 above of the first @code{\score} of a book, and individual title
545 blocks that appear within each @code{\score} block. Text fields for
546 both types are entered using a @code{\header} block.
548 If the book only has a single score, the @code{\header} block may be
549 placed inside or outside of the @code{\score} block.
551 @warning{Remember when adding a @bs{}@code{header} block inside a
552 @bs{}@code{score} block, that the music expression must come before the
553 @bs{}@code{header} block.}
555 @lilypond[papersize=a5,quote,verbatim,noragged-right]
558 composer = "J. S. Bach."
562 \new Staff \relative g, {
565 \repeat unfold 2 { g16( d' b') a b d, b' d, } |
566 \repeat unfold 2 { g,16( e' c') b c e, c' e, } |
574 \new Staff \relative b {
578 <g, d' b'~>4 b'16 a( g fis) g( d e fis) g( a b c) |
579 d16( b g fis) g( e d c) b(c d e) fis( g a b) |
587 Text fields from the main title block of a book can be displayed in all
588 @code{\score} blocks, or manually suppressed:
590 @lilypond[papersize=a5,quote,verbatim,noragged-right]
593 print-all-headers = ##t
596 title = "DAS WOHLTEMPERIRTE CLAVIER"
598 % Do not display the tagline for this book
601 \markup { \vspace #1 }
605 \new Staff { \clef "bass" s1 }
608 title = "PRAELUDIUM I"
610 % Do not display the subtitle for this score
617 \new Staff { \clef "bass" s1 }
621 subsubtitle = "A 4 VOCI"
623 % Do not display the subtitle for this score
632 @ref{File structure},
633 @ref{Custom layout for title blocks}.
636 @node Default layout of book and score title blocks
637 @unnumberedsubsubsec Default layout of book and score title blocks
639 The layout and formatting of title blocks are controlled by two
640 @code{\paper} variables; @code{bookTitleMarkup} for the main
641 @code{\header} title block and @code{scoreTitleMarkup} for individual
642 @code{\header} blocks within a @code{\score}.
644 @lilypond[papersize=a6,quote,verbatim,noragged-right]
646 % The following fields are centered
647 dedication = "Dedication"
649 subtitle = "Subtitle"
650 subsubtitle = "Subsubtitle"
651 instrument = "Instrument"
653 % The following fields are left-aligned on the left side
657 % The following fields are right-aligned on the right side
658 composer = "Composer"
659 arranger = "Arranger"
665 % The following fields are placed at opposite ends of the same line
672 @c Is the bit about \null markups true? -mp
674 Text fields left unset in a @code{\header} block are replaced with
675 @code{\null} markups so that the space is not wasted.
677 The default settings for @code{scoreTitleMarkup} place the @code{piece}
678 and @code{opus} text fields at opposite ends of the same line.
682 Use the @code{breakbefore} variable inside a @code{\header} block
683 that is itself in a @code{\score} block, to make the top-level
684 @code{\header} block titles appear on the first page on their own, with
685 the music (defined in the @code{\score} block) starting on the next.
687 @lilypond[papersize=a8landscape,verbatim,noragged-right]
690 title = "This is my Title"
691 subtitle = "This is my Subtitle"
692 copyright = "This is the bottom of the first page"
695 \repeat unfold 4 { e'' e'' e'' e'' }
697 piece = "This is the Music"
706 @rlearning{How LilyPond input files work},
709 @ref{File structure}.
712 @file{ly/titling-init.ly}.
714 @node Default layout of headers and footers
715 @unnumberedsubsubsec Default layout of headers and footers
717 @emph{Headers} and @emph{footers} are lines of text appearing at
718 the top and bottom of pages, separate from the main text of a book.
719 They are controlled by the following @code{\paper} variables:
722 @item @code{oddHeaderMarkup}
723 @item @code{evenHeaderMarkup}
724 @item @code{oddFooterMarkup}
725 @item @code{evenFooterMarkup}
728 These markup variables can only access text fields from top-level
729 @code{\header} blocks (which apply to all scores in the book) and are
730 defined in @file{ly/titling-init.ly}. By default:
735 page numbers are automatically placed on the top far left (if even) or
736 top far right (if odd), starting from the second page.
739 the @code{instrument} text field is placed in the center of every
740 page, starting from the second page.
743 the @code{copyright} text is centered on the bottom of the first page.
746 the @code{tagline} is centered on the bottom of the last page, and below
747 the @code{copyright} text if there is only a single page.
751 @lilypond[papersize=a8landscape]
761 The default tagline can be changed by adding a @code{tagline} in the
762 top-level @code{\header} block.
764 @lilypond[papersize=a8landscape,verbatim]
767 tagline = "... music notation for Everyone"
777 To remove the @code{tagline} set the value to @code{##f}.
780 @node Custom headers footers and titles
781 @subsection Custom headers footers and titles
783 @c TODO: somewhere put a link to header spacing info
784 @c (you'll have to explain it more in NR 4).
787 * Custom text formatting for title blocks::
788 * Custom layout for title blocks::
789 * Custom layout for headers and footers::
793 @node Custom text formatting for title blocks
794 @unnumberedsubsubsec Custom text formatting for title blocks
796 Standard @code{\markup} commands can be used to customize any header,
797 footer and title text within the @code{\header} block.
799 @lilypond[quote,verbatim,noragged-right]
803 piece = \markup { \fontsize #4 \bold "PRAELUDIUM I" }
804 subtitle = \markup { \italic "(Excerpt)" }
811 @ref{Formatting text}.
814 @node Custom layout for title blocks
815 @unnumberedsubsubsec Custom layout for title blocks
817 @code{\markup} commands in the @code{\header} block are useful for
818 simple text formatting, but they do not allow precise control over the
819 placement of titles. To customize the placement of the text fields,
820 use either or both of the following @code{\paper} variables:
823 @item @code{bookTitleMarkup}
824 @item @code{scoreTitleMarkup}
827 These markup variables are discussed in
828 @ref{Default layout of book and score title blocks}.
830 The default settings for @code{scoreTitleMarkup} as defined in
831 @file{ly/titling-init.ly} are:
834 scoreTitleMarkup = \markup @{ \column @{
835 \on-the-fly #print-all-headers @{ \bookTitleMarkup \hspace #1 @}
837 \fromproperty #'header:piece
838 \fromproperty #'header:opus
844 This places the @code{piece} and @code{opus} text fields at opposite
845 ends of the same line:
847 @lilypond[quote,verbatim,noragged-right]
851 piece = "PRAELUDIUM I"
857 This example redefines @code{scoreTitleMarkup} so that the @code{piece}
858 text field is centered and in a large, bold font.
860 @lilypond[papersize=a5,quote,verbatim,noragged-right]
864 scoreTitleMarkup = \markup {
867 \fontsize #4 \bold \fromproperty #'header:piece
868 \fromproperty #'header:opus
872 \header { tagline = ##f }
876 piece = "PRAELUDIUM I"
883 Text fields normally reserved for the main title block can be included
884 in individual score title blocks with the @code{print-all-headers}
885 placed inside the @code{\paper} block. A disadvantage of using this
886 method is that the text fields that are intended specifically for the
887 top-level @code{\header} block need to be manually suppressed in every
888 @code{\score} block. See @ref{Title blocks explained}.
890 To avoid this, add the desired text field to the @code{scoreTitleMarkup}
891 definition. In the following example, the @code{composer} text field
892 (normally associated with @code{bookTitleMarkup}) is added to
893 @code{scoreTitleMarkup}, allowing each score to list a different
896 @lilypond[papersize=a5,quote,verbatim,noragged-right]
900 scoreTitleMarkup = \markup {
903 \fontsize #4 \bold \fromproperty #'header:piece
904 \fromproperty #'header:composer
908 \header { tagline = ##f }
913 composer = "Christian Petzold"
920 composer = "François Couperin"
926 It is also possible to create your own custom text fields, and refer to
927 them in the markup definition.
929 @lilypond[papersize=a5,quote,verbatim,noragged-right]
933 scoreTitleMarkup = \markup {
936 \override #`(direction . ,UP) {
938 \center-align \fontsize #-1 \bold
939 \fromproperty #'header:mycustomtext %% User-defined field
940 \center-align \fontsize #4 \bold
941 \fromproperty #'header:piece
944 \fromproperty #'header:opus
948 \header { tagline = ##f }
953 mycustomtext = "A 4 VOCI" %% User-defined field
962 @ref{Title blocks explained}.
965 @node Custom layout for headers and footers
966 @unnumberedsubsubsec Custom layout for headers and footers
968 @c can make-header and make-footer be removed from
969 @c paper-defaults-init.ly? -mp
971 @code{\markup} commands in the @code{\header} block are useful for
972 simple text formatting, but they do not allow precise control over the
973 placement of headers and footers. To customize the placement of
974 the text fields, use either or both of the following @code{\paper}
978 @item @code{oddHeaderMarkup}
979 @item @code{evenHeaderMarkup}
980 @item @code{oddFooterMarkup}
981 @item @code{evenFooterMarkup}
984 The following example centers page numbers at the bottom of every
985 page. First, the default settings for @code{oddHeaderMarkup} and
986 @code{evenHeaderMarkup} are removed by defining each as a @emph{null}
987 markup. Then, @code{oddFooterMarkup} is redefined with the page
988 number centered. Finally, @code{evenFooterMarkup} is given the
989 same layout by defining it as @code{\oddFooterMarkup}:
991 @lilypond[papersize=a8,quote,verbatim,noragged-right]
994 print-page-number = ##t
995 print-first-page-number = ##t
996 oddHeaderMarkup = \markup \null
997 evenHeaderMarkup = \markup \null
998 oddFooterMarkup = \markup {
1000 \on-the-fly #print-page-number-check-first
1001 \fromproperty #'page:page-number-string
1004 evenFooterMarkup = \oddFooterMarkup
1007 \new Staff { s1 \break s1 \break s1 }
1014 @ref{Title blocks explained},
1015 @ref{Default layout of book and score title blocks}.
1017 @node Creating footnotes
1018 @subsection Creating footnotes
1020 There are two types of footnotes that can be created; automatic
1021 footnotes and manual footnotes.
1024 * Footnotes overview::
1025 * Automatic footnotes::
1026 * Manual footnotes::
1029 @node Footnotes overview
1030 @unnumberedsubsubsec Footnotes overview
1032 Automatic footnotes create incrementing, numerical indicators and
1033 manual footnotes allow a custom indicator to be created instead. All
1034 grobs, top-level @code{\markup} and chorded notes can be annotated.
1036 The order in which each grob is drawn determines the order in which each
1037 indicator and so footnotes are created during compilation.
1040 @node Automatic footnotes
1041 @unnumberedsubsubsec Automatic footnotes
1043 Of the two commands used to create automatic footnotes, use
1044 @code{\autoFootnoteGrob} for individual grobs (i.e. note heads, stems,
1045 slurs, dynamics and @code{\markup} when using @code{TextScripts});
1046 and @code{\autoFootnote} for annotating chorded notes.
1048 Both commands take three arguments; the @var{Layout Object} to be
1049 annotated, the @var{(x . y)} position of the indicator and a
1050 @code{\markup} that will appear in the footnote at the bottom of the
1053 The command @code{\autoFootnoteGrob} must come @emph{before} the grob
1054 that the footnote is being attached to:
1056 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1058 \header { tagline = ##f }
1060 \autoFootnoteGrob #'NoteHead #'(0.5 . -2)
1061 \markup { The first note }
1063 \autoFootnoteGrob #'NoteHead #'(0.5 . 1)
1064 \markup { The third note }
1070 To annotate chorded notes, the @code{\autoFootnote} must come
1071 @emph{after} the note to which the footnote is being attached as a
1074 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1076 \header { tagline = ##f }
1079 c-\autoFootnote #'(1 . -1.25) "Here is a C"
1080 es-\autoFootnote #'(2 . -0.25) \markup { \italic "An E-flat" }
1081 g-\autoFootnote #'(2 . 3) \markup { \bold "This is a G" }
1087 @warning {When footnotes have the same vertical position, the footnotes
1088 are printed in order of descendancy; the higher the footnote, the
1089 higher up in the list.}
1091 Here are some examples of automatically footnoted grobs, also showing
1092 the relative position of the footnotes to the tagline and copyright.
1094 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1096 \header { copyright = \markup { "Copyright 1970" } }
1098 \autoFootnoteGrob #'DynamicText #'(-3 . 0)
1099 \markup { \bold Forte }
1101 \autoFootnoteGrob #'Slur #'(0 . 1.5)
1105 \autoFootnoteGrob #'Beam #'(0 . -2)
1109 \autoFootnoteGrob #'Stem #'(1 . -1)
1110 \markup { \teeny { This is a stem } }
1113 \autoFootnoteGrob #'AccidentalCautionary #'(0 . 0.5)
1114 \markup \italic { A cautionary accidental }
1116 \autoFootnoteGrob #'TextScript #'(0.5 . -0.5)
1117 \markup \italic { Slow Down }
1123 For top-level @code{\markup}, the @code{\auto-footnote} command is
1126 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1128 \header { tagline = ##f }
1129 \markup { \auto-footnote "A simple tune" \italic "By me" }
1137 @node Manual footnotes
1138 @unnumberedsubsubsec Manual footnotes
1141 @funindex \footnoteGrob
1142 @cindex footnotes, manual
1144 There are two commands used to create manual footnotes; @code{\footnote}
1145 for top-level @code{\markup} and chorded notes; and @code{\footnoteGrob}
1146 for individual grobs (and @code{\markup} when using @code{TextScripts}).
1148 When annotating grobs, the @code{\footnote} command takes four
1149 arguments; the @var{Layout Object} to be annotated, the @var{(x . y)}
1150 position of the indicator and two @code{\markup} commands; the first is
1151 the indicator attached to the note or grob and the second is the
1152 footnote at the bottom of the page.
1154 The command @code{\footnoteGrob} must come @emph{after} the grob
1155 that the footnote footnote is annotating and attached as a
1158 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1160 \header { tagline = ##f }
1162 a'4-\footnoteGrob #'NoteHead #'(0.5 . -2)
1163 "1" \markup { \italic "1. The first note" }
1165 e-\footnoteGrob #'NoteHead #'(0.5 . 1)
1166 \markup { \bold "2" } "2. The second note"
1168 d\p-\footnoteGrob #'DynamicText #'(0.5 . -1) "3" "3. Piano"
1173 To annotate chorded notes, the @code{\footnote} must come @emph{after}
1174 the note that the footnote is annotating and attached as a
1177 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1179 \header { tagline = ##f }
1182 c-\footnote #'(1 . -1.25) "1" "1. C"
1183 es-\footnote #'(2 . -0.25)
1184 \markup { \bold "b" } "b. E-flat"
1185 g-\footnote #'(2 . 3) "3" \markup { \italic "iii. G" }
1191 @warning {When footnotes have the same vertical position, the footnotes
1192 are printed in order of descendancy; the higher the footnote, the
1193 higher up in the list.}
1195 Here are some examples of manually footnoted grobs, also showing
1196 the relative position of the footnotes to the tagline and copyright
1198 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1200 \header { tagline = ##f }
1202 \footnoteGrob #'DynamicText #'(-3 . 0)
1203 \markup { \teeny 1 }
1204 \markup { 1. \bold Forte }
1206 \footnoteGrob #'Slur #'(0 . 1.5)
1207 \markup { \teeny b }
1208 \markup { b. A slur }
1211 \footnoteGrob #'Beam #'(0 . -2)
1212 \markup { \teeny 3 }
1216 \footnoteGrob #'Stem #'(1 . -1)
1218 \markup { \bold 4. { This is a stem } }
1221 \footnoteGrob #'AccidentalCautionary #'(0 . 0.5)
1222 \markup \concat \teeny { "sharp (v)" }
1223 \markup \italic { v. A cautionary accidental }
1225 \footnoteGrob #'TextScript #'(0.5 . -0.5)
1226 \markup \concat \teeny { "a" }
1227 \markup \italic { a. Slow Down }
1231 \footnoteGrob #'BreathingSign #'(1.5 . -0.25)
1232 \markup { \teeny \musicglyph #"rests.4" }
1238 To manually footnote a top-level @code{\markup}:
1240 @lilypond[verbatim,quote,ragged-right,papersize=a8]
1242 \header { tagline = ##f }
1243 \markup { "A simple tune" \footnote "*" \italic "* By me" }
1252 @rlearning{Objects and interfaces}.
1259 @ref{Titles and headers}.
1261 Internals Reference:
1262 @rinternals{FootnoteEvent},
1263 @rinternals{FootnoteItem},
1264 @rinternals{FootnoteSpanner},
1265 @rinternals{Footnote_engraver}.
1268 Multiple footnotes for the same page can only be stacked, one on top of
1269 the other, and cannot be printed on the same line. Footnotes cannot be
1270 attached to @code{MultiMeasureRests} and may collide with @code{Staff},
1271 @code{\markup} objects and other @code{footnote} annotations. When
1272 using any manual @code{footnote} command a @code{\paper} block
1273 containing @code{footnote-auto-number = ##f} is required.
1276 @node Reference to page numbers
1277 @subsection Reference to page numbers
1279 A particular place of a score can be marked using the @code{\label}
1280 command, either at top-level or inside music. This label can then be
1281 referred to in a markup, to get the number of the page where the marked
1282 point is placed, using the @code{\page-ref} markup command.
1285 \header { tagline = ##f }
1291 \pageBreak \mark A \label #'markA
1295 \markup { The first score begins on page \page-ref #'firstScore "0" "?" }
1296 \markup { Mark A is on page \page-ref #'markA "0" "?" }
1300 The @code{\page-ref} markup command takes three arguments:
1302 @item the label, a scheme symbol, eg. @code{#'firstScore};
1303 @item a markup that will be used as a gauge to estimate the dimensions
1305 @item a markup that will be used in place of the page number if the label
1309 The reason why a gauge is needed is that, at the time markups are
1310 interpreted, the page breaking has not yet occurred, so the page numbers
1311 are not yet known. To work around this issue, the actual markup
1312 interpretation is delayed to a later time; however, the dimensions of
1313 the markup have to be known before, so a gauge is used to decide these
1314 dimensions. If the book has between 10 and 99 pages, it may be "00",
1315 ie. a two digit number.
1326 @node Table of contents
1327 @subsection Table of contents
1328 A table of contents is included using the @code{\markuplist \table-of-contents}
1329 command. The elements which should appear in the table of contents are
1330 entered with the @code{\tocItem} command, which may be used either at
1331 top-level, or inside a music expression.
1334 \markuplist \table-of-contents
1337 \tocItem \markup "First score"
1341 \tocItem \markup "Some particular point in the first score"
1346 \tocItem \markup "Second score"
1354 The markups which are used to format the table of contents are defined
1355 in the @code{\paper} block. The default ones are @code{tocTitleMarkup},
1356 for formatting the title of the table, and @code{tocItemMarkup}, for
1357 formatting the toc elements, composed of the element title and page
1358 number. These variables may be changed by the user:
1362 %% Translate the toc title into French:
1363 tocTitleMarkup = \markup \huge \column {
1364 \fill-line { \null "Table des matières" \null }
1367 %% use larger font size
1368 tocItemMarkup = \markup \large \fill-line {
1369 \fromproperty #'toc:text \fromproperty #'toc:page
1374 Note how the toc element text and page number are referred to in
1375 the @code{tocItemMarkup} definition.
1377 New commands and markups may also be defined to build more elaborated
1380 @item first, define a new markup variable in the @code{\paper} block
1381 @item then, define a music function which aims at adding a toc element
1382 using this markup paper variable.
1385 In the following example, a new style is defined for entering act names
1386 in the table of contents of an opera:
1390 tocActMarkup = \markup \large \column {
1392 \fill-line { \null \italic \fromproperty #'toc:text \null }
1398 #(define-music-function (parser location text) (markup?)
1399 (add-toc-item! 'tocActMarkup text))
1402 @lilypond[line-width=11.0\cm]
1403 \header { tagline = ##f }
1405 tocActMarkup = \markup \large \column {
1407 \fill-line { \null \italic \fromproperty #'toc:text \null }
1413 #(define-music-function (parser location text) (markup?)
1414 (add-toc-item! 'tocActMarkup text))
1417 \markuplist \table-of-contents
1418 \tocAct \markup { Atto Primo }
1419 \tocItem \markup { Coro. Viva il nostro Alcide }
1420 \tocItem \markup { Cesare. Presti omai l'Egizzia terra }
1421 \tocAct \markup { Atto Secondo }
1422 \tocItem \markup { Sinfonia }
1423 \tocItem \markup { Cleopatra. V'adoro, pupille, saette d'Amore }
1428 Dots can be added to fill the line between an item and its page number:
1430 @lilypond[verbatim,quote]
1431 \header { tagline = ##f }
1433 tocItemMarkup = \tocItemWithDotsMarkup
1437 \markuplist \table-of-contents
1438 \tocItem \markup { Allegro }
1439 \tocItem \markup { Largo }
1446 Init files: @file{../ly/toc-init.ly}.
1450 @funindex \table-of-contents
1451 @code{\table-of-contents},
1457 @node Working with input files
1458 @section Working with input files
1461 * Including LilyPond files::
1462 * Different editions from one source::
1463 * Special characters::
1467 @node Including LilyPond files
1468 @subsection Including LilyPond files
1471 @cindex including files
1473 A large project may be split up into separate files. To refer to
1477 \include "otherfile.ly"
1480 The line @code{\include "otherfile.ly"} is equivalent to pasting the
1481 contents of @file{otherfile.ly} into the current file at the place
1482 where the @code{\include} appears. For example, in a large
1483 project you might write separate files for each instrument part
1484 and create a @qq{full score} file which brings together the
1485 individual instrument files. Normally the included file will
1486 define a number of variables which then become available
1487 for use in the full score file. Tagged sections can be
1488 marked in included files to assist in making them usable in
1489 different places in a score, see @ref{Different editions from
1492 Files in the current working directory may be referenced by
1493 specifying just the file name after the @code{\include} command.
1494 Files in other locations may be included by giving either a full
1495 path reference or a relative path reference (but use the UNIX
1496 forward slash, /, rather than the DOS/Windows back slash, \, as the
1497 directory separator.) For example, if @file{stuff.ly} is located
1498 one directory higher than the current working directory, use
1501 \include "../stuff.ly"
1505 or if the included orchestral parts files are all located in a
1506 subdirectory called @file{parts} within the current directory, use
1509 \include "parts/VI.ly"
1510 \include "parts/VII.ly"
1514 Files which are to be included can also contain @code{\include}
1515 statements of their own. By default, these second-level
1516 @code{\include} statements are not interpreted until they have
1517 been brought into the main file, so the file names they specify
1518 must all be relative to the directory containing the main file,
1519 not the directory containing the included file. However,
1520 this behavior can be changed by passing the option
1521 @option{-drelative-includes} option at the command line
1522 (or by adding @code{#(ly:set-option 'relative-includes #t)}
1523 at the top of the main input file). With @code{relative-includes}
1524 set, the path for each @code{\include} command will be taken
1525 relative to the file containing that command. This behavior is
1526 recommended and it will become the default behavior in a future
1527 version of lilypond.
1529 Files can also be included from a directory in a search path
1530 specified as an option when invoking LilyPond from the command
1531 line. The included files are then specified using just their
1532 file name. For example, to compile @file{main.ly} which includes
1533 files located in a subdirectory called @file{parts} by this method,
1534 cd to the directory containing @file{main.ly} and enter
1537 lilypond --include=parts main.ly
1540 and in main.ly write
1548 Files which are to be included in many scores may be placed in
1549 the LilyPond directory @file{../ly}. (The location of this
1550 directory is installation-dependent - see
1551 @rlearning{Other sources of information}). These files can then
1552 be included simply by naming them on an @code{\include} statement.
1553 This is how the language-dependent files like @file{english.ly} are
1556 LilyPond includes a number of files by default when you start
1557 the program. These includes are not apparent to the user, but the
1558 files may be identified by running @code{lilypond --verbose} from
1559 the command line. This will display a list of paths and files that
1560 LilyPond uses, along with much other information. Alternatively,
1561 the more important of these files are discussed in
1562 @rlearning{Other sources of information}. These files may be
1563 edited, but changes to them will be lost on installing a new
1564 version of LilyPond.
1566 Some simple examples of using @code{\include} are shown in
1567 @rlearning{Scores and parts}.
1571 @rlearning{Other sources of information},
1572 @rlearning{Scores and parts}.
1575 If an included file is given a name which is the same as one in
1576 LilyPond's installation files, LilyPond's file from the
1577 installation files takes precedence.
1580 @node Different editions from one source
1581 @subsection Different editions from one source
1583 Several methods can be used to generate different versions of a score
1584 from the same music source. Variables are perhaps the most useful for
1585 combining lengthy sections of music and/or annotation. Tags are more
1586 useful for selecting one section from several alternative shorter
1587 sections of music, and can also be used for splicing pieces of music
1588 together at different points.
1590 Whichever method is used, separating the notation from the structure of
1591 the score will make it easier to change the structure while leaving the
1597 * Using global settings::
1600 @node Using variables
1601 @unnumberedsubsubsec Using variables
1603 @cindex variables, use of
1605 If sections of the music are defined in variables they can be
1606 reused in different parts of the score, see @rlearning{Organizing
1607 pieces with variables}. For example, an @notation{a cappella}
1608 vocal score frequently includes a piano reduction of the parts
1609 for rehearsal purposes which is identical to the vocal music, so
1610 the music need be entered only once. Music from two variables
1611 may be combined on one staff, see @ref{Automatic part combining}.
1614 @lilypond[verbatim,quote]
1615 sopranoMusic = \relative c'' { a4 b c b8( a) }
1616 altoMusic = \relative g' { e4 e e f }
1617 tenorMusic = \relative c' { c4 b e d8( c) }
1618 bassMusic = \relative c' { a4 gis a d, }
1619 allLyrics = \lyricmode {King of glo -- ry }
1621 \new Staff = "Soprano" \sopranoMusic
1622 \new Lyrics \allLyrics
1623 \new Staff = "Alto" \altoMusic
1624 \new Lyrics \allLyrics
1625 \new Staff = "Tenor" {
1629 \new Lyrics \allLyrics
1630 \new Staff = "Bass" {
1634 \new Lyrics \allLyrics
1637 \set Staff.printPartCombineTexts = ##f
1643 \set Staff.printPartCombineTexts = ##f
1653 Separate scores showing just the vocal parts or just the piano
1654 part can be produced by changing just the structural statements,
1655 leaving the musical notation unchanged.
1657 For lengthy scores, the variable definitions may be placed in
1658 separate files which are then included, see @ref{Including
1662 @unnumberedsubsubsec Using tags
1665 @funindex \keepWithTag
1666 @funindex \removeWithTag
1667 @funindex \pushToTag
1668 @funindex \appendToTag
1670 @cindex keep tagged music
1671 @cindex remove tagged music
1672 @cindex splice into tagged music
1674 The @code{\tag #'@var{partA}} command marks a music expression
1675 with the name @var{partA}.
1676 Expressions tagged in this way can be selected or filtered out by
1677 name later, using either @code{\keepWithTag #'@var{name}} or
1678 @code{\removeWithTag #'@var{name}}. The result of applying these filters
1679 to tagged music is as follows:
1680 @multitable @columnfractions .5 .5
1684 Tagged music preceded by @code{\keepWithTag #'@var{name}}
1685 @tab Untagged music and music tagged with @var{name} is included;
1686 music tagged with any other tag name is excluded.
1688 Tagged music preceded by @code{\removeWithTag #'@var{name}}
1689 @tab Untagged music and music tagged with any tag name other than
1690 @var{name} is included; music tagged with @var{name} is
1693 Tagged music not preceded by either @code{\keepWithTag} or
1694 @code{\removeWithTag}
1695 @tab All tagged and untagged music is included.
1698 The arguments of the @code{\tag}, @code{\keepWithTag} and
1699 @code{\removeWithTag} commands should be a symbol
1700 (such as @code{#'score} or @code{#'part}), followed
1701 by a music expression.
1703 In the following example, we see two versions of a piece of music,
1704 one showing trills with the usual notation, and one with trills
1705 explicitly expanded:
1707 @lilypond[verbatim,quote]
1708 music = \relative g' {
1710 \tag #'trills { d8.\trill }
1711 \tag #'expand { \repeat unfold 3 { e32 d } }
1716 \keepWithTag #'trills \music
1719 \keepWithTag #'expand \music
1724 Alternatively, it is sometimes easier to exclude sections of music:
1726 @lilypond[verbatim,quote]
1727 music = \relative g' {
1729 \tag #'trills { d8.\trill }
1730 \tag #'expand {\repeat unfold 3 { e32 d } }
1735 \removeWithTag #'expand
1739 \removeWithTag #'trills
1744 Tagged filtering can be applied to articulations, texts, etc. by
1748 -\tag #'@var{your-tag}
1751 to an articulation. For example, this would define a note with a
1752 conditional fingering indication and a note with a conditional
1757 c1-\tag #'warn ^"Watch!"
1760 Multiple tags may be placed on expressions with multiple
1761 @code{\tag} entries:
1763 @lilypond[quote,verbatim]
1764 music = \relative c'' {
1765 \tag #'a \tag #'both { a4 a a a }
1766 \tag #'b \tag #'both { b4 b b b }
1769 \keepWithTag #'a \music
1770 \keepWithTag #'b \music
1771 \keepWithTag #'both \music
1775 Multiple @code{\removeWithTag} filters may be applied to a single
1776 music expression to remove several differently named tagged sections:
1778 @lilypond[verbatim,quote]
1779 music = \relative c'' {
1780 \tag #'A { a4 a a a }
1781 \tag #'B { b4 b b b }
1782 \tag #'C { c4 c c c }
1783 \tag #'D { d4 d d d }
1792 Two or more @code{\keepWithTag} filters applied to a single music
1793 expression will cause @emph{all} tagged sections to be removed, as
1794 the first filter will remove all tagged sections except the one
1795 named, and the second filter will remove even that tagged section.
1797 Sometimes you want to splice some music at a particular place in an
1798 existing music expression. You can use @code{\pushToTag} and
1799 @code{\appendToTag} for adding material at the front or end of the
1800 @code{elements} of an existing music construct. Not every music
1801 construct has @code{elements}, but sequential and simultaneous music are
1804 @lilypond[verbatim,quote]
1805 test = { \tag #'here { \tag #'here <<c''>> } }
1808 \pushToTag #'here c'
1809 \pushToTag #'here e'
1810 \pushToTag #'here g' \test
1811 \appendToTag #'here c'
1812 \appendToTag #'here e'
1813 \appendToTag #'here g' \test
1817 Both commands get a tag, the material to splice in at every occurence of
1818 the tag, and the tagged expression. The commands make sure to
1819 copy everything that they change so that the original @code{\test}
1820 retains its meaning.
1824 @rlearning{Organizing pieces with variables}.
1827 @ref{Automatic part combining},
1828 @ref{Including LilyPond files}.
1832 @c This warning is more general than this placement implies.
1833 @c Rests are not merged whether or not they come from tagged sections.
1834 @c Should be deleted? -td
1838 Multiple rests are not merged if you create a score with more
1839 than one tagged section at the same place.
1843 @node Using global settings
1844 @unnumberedsubsubsec Using global settings
1846 @cindex include-settings
1848 Global settings can be included from a separate file:
1851 lilypond -dinclude-settings=MY_SETTINGS.ly MY_SCORE.ly
1854 Groups of settings such as page size, font or type face can be stored
1855 in separate files. This allows different editions from the same score
1856 as well as standard settings to be applied to many scores, simply by
1857 specifying the proper settings file.
1859 This technique also works well with the use of style sheets, as
1860 discussed in @rlearning{Style sheets}.
1864 @rlearning{Organizing pieces with variables},
1865 @rlearning{Style sheets}.
1868 @ref{Including LilyPond files}.
1870 @node Special characters
1871 @subsection Special characters
1873 @cindex special characters
1874 @cindex non-ASCII characters
1884 @unnumberedsubsubsec Text encoding
1888 LilyPond uses the character repertoire defined by the Unicode
1889 consortium and ISO/IEC 10646. This defines a unique name and
1890 code point for the character sets used in virtually all modern
1891 languages and many others too. Unicode can be implemented using
1892 several different encodings. LilyPond uses the UTF-8 encoding
1893 (UTF stands for Unicode Transformation Format) which represents
1894 all common Latin characters in one byte, and represents other
1895 characters using a variable length format of up to four bytes.
1897 The actual appearance of the characters is determined by the
1898 glyphs defined in the particular fonts available - a font defines
1899 the mapping of a subset of the Unicode code points to glyphs.
1900 LilyPond uses the Pango library to layout and render multi-lingual
1903 LilyPond does not perform any input-encoding conversions. This
1904 means that any text, be it title, lyric text, or musical
1905 instruction containing non-ASCII characters, must be encoded in
1906 UTF-8. The easiest way to enter such text is by using a
1907 Unicode-aware editor and saving the file with UTF-8 encoding. Most
1908 popular modern editors have UTF-8 support, for example, vim, Emacs,
1909 jEdit, and GEdit do. All MS Windows systems later than NT use
1910 Unicode as their native character encoding, so even Notepad can
1911 edit and save a file in UTF-8 format. A more functional
1912 alternative for Windows is BabelPad.
1914 If a LilyPond input file containing a non-ASCII character is not
1915 saved in UTF-8 format the error message
1918 FT_Get_Glyph_Name () error: invalid argument
1923 Here is an example showing Cyrillic, Hebrew and Portuguese
1927 %c No verbatim here as the code does not display correctly in PDF
1929 bulgarian = \lyricmode {
1930 Жълтата дюля беше щастлива, че пухът, който цъфна, замръзна като гьон.
1934 hebrew = \lyricmode {
1935 זה כיף סתם לשמוע איך תנצח קרפד עץ טוב בגן.
1939 portuguese = \lyricmode {
1940 à vo -- cê uma can -- ção legal
1946 \addlyrics { \bulgarian }
1947 \addlyrics { \hebrew }
1948 \addlyrics { \portuguese }
1953 @unnumberedsubsubsec Unicode
1957 To enter a single character for which the Unicode code point is
1958 known but which is not available in the editor being used, use
1959 either @code{\char ##xhhhh} or @code{\char #dddd} within a
1960 @code{\markup} block, where @code{hhhh} is the hexadecimal code for
1961 the character required and @code{dddd} is the corresponding decimal
1962 value. Leading zeroes may be omitted, but it is usual to specify
1963 all four characters in the hexadecimal representation. (Note that
1964 the UTF-8 encoding of the code point should @emph{not} be used
1965 after @code{\char}, as UTF-8 encodings contain extra bits indicating
1966 the number of octets.) Unicode code charts and a character name
1967 index giving the code point in hexadecimal for any character can be
1968 found on the Unicode Consortium website,
1969 @uref{http://www.unicode.org/}.
1971 For example, @code{\char ##x03BE} and @code{\char #958} would both
1972 enter the Unicode U+03BE character, which has the Unicode name
1973 @qq{Greek Small Letter Xi}.
1975 Any Unicode code point may be entered in this way and if all special
1976 characters are entered in this format it is not necessary to save
1977 the input file in UTF-8 format. Of course, a font containing all
1978 such encoded characters must be installed and available to LilyPond.
1980 The following example shows Unicode hexadecimal values being entered
1981 in four places -- in a rehearsal mark, as articulation text, in
1982 lyrics and as stand-alone text below the score:
1984 @lilypond[quote,verbatim]
1987 c1 \mark \markup { \char ##x03EE }
1988 c1_\markup { \tiny { \char ##x03B1 " to " \char ##x03C9 } }
1990 \addlyrics { O \markup { \concat { Ph \char ##x0153 be! } } }
1992 \markup { "Copyright 2008--2011" \char ##x00A9 }
1995 @cindex copyright sign
1997 To enter the copyright sign in the copyright notice use:
2001 copyright = \markup @{ \char ##x00A9 "2008" @}
2007 @unnumberedsubsubsec ASCII aliases
2009 A list of ASCII aliases for special characters can be included:
2011 @lilypond[quote,verbatim]
2013 #(include-special-characters)
2016 \markup "&flqq; – &OE;uvre incomplète… &frqq;"
2019 \new Staff { \repeat unfold 9 a'4 }
2021 This is al -- so wor -- kin'~in ly -- rics: –_&OE;…
2026 "The replacement can be disabled:"
2027 "– &OE; …"
2028 \override #'(replacement-alist . ()) "– &OE; …"
2032 You can also make your own aliases, either globally:
2034 @lilypond[quote,verbatim]
2036 #(add-text-replacements!
2037 '(("100" . "hundred")
2038 ("dpi" . "dots per inch")))
2040 \markup "A 100 dpi."
2045 @lilypond[quote,verbatim]
2046 \markup \replace #'(("100" . "hundred")
2047 ("dpi" . "dots per inch")) "A 100 dpi."
2052 @ref{List of special characters}.
2055 @file{ly/text-replacements.ly}.
2059 @node Controlling output
2060 @section Controlling output
2063 * Extracting fragments of music::
2064 * Skipping corrected music::
2065 * Alternative output formats::
2066 * Replacing the notation font::
2069 @node Extracting fragments of music
2070 @subsection Extracting fragments of music
2072 It is possible to quote small fragments of a large score directly from
2073 the output. This can be compared to clipping a piece of a paper score
2076 This is done by defining the measures that need to be cut out
2077 separately. For example, including the following definition
2085 (make-rhythmic-location 5 1 2)
2086 (make-rhythmic-location 7 3 4)))
2091 will extract a fragment starting halfway the fifth measure, ending in
2092 the seventh measure. The meaning of @code{5 1 2} is: after a 1/2 note
2093 in measure 5, and @code{7 3 4} after 3 quarter notes in measure 7.
2095 More clip regions can be defined by adding more pairs of
2096 rhythmic-locations to the list.
2098 In order to use this feature, LilyPond must be invoked with
2099 @option{-dclip-systems}. The clips are output as EPS files, and are
2100 converted to PDF and PNG if these formats are switched on as well.
2102 For more information on output formats, see @rprogram{Invoking lilypond}.
2104 @node Skipping corrected music
2105 @subsection Skipping corrected music
2108 @funindex skipTypesetting
2109 @funindex showFirstLength
2110 @funindex showLastLength
2112 When entering or copying music, usually only the music near the end (where
2114 are adding notes) is interesting to view and correct. To speed up
2115 this correction process, it is possible to skip typesetting of all but
2116 the last few measures. This is achieved by putting
2119 showLastLength = R1*5
2124 in your source file. This will render only the last 5 measures
2125 (assuming 4/4 time signature) of every @code{\score} in the input
2126 file. For longer pieces, rendering only a small part is often an order
2127 of magnitude quicker than rendering it completely. When working on the
2128 beginning of a score you have already typeset (e.g. to add a new part),
2129 the @code{showFirstLength} property may be useful as well.
2131 Skipping parts of a score can be controlled in a more fine-grained
2132 fashion with the property @code{Score.skipTypesetting}. When it is
2133 set, no typesetting is performed at all.
2135 This property is also used to control output to the MIDI file. Note that
2136 it skips all events, including tempo and instrument changes. You have
2139 @lilypond[quote,relative=2,ragged-right,verbatim]
2141 \set Score.skipTypesetting = ##t
2143 \set Score.skipTypesetting = ##f
2147 In polyphonic music, @code{Score.skipTypesetting} will affect all
2148 voices and staves, saving even more time.
2150 @node Alternative output formats
2151 @subsection Alternative output formats
2153 @cindex scalable vector graphics output
2155 @cindex encapsulated postscript output
2158 The default output formats for the printed score are Portable
2159 Document Format (PDF) and PostScript (PS). Scalable Vector
2160 Graphics (SVG), Encapsulated PostScript (EPS) and Portable
2161 Network Graphics (PNG) output formats are also available through
2162 command line options, see @rprogram{Command line options for
2166 @node Replacing the notation font
2167 @subsection Replacing the notation font
2169 Gonville is an alternative to the Feta font used in LilyPond and can
2172 @uref{http://www.chiark.greenend.org.uk/~sgtatham/gonville/ ,http://www.chiark.greenend.org.uk/~sgtatham/gonville/}
2175 Here are a few sample bars of music set in Gonville:
2177 @c NOTE: these images are a bit big, but that's important
2178 @c for the font comparison. -gp
2179 @sourceimage{Gonville_after,,,}
2181 Here are a few sample bars of music set in LilyPond's Feta font:
2183 @sourceimage{Gonville_before,,,}
2185 @subsubheading Installation Instructions for MacOS
2187 Download and extract the zip file. Copy the @code{lilyfonts}
2188 directory to @file{@var{SHARE_DIR}/lilypond/current}; for more
2189 information, see @rlearning{Other sources of information}. Rename the
2190 existing @code{fonts} directory to @code{fonts_orig} and the
2191 @code{lilyfonts} directory to @code{fonts}. To revert back to Feta,
2192 reverse the process.
2195 Learning Manual: @rlearning{Other sources of information}.
2198 Gonville cannot be used to typeset @q{Ancient Music} notation and it is
2199 likely newer glyphs in later releases of LilyPond may not exist in the
2200 Gonville font family. Please refer to the author's website for more
2201 information on these and other specifics, including licensing of
2206 @section MIDI output
2211 MIDI (Musical Instrument Digital Interface) is a standard for
2212 connecting and controlling digital instruments. A MIDI file is a
2213 series of notes in a number of tracks. It is not an actual
2214 sound file; you need special software to translate between the
2215 series of notes and actual sounds.
2217 Pieces of music can be converted to MIDI files, so you can listen to
2218 what was entered. This is convenient for checking the music; octaves
2219 that are off or accidentals that were mistyped stand out very much
2220 when listening to the MIDI output.
2222 Standard MIDI oputput is somewhat crude; optionally, an enhanced and
2223 more realistic MIDI output is available by means of
2224 @ref{The Articulate script}.
2226 The MIDI output allocates a channel for each staff, and reserves channel
2227 10 for drums. There are only 16 MIDI channels per device, so if the
2228 score contains more than 15 staves, MIDI channels will be reused.
2231 * Creating MIDI files::
2233 * What goes into the MIDI output?::
2235 * Controlling MIDI dynamics::
2236 * Percussion in MIDI::
2237 * The Articulate script::
2240 @node Creating MIDI files
2241 @subsection Creating MIDI files
2243 To create a MIDI output file from a LilyPond input file, add a
2244 @code{\midi} block to a score, for example,
2253 If there is a @code{\midi} block in a @code{\score} with no
2254 @code{\layout} block, only MIDI output will be produced. When
2255 notation is needed too, a @code{\layout} block must also be
2266 Pitches, rhythms, ties, dynamics, and tempo changes are interpreted
2267 and translated correctly to the MIDI output. Dynamic marks,
2268 crescendi and decrescendi translate into MIDI volume levels.
2269 Dynamic marks translate to a fixed fraction of the available MIDI
2270 volume range. Crescendi and decrescendi make the volume vary
2271 linearly between their two extremes. The effect of dynamic markings
2272 on the MIDI output can be removed completely, see @ref{MIDI block}.
2274 The initial tempo and later tempo changes can be specified
2275 with the @code{\tempo} command within the music notation. These
2276 are reflected in tempo changes in the MIDI output. This command
2277 will normally result in the metronome mark being printed, but this
2278 can be suppressed, see @ref{Metronome marks}. An alternative way
2279 of specifying the initial or overall MIDI tempo is described below,
2280 see @ref{MIDI block}.
2282 Due to some limitations on Windows, the default extension for
2283 MIDI files on Windows is @code{.mid}. Other operating systems still
2284 use the extension @code{.midi}. If a different extension is preferred,
2285 insert the following line at the top-level of the input file,
2286 before the start of any @code{\book}, @code{\bookpart} or @code{\score} blocks:
2289 #(ly:set-option 'midi-extension "midi")
2292 The line above will set the default extension for MIDI files to
2295 Alternatively, this option can also be supplied on the command line:
2298 lilypond … -dmidi-extension=midi lilyFile.ly
2302 @unnumberedsubsubsec Instrument names
2304 @cindex instrument names
2305 @funindex Staff.midiInstrument
2307 The MIDI instrument to be used is specified by setting the
2308 @code{Staff.midiInstrument} property to the instrument name.
2309 The name should be chosen from the list in @ref{MIDI instruments}.
2313 \set Staff.midiInstrument = #"glockenspiel"
2319 \new Staff \with @{midiInstrument = #"cello"@} @{
2324 If the selected instrument does not exactly match an instrument from
2325 the list of MIDI instruments, the Grand Piano (@code{"acoustic grand"})
2331 @lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle]
2332 {changing-midi-output-to-one-channel-per-voice.ly}
2336 @c In 2.11 the following no longer seems to be a problem -td
2338 Unterminated (de)crescendos will not render properly in the midi file,
2339 resulting in silent passages of music. The workaround is to explicitly
2340 terminate the (de)crescendo. For example,
2347 will not work properly but
2350 @{ a4\< b c d\!\f @}
2357 Changes in the MIDI volume take place only on starting a note, so
2358 crescendi and decrescendi cannot affect the volume of a
2361 Not all midi players correctly handle tempo changes in the midi
2362 output. Players that are known to work include MS Windows Media
2363 Player and @uref{http://@/timidity@/.sourceforge@/.net/,timidity}.
2366 @subsection MIDI block
2369 A @code{\midi} block must appear within a score block if MIDI output
2370 is required. It is analogous to the layout block, but somewhat
2371 simpler. Often, the @code{\midi} block is left empty, but it
2372 can contain context rearrangements, new context definitions or code
2373 to set the values of properties. For example, the following will
2374 set the initial tempo exported to a MIDI file without causing a tempo
2375 indication to be printed:
2383 tempoWholesPerMinute = #(ly:make-moment 72 4)
2389 In this example the tempo is set to 72 quarter note
2390 beats per minute. This kind of tempo specification cannot take
2391 a dotted note length as an argument. If one is required, break
2392 the dotted note into smaller units. For example, a tempo of 90
2393 dotted quarter notes per minute can be specified as 270 eighth
2397 tempoWholesPerMinute = #(ly:make-moment 270 8)
2400 @cindex MIDI context definitions
2402 Context definitions follow precisely the same syntax as those
2403 within a @code{\layout} block. Translation modules for sound are
2404 called performers. The contexts for MIDI output are defined in
2405 @file{../ly/performer-init.ly},
2406 see @rlearning{Other sources of information}.
2407 For example, to remove the effect of dynamics
2408 from the MIDI output, insert the following lines in the
2409 @code{\midi@{ @}} block.
2416 \remove "Dynamic_performer"
2421 MIDI output is created only when a @code{\midi} block is included
2422 within a score block defined with a @code{\score} command.
2426 @{ @dots{}notes@dots{} @}
2431 @node What goes into the MIDI output?
2432 @subsection What goes into the MIDI output?
2434 @c TODO Check grace notes - timing is suspect?
2436 @unnumberedsubsubsec Supported in MIDI
2438 @cindex Pitches in MIDI
2439 @cindex MIDI, Pitches
2440 @cindex Quarter tones in MIDI
2441 @cindex MIDI, quarter tones
2442 @cindex Microtones in MIDI
2443 @cindex MIDI, microtones
2444 @cindex Chord names in MIDI
2445 @cindex MIDI, chord names
2446 @cindex Rhythms in MIDI
2447 @cindex MIDI, Rhythms
2448 @cindex Articlulate scripts
2449 @cindex MIDI, articulations
2450 @cindex articulations in MIDI
2451 @cindex trills in MIDI
2452 @cindex turns in MIDI
2453 @cindex rallentando in MIDI
2454 @cindex accelerando in MIDI
2457 The following items of notation are reflected in the MIDI output:
2461 @item Microtones (See @ref{Accidentals}. Rendering needs a
2462 player that supports pitch bend.)
2463 @item Chords entered as chord names
2464 @item Rhythms entered as note durations, including tuplets
2465 @item Tremolos entered without @q{@code{:}[@var{number}]}
2468 @item Crescendi, decrescendi over multiple notes
2469 @item Tempo changes entered with a tempo marking
2473 Using @ref{The Articulate script}, a number of items are added to the
2477 @item Articulations (slurs, staccato, etc)
2479 @item Rallentando and accelerando
2483 @unnumberedsubsubsec Unsupported in MIDI
2485 @c TODO index as above
2487 The following items of notation have no effect on the MIDI output,
2488 unless you use @ref{The Articulate script}:
2491 @item Rhythms entered as annotations, e.g. swing
2492 @item Tempo changes entered as annotations with no tempo marking
2493 @item Staccato and other articulations and ornamentations
2494 @item Slurs and Phrasing slurs
2495 @item Crescendi, decrescendi over a single note
2496 @item Tremolos entered with @q{@code{:}[@var{number}]}
2498 @item Microtonal chords
2502 @node Repeats in MIDI
2503 @subsection Repeats in MIDI
2505 @cindex repeats in MIDI
2506 @funindex \unfoldRepeats
2508 With a few minor additions, all types of repeats can be represented
2509 in the MIDI output. This is achieved by applying the
2510 @code{\unfoldRepeats} music function. This function changes all
2511 repeats to unfold repeats.
2513 @lilypond[quote,verbatim]
2515 \repeat tremolo 8 { c'32 e' }
2516 \repeat percent 2 { c''8 d'' }
2517 \repeat volta 2 { c'4 d' e' f' }
2526 In scores containing multiple voices, unfolding of repeats in MIDI
2527 output will only occur correctly if @emph{each} voice contains fully
2528 notated repeat indications.
2530 When creating a score file using @code{\unfoldRepeats} for MIDI,
2531 it is necessary to make two @code{\score} blocks: one for MIDI
2532 (with unfolded repeats) and one for notation (with volta, tremolo,
2533 and percent repeats). For example,
2541 \unfoldRepeats @var{..music..}
2546 @node Controlling MIDI dynamics
2547 @subsection Controlling MIDI dynamics
2549 MIDI dynamics are implemented by the Dynamic_performer which lives
2550 by default in the Voice context. It is possible to control the
2551 overall MIDI volume, the relative volume of dynamic markings and
2552 the relative volume of different instruments.
2554 @unnumberedsubsubsec Dynamic marks
2556 Dynamic marks are translated to a fixed fraction of the available
2557 MIDI volume range. The default fractions range from 0.25 for
2558 @notation{ppppp} to 0.95 for @notation{fffff}. The set of dynamic
2559 marks and the associated fractions can be seen in
2560 @file{../scm/midi.scm}, see @rlearning{Other sources of information}.
2561 This set of fractions may be changed or extended by providing a
2562 function which takes a dynamic mark as its argument and returns the
2563 required fraction, and setting
2564 @code{Score.dynamicAbsoluteVolumeFunction} to this function.
2566 For example, if a @notation{rinforzando} dynamic marking,
2567 @code{\rfz}, is required, this will not by default
2568 have any effect on the MIDI volume, as this dynamic marking is not
2569 included in the default set. Similarly, if a new dynamic marking
2570 has been defined with @code{make-dynamic-script} that too will not
2571 be included in the default set. The following example shows how the
2572 MIDI volume for such dynamic markings might be added. The Scheme
2573 function sets the fraction to 0.9 if a dynamic mark of rfz is
2574 found, or calls the default function otherwise.
2576 @lilypond[verbatim,quote]
2577 #(define (myDynamics dynamic)
2578 (if (equal? dynamic "rfz")
2580 (default-dynamic-absolute-volume dynamic)))
2584 \set Staff.midiInstrument = #"cello"
2585 \set Score.dynamicAbsoluteVolumeFunction = #myDynamics
2597 Alternatively, if the whole table of fractions needs to be
2598 redefined, it would be better to use the
2599 @notation{default-dynamic-absolute-volume} procedure in
2600 @file{../scm/midi.scm} and the associated table as a model.
2601 The final example in this section shows how this might be done.
2603 @unnumberedsubsubsec Overall MIDI volume
2605 The minimum and maximum overall volume of MIDI dynamic markings is
2606 controlled by setting the properties @code{midiMinimumVolume} and
2607 @code{midiMaximumVolume} at the @code{Score} level. These
2608 properties have an effect only on dynamic marks, so if they
2609 are to apply from the start of the score a dynamic mark must be
2610 placed there. The fraction corresponding to each dynamic mark is
2611 modified with this formula
2614 midiMinimumVolume + (midiMaximumVolume - midiMinimumVolume) * fraction
2617 In the following example the dynamic range of the overall MIDI
2618 volume is limited to the range 0.2 - 0.5.
2620 @lilypond[verbatim,quote]
2626 \set Staff.midiInstrument = #"flute"
2627 \new Voice \relative c''' {
2635 \set Staff.midiInstrument = #"clarinet"
2636 \new Voice \relative c'' {
2647 tempoWholesPerMinute = #(ly:make-moment 72 2)
2648 midiMinimumVolume = #0.2
2649 midiMaximumVolume = #0.5
2655 @unnumberedsubsubsec Equalizing different instruments (i)
2657 If the minimum and maximum MIDI volume properties are set in
2658 the @code{Staff} context the relative volumes of the MIDI
2659 instruments can be controlled. This gives a basic instrument
2660 equalizer, which can enhance the quality of the MIDI output
2663 In this example the volume of the clarinet is reduced relative
2664 to the volume of the flute. There must be a dynamic
2665 mark on the first note of each instrument for this to work
2668 @lilypond[verbatim,quote]
2674 \set Staff.midiInstrument = #"flute"
2675 \set Staff.midiMinimumVolume = #0.7
2676 \set Staff.midiMaximumVolume = #0.9
2677 \new Voice \relative c''' {
2685 \set Staff.midiInstrument = #"clarinet"
2686 \set Staff.midiMinimumVolume = #0.3
2687 \set Staff.midiMaximumVolume = #0.6
2688 \new Voice \relative c'' {
2699 tempoWholesPerMinute = #(ly:make-moment 72 2)
2705 @unnumberedsubsubsec Equalizing different instruments (ii)
2707 If the MIDI minimum and maximum volume properties are not set
2708 LilyPond will, by default, apply a small degree of equalization
2709 to a few instruments. The instruments and the equalization
2710 applied are shown in the table @notation{instrument-equalizer-alist}
2711 in @file{../scm/midi.scm}.
2713 This basic default equalizer can be replaced by setting
2714 @code{instrumentEqualizer} in the @code{Score} context to a new
2715 Scheme procedure which accepts a MIDI instrument name as its only
2716 argument and returns a pair of fractions giving the minimum and
2717 maximum volumes to be applied to that instrument. This replacement
2718 is done in the same way as shown for resetting the
2719 @code{dynamicAbsoluteVolumeFunction} at the start of this section.
2720 The default equalizer, @notation{default-instrument-equalizer}, in
2721 @file{../scm/midi.scm} shows how such a procedure might be written.
2723 The following example sets the relative flute and clarinet volumes
2724 to the same values as the previous example.
2726 @lilypond[verbatim,quote]
2727 #(define my-instrument-equalizer-alist '())
2729 #(set! my-instrument-equalizer-alist
2732 ("flute" . (0.7 . 0.9))
2733 ("clarinet" . (0.3 . 0.6)))
2734 my-instrument-equalizer-alist))
2736 #(define (my-instrument-equalizer s)
2737 (let ((entry (assoc s my-instrument-equalizer-alist)))
2746 \set Score.instrumentEqualizer = #my-instrument-equalizer
2747 \set Staff.midiInstrument = #"flute"
2748 \new Voice \relative c''' {
2756 \set Staff.midiInstrument = #"clarinet"
2757 \new Voice \relative c'' {
2768 tempoWholesPerMinute = #(ly:make-moment 72 2)
2775 @c Delete when satisfied this is adequately covered elsewhere -td
2777 @n ode Microtones in MIDI
2778 @s ubsection Microtones in MIDI
2780 @cindex microtones in MIDI
2782 Microtones consisting of half sharps and half flats are exported
2783 to the MIDI file and render correctly in MIDI players which support
2784 pitch bending. See @ref{Note names in other languages}. Here is
2785 an example showing all the half sharps and half flats. It can be
2786 copied out and compiled to test microtones in your MIDI player.
2788 @lilypond[verbatim,quote]
2805 @node Percussion in MIDI
2806 @subsection Percussion in MIDI
2808 Percussion instruments are generally notated in a @code{DrumStaff}
2809 context and when notated in this way they are outputted correctly
2810 to MIDI channel@tie{}10, but some pitched percussion instruments,
2811 like the xylophone, marimba, vibraphone, timpani, etc., are
2812 treated like @qq{normal} instruments and music for these instruments
2813 should be entered in a normal @code{Staff} context, not a
2814 @code{DrumStaff} context, to obtain the correct MIDI output.
2816 Some non-pitched percussion sounds included in the general MIDI
2817 standard, like melodic tom, taiko drum, synth drum, etc., cannot
2818 be reached via MIDI channel@tie{}10, so the notation for such
2819 instruments should also be entered in a normal @code{Staff}
2820 context, using suitable normal pitches.
2822 Many percussion instruments are not included in the general MIDI
2823 standard, e.g. castanets. The easiest, although unsatisfactory,
2824 method of producing some MIDI output when writing for such
2825 instruments is to substitute the nearest sound from the standard
2828 @c TODO Expand with examples, and any other issues
2832 Because the general MIDI standard does not contain rim shots, the
2833 sidestick is used for this purpose instead.
2835 @node The Articulate script
2836 @subsection The Articulate script
2838 A more realistic MIDI output is possible when using the Articulate
2839 script. It tries to take articulations (slurs, staccato, etc) into
2840 account, by replacing notes with sequential music of suitably
2841 time-scaled note plus skip. It also tries to unfold trills turns
2842 etc., and take rallentando and accelerando into account.
2844 To use the Articulate script, you have to include it at the top of
2848 \include "articulate.ly"
2851 and in the @code{\score} section do
2854 \unfoldRepeats \articulate <<
2855 all the rest of the score...
2859 After altering your input file this way, the visual output is heavily
2860 altered, but the standard @code{\midi} block will produce a better
2863 Although not essential for the Articulate script to work, you may want
2864 to insert the @code{\unfoldRepeats} command as it appears in the
2865 example shown above as it enables performing abbreviatures such as
2870 Articulate shortens chords and some music (esp. organ music) could
2874 @node Extracting musical information
2875 @section Extracting musical information
2877 In addition to creating graphical output and MIDI, LilyPond can
2878 display musical information as text.
2881 * Displaying LilyPond notation::
2882 * Displaying scheme music expressions::
2883 * Saving music events to a file::
2886 @node Displaying LilyPond notation
2887 @subsection Displaying LilyPond notation
2889 @funindex \displayLilyMusic
2890 Displaying a music expression in LilyPond notation can be
2891 done with the music function @code{\displayLilyMusic}. To see the
2892 output, you will typically want to call LilyPond using the command
2897 \displayLilyMusic \transpose c a, @{ c4 e g a bes @}
2904 @{ a,4 cis e fis g @}
2907 By default, LilyPond will print these messages to the console
2908 along with all the other LilyPond compilation messages. To split
2909 up these messages and save the results of @code{\display@{STUFF@}},
2910 redirect the output to a file.
2913 lilypond file.ly >display.txt
2917 Note that Lilypond does not just display the music expression, but
2918 also interprets it (since @code{\displayLilyMusic} returns it in
2919 addition to displaying it). This is convenient since you can just
2920 insert @code{\displayLilyMusic} into existing music in order to get
2921 information about it. If you don't actually want Lilypond to
2922 interpret the displayed music as well as display it, use @code{\void}
2923 in order to have it ignored:
2927 \void \displayLilyMusic \transpose c a, @{ c4 e g a bes @}
2932 @node Displaying scheme music expressions
2933 @subsection Displaying scheme music expressions
2935 See @rextend{Displaying music expressions}.
2938 @node Saving music events to a file
2939 @subsection Saving music events to a file
2941 Music events can be saved to a file on a per-staff basis by
2942 including a file in your main score.
2945 \include "event-listener.ly"
2948 This will create file(s) called @file{FILENAME-STAFFNAME.notes} or
2949 @file{FILENAME-unnamed-staff.notes} for each staff. Note that if
2950 you have multiple unnamed staves, the events for all staves will
2951 be mixed together in the same file. The output looks like this:
2954 0.000 note 57 4 p-c 2 12
2956 0.250 note 62 4 p-c 7 12
2957 0.500 note 66 8 p-c 9 12
2958 0.625 note 69 8 p-c 14 12
2963 The syntax is a tab-delimited line, with two fixed fields on each
2964 line followed by optional parameters.
2967 @var{time} @var{type} @var{...params...}
2970 This information can easily be read into other programs such as
2971 python scripts, and can be very useful for researchers wishing to
2972 perform musical analysis or playback experiments with LilyPond.
2977 Not all lilypond music events are supported by
2978 @file{event-listener.ly}. It is intended to be a well-crafted
2979 @qq{proof of concept}. If some events that you want to see are
2980 not included, copy @file{event-listener.ly} into your lilypond
2981 directory and modify the file so that it outputs the information