1 @c -*- coding: utf-8; mode: texinfo; -*-
2 @c This file is part of lilypond.tely
4 @c A menu is needed before every deeper *section nesting of @node's; run
5 @c M-x texinfo-all-menus-update
6 @c to automatically fill in these menus before saving changes
11 This section deals with general lilypond issues, rather than
16 * A single music expression::
17 * Titles and headers::
20 * Multiple movements::
28 The main format of input for LilyPond are text files. By convention,
29 these files end with ``@code{.ly}''.
32 * File structure (introduction)::
34 * Including LilyPond files::
39 @node File structure (introduction)
40 @subsection File structure (introduction)
42 A basic example of a lilypond input file is
47 @{ @} % this is a single music expression;
48 % all the music goes in here.
56 There are many variations of this basic pattern, but this
57 example serves as a useful starting place.
59 The major part of this manual is concerned with entering various
60 forms of music in LilyPond. However, many music expressions are not
61 valid input on their own, for example, a @code{.ly} file containing
68 will result in a parsing error. Instead, music should be inside other
69 expressions, which may be put in a file by themselves. Such
70 expressions are called toplevel expressions. The next section enumerates
75 @subsection File structure
77 A @code{.ly} file contains any number of toplevel expressions, where a
78 toplevel expression is one of the following
82 An output definition, such as @code{\paper}, @code{\midi}, and
83 @code{\layout}. Such a definition at the toplevel changes the default
84 settings for the block entered.
87 A direct scheme expression, such as
88 @code{#(set-default-paper-size "a7" 'landscape)} or
89 @code{#(ly:set-option 'point-and-click #f)}.
92 A @code{\header} block. This sets the global header block. This
93 is the block containing the definitions for book-wide settings, like
97 An @code{\addquote} statement. See @ref{Quoting other voices}
101 A @code{\score} block. This score will be collected with other
102 toplevel scores, and combined as a single @code{\book}.
104 This behavior can be changed by setting the variable
105 @code{toplevel-score-handler} at toplevel. The default handler is
106 defined in the init file @file{scm/@/lily@/.scm}.
108 The @code{\score} must begin with a music expression, and may
109 contain only one music expression.
112 A @code{\book} block logically combines multiple movements
113 (i.e., multiple @code{\score} blocks) in one document. If there are
114 a number of @code{\scores}, a single output file will be created
115 in which all movements are concatenated.
117 This behavior can be changed by setting the variable
118 @code{toplevel-book-handler} at toplevel. The default handler is
119 defined in the init file @file{scm/@/lily@/.scm}.
122 A compound music expression, such as
127 This will add the piece in a @code{\score} and format it in a
128 single book together with all other toplevel @code{\score}s and music
129 expressions. In other words, a file containing only the above
130 music expression will be translated into
146 This behavior can be changed by setting the variable
147 @code{toplevel-music-handler} at toplevel. The default handler is
148 defined in the init file @file{scm/@/lily@/.scm}.
151 A markup text, a verse for example
154 2. The first line verse two.
158 Markup texts are rendered above, between or below the scores or music
159 expressions, wherever they appear.
162 An identifier, such as
167 This can be used later on in the file by entering @code{\foo}. The
168 name of an identifier should have alphabetic characters only; no
169 numbers, underscores or dashes.
173 The following example shows three things that may be entered at
178 % movements are non-justified by default
190 At any point in a file, any of the following lexical instructions can
194 @item @code{\version}
195 @item @code{\include}
196 @item @code{\renameinput}
200 @node Including LilyPond files
201 @subsection Including LilyPond files
203 @cindex @code{\include}
204 @cindex including files
206 A large project may be split up into separate files. To refer to another
210 \include "otherfile.ly"
213 The line @code{\include "file.ly"} is equivalent to pasting the contents
214 of file.ly into the current file at the place where you have the
215 \include. For example, for a large project you might write separate files
216 for each instrument part and create a ``full score'' file which brings
217 together the individual instrument files.
219 The initialization of LilyPond is done in a number of files that are
220 included by default when you start the program, normally transparent to the
221 user. Run lilypond --verbose to see a list of paths and files that Lily
224 Files placed in directory @file{PATH/TO/share/lilypond/VERSION/ly/} (where
225 VERSION is in the form ``2.6.1'') are on the path and available to
226 @code{\include}. Files in the
227 current working directory are available to \include, but a file of the same
228 name in LilyPond's installation takes precedence. Files are
229 available to \include from directories in the search path specified as an
230 option when invoking @code{lilypond --include=DIR} which adds DIR to the search
233 The @code{\include} statement can use full path information, but with the Unix
234 convention @code{"/"} rather than the DOS/Windows @code{"\"}. For example,
235 if @file{stuff.ly} is located one directory higher than the current working
239 \include "../stuff.ly"
244 @subsection Text encoding
246 LilyPond uses the Pango library to format multi-lingual texts, and
247 does not perform any input-encoding conversions. This means that any
248 text, be it title, lyric text, or musical instruction containing
249 non-ASCII characters, must be utf-8. The easiest way to enter such text is
250 by using a Unicode-aware editor and saving the file with utf-8 encoding. Most
251 popular modern editors have utf-8 support, for example, vim, Emacs,
254 Depending on the fonts installed, the following fragment shows Hebrew
261 @lilypondfile[fontload]{utf-8.ly}
263 The @TeX{} backend does not handle encoding specially at all. Strings
264 in the input are put in the output as-is. Extents of text items in the
265 @TeX{} backend, are determined by reading a file created via the
266 @file{texstr} backend,
269 lilypond -b texstr input/les-nereides.ly
270 latex les-nereides.texstr
273 The last command produces @file{les-nereides.textmetrics}, which is
274 read when you execute
277 lilypond -b tex input/les-nereides.ly
280 Both @file{les-nereides.texstr} and @file{les-nereides.tex} need
281 suitable LaTeX wrappers to load appropriate La@TeX{} packages for
282 interpreting non-ASCII strings.
284 To use a Unicode escape sequence, use
287 #(ly:export (ly:wide-char->utf-8 #x2014))
293 @inputfileref{input/regression,utf-8.ly}
297 @node A single music expression
298 @section A single music expression
300 A @code{\score} must contain a single music expression. However,
301 this music expression may be of any size. Recall that music
302 expressions may be included inside other expressions to form
303 larger expressions. All of these examples are single music
304 expressions; note the curly braces @{ @} or angle brackets <<
305 >> at the beginning and ending of the music.
311 @lilypond[ragged-right,verbatim,quote]
318 @lilypond[ragged-right,verbatim,quote]
320 \new Staff { c'4 c' c' c' }
321 \new Staff { d'4 d' d' d' }
329 \new Staff @{ \flute @}
330 \new Staff @{ \oboe @}
333 \new Staff @{ \violinI @}
334 \new Staff @{ \violinII @}
341 @node Titles and headers
342 @section Titles and headers
344 Almost all printed music includes a title and the composer's name;
345 some pieces include a lot more information.
353 @node Creating titles
354 @subsection Creating titles
356 Titles are created for each @code{\score} block, and over a
359 The contents of the titles are taken from the @code{\header} blocks.
360 The header block for a book supports the following
363 The dedicatee of the music, centered at the top of the first page.
366 The title of the music, centered just below the dedication.
369 Subtitle, centered below the title.
372 Subsubtitle, centered below the subtitle.
375 Name of the poet, flush-left below the subtitle.
378 Name of the composer, flush-right below the subtitle.
381 Meter string, flush-left below the poet.
384 Name of the opus, flush-right below the composer.
387 Name of the arranger, flush-right below the opus.
390 Name of the instrument, centered below the arranger. Also
391 centered at the top of pages (other than the first page).
394 Name of the piece, flush-left below the instrument.
396 @cindex page breaks, forcing
398 This forces the title to start on a new page (set to ##t or ##f).
401 Copyright notice, centered at the bottom of the first page. To
402 insert the copyright symbol, see @ref{Text encoding}.
405 Centered at the bottom of the last page.
409 Here is a demonstration of the fields available. Note that you
410 may use any @ref{Text markup} commands in the header.
412 @lilypond[quote,verbatim,line-width=11.0\cm]
415 paper-height = 10.0\cm
420 dedication = "dedicated to me"
421 title = \markup \center-align { "Title first line" "Title second line, longer" }
422 subtitle = "the subtitle,"
423 subsubtitle = #(string-append "subsubtitle LilyPond version " (lilypond-version))
425 composer = \markup \center-align { "composer" \small "(1847-1973)" }
426 texttranslator = "Text Translator"
427 meter = \markup { \teeny "m" \tiny "e" \normalsize "t" \large "e" \huge "r" }
428 arranger = \markup { \fontsize #8.5 "a" \fontsize #2.5 "r" \fontsize #-2.5 "r" \fontsize #-5.3 "a" \fontsize #7.5 "nger" }
429 instrument = \markup \bold \italic "instrument"
453 As demonstrated before, you can use multiple @code{\header} blocks.
454 When same fields appear in different blocks, the latter is used.
455 Here is a short example.
459 composer = "Composer"
467 piece = "New piece" % overwrite previous one
472 If you define the @code{\header} inside the @code{\score} block, then
473 normally only the @code{piece} and @code{opus} headers will be printed.
474 Note that the music expression must come before the @code{\header}.
476 @lilypond[quote,verbatim,line-width=11.0\cm]
480 title = "title" % not printed
487 @cindex @code{printallheaders}
489 You may change this behavior (and print all the headers when defining
490 @code{\header} inside @code{\score}) by using
500 @subsection Custom titles
502 A more advanced option is to change the definitions of the following
503 variables in the @code{\paper} block. The init file
504 @file{ly/titling-init.ly} lists the default layout.
507 @cindex @code{bookTitleMarkup}
508 @item bookTitleMarkup
509 This is the title put over an entire @code{\book} block. Typically,
510 it has the composer and the title of the piece
512 @cindex @code{scoreTitleMarkup}
513 @item scoreTitleMarkup
514 This is the title put over a @code{\score} block within a
515 @code{\book}. Typically, it has the name of the movement (@code{piece}
518 @cindex @code{oddHeaderMarkup}
519 @item oddHeaderMarkup
520 This is the page header for odd-numbered pages.
522 @cindex @code{evenHeaderMarkup}
523 @item evenHeaderMarkup
524 This is the page header for even-numbered pages. If unspecified,
525 the odd header is used instead.
527 By default, headers are defined such that the page number is on the
528 outside edge, and the instrument is centered.
530 @cindex @code{oddFooterMarkup}
531 @item oddFooterMarkup
532 This is the page footer for odd-numbered pages.
534 @cindex @code{evenFotterMarkup}
535 @item evenFooterMarkup
536 This is the page footer for even-numbered pages. If unspecified,
537 the odd header is used instead.
539 By default, the footer has the copyright notice on the first, and
540 the tagline on the last page.
550 The following definition will put the title flush left, and the
551 composer flush right on a single line.
555 bookTitleMarkup = \markup {
557 \fromproperty #'header:title
558 \fromproperty #'header:composer
567 The @code{breakbefore=##t} header requires that there is a @code{piece} header as well. It may be used as a normal header, or left blank (@code{=""}) as in the example above, but it must be present.
571 @node Paper and pages
572 @section Paper and pages
574 This section deals with the display of music on physical paper.
583 @subsection Paper size
587 @cindex @code{papersize}
589 To change the paper size, there are two commands,
591 #(set-default-paper-size "a4")
593 #(set-paper-size "a4")
597 The first command sets the size of all pages. The second command sets the size
598 of the pages that the @code{\paper} block applies to -- if the @code{\paper}
599 block is at the top of the file, then it will apply to all pages. If the
600 @code{\paper} block is inside a @code{\book}, then the paper size will only
603 Support for the following paper sizes are included by default,
604 @code{a6}, @code{a5}, @code{a4}, @code{a3}, @code{legal}, @code{letter},
605 @code{11x17} (also known as tabloid).
607 Extra sizes may be added by editing the definition for
608 @code{paper-alist} in the initialization file @file{scm/paper.scm}.
613 If the symbol @code{landscape} is supplied as an argument to
614 @code{set-default-paper-size}, the pages will be rotated by 90 degrees,
615 and wider line widths will be set correspondingly.
618 #(set-default-paper-size "a6" 'landscape)
621 Setting the paper size will adjust a number of @code{\paper} variables
622 (such as margins). To use a particular paper size with altered
623 @code{\paper} variables, set the paper size before setting the variables.
626 @node Page formatting
627 @subsection Page formatting
629 @cindex page formatting
634 LilyPond will do page layout, set margins, and add headers and
635 footers to each page.
637 The default layout responds to the following settings in the
640 @cindex @code{\paper}
644 @cindex @code{first-page-number}
645 @item first-page-number
646 The value of the page number of the first page. Default is@tie{}1.
648 @cindex @code{printfirst-page-number}
649 @item printfirst-page-number
650 If set to true, will print the page number in the first page. Default is
653 @cindex @code{print-page-number}
654 @item print-page-number
655 If set to false, page numbers will not be printed.
657 @cindex @code{paper-width}
659 The width of the page.
661 @cindex @code{paper-height}
663 The height of the page.
665 @cindex @code{top-margin}
667 Margin between header and top of the page.
669 @cindex @code{bottom-margin}
671 Margin between footer and bottom of the page.
673 @cindex @code{left-margin}
675 Margin between the left side of the page and the beginning of the music.
677 @cindex @code{line-width}
679 The length of the systems.
681 @cindex @code{head-separation}
682 @item head-separation
683 Distance between the top-most music system and the page header.
685 @cindex @code{foot-separation}
686 @item foot-separation
687 Distance between the bottom-most music system and the page footer.
689 @cindex @code{page-top-space}
690 Distance from the top of the printable area to the center of the first
691 staff. This only works for staves which are vertically small. Big staves
692 are set with the top of their bounding box aligned to the top of the
695 @cindex @code{ragged-bottom}
697 If set to true, systems will not be spread vertically across the page. This
698 does not affect the last page.
700 This should be set to true for pieces that have only two or three
701 systems per page, for example orchestral scores.
703 @cindex @code{ragged-last-bottom}
704 @item ragged-last-bottom
705 If set to false, systems will be spread vertically to fill the last page.
707 Pieces that amply fill two pages or more should have this set to
710 @cindex @code{system-count}
712 This variable, if set, specifies into how many lines a score should be
715 @cindex @code{between-system-space}
716 @item between-system-space
717 This dimensions determines the distance between systems. It is the
718 ideal distance between the center of the bottom staff of one system
719 and the center of the top staff of the next system.
721 Increasing this will provide a more even appearance of the page at the
722 cost of using more vertical space.
724 @cindex @code{between-system-padding}
725 @item between-system-padding
726 This dimension is the minimum amount of white space that will always
727 be present between the bottom-most symbol of one system, and the
728 top-most of the next system.
730 Increasing this will put systems whose bounding boxes almost touch
734 @cindex @code{horizontal-shift}
735 @item horizontal-shift
736 All systems (including titles and system separators) are shifted by
737 this amount to the right. Page markup, such as headers and footers are
738 not affected by this. The purpose of this variable is to make space
739 for instrument names at the left.
741 @cindex @code{after-title-space}
742 @item after-title-space
743 Amount of space between the title and the first system.
745 @cindex @code{after-title-space}
746 @item before-title-space
747 Amount of space between the last system of the previous piece and the
750 @cindex @code{between-title-space}
751 @item between-title-space
752 Amount of space between consecutive titles (e.g., the title of the
753 book and the title of a piece).
755 @cindex @code{printallheaders}
756 @item printallheaders
757 Setting this to #t will print all headers for each \score in a
758 \book. Normally only the piece and opus \headers are printed.
760 @cindex @code{systemSeparatorMarkup}
761 @item systemSeparatorMarkup
762 This contains a markup object, which will be inserted between
763 systems. This is often used for orchestral scores.
765 The markup command @code{\slashSeparator} is provided as a sensible
768 @lilypond[ragged-right]
771 \relative { c1 \break c1 }
774 systemSeparatorMarkup = \slashSeparator
790 ragged-last-bottom = ##t
794 You can also define these values in Scheme. In that case @code{mm},
795 @code{in}, @code{pt}, and @code{cm} are variables defined in
796 @file{paper-defaults.ly} with values in millimeters. That's why the
797 value has to be multiplied in the example
801 #(define bottom-margin (* 2 cm))
808 The default footer is empty, except for the first page, where the
809 @code{copyright} field from @code{\header} is inserted, and the last
810 page, where @code{tagline} from @code{\header} is added. The default
811 tagline is ``Music engraving by LilyPond (@var{version})''.@footnote{Nicely
812 printed parts are good PR for us, so please leave the tagline if you
815 The header and footer are created by the functions @code{make-footer}
816 and @code{make-header}, defined in @code{\paper}. The default
817 implementations are in @file{scm/@/page@/-layout@/.scm}.
819 The page layout itself is done by two functions in the
820 @code{\paper} block, @code{page-music-height} and
821 @code{page-make-stencil}. The former tells the line-breaking algorithm
822 how much space can be spent on a page, the latter creates the actual
823 page given the system to put on it.
828 The option right-margin is defined but doesn't set the right margin
829 yet. The value for the right margin has to be defined adjusting the
830 values of @code{left-margin} and @code{line-width}.
832 The default page header puts the page number and the @code{instrument}
833 field from the @code{\header} block on a line.
838 @section Music layout
840 This section deals with the manner in which the music is printed
841 within the boundaries defined by the @code{\paper} block.
843 The global paper layout is determined by three factors: the page layout, the
844 line breaks, and the spacing. These all influence each other. The
845 choice of spacing determines how densely each system of music is set.
846 This influences where line breaks are chosen, and thus ultimately, how
847 many pages a piece of music takes.
849 Globally spoken, this procedure happens in three steps: first,
850 flexible distances (``springs'') are chosen, based on durations. All
851 possible line breaking combinations are tried, and the one with the
852 best results -- a layout that has uniform density and requires as
853 little stretching or cramping as possible -- is chosen.
855 After spacing and linebreaking, the systems are distributed across
856 pages, taking into account the size of the page, and the size of the
860 * Setting global staff size::
861 * Selecting notation font size::
864 * Vertical spacing of piano staves::
865 * Horizontal spacing::
872 @node Setting global staff size
873 @subsection Setting global staff size
875 @cindex font size, setting
876 @cindex staff size, setting
877 @cindex @code{layout} file
879 To set the global staff size, use @code{set-global-staff-size}.
882 #(set-global-staff-size 14)
886 This sets the global default size to 14pt staff height and scales all
889 The Feta font provides musical symbols at eight different
890 sizes. Each font is tuned for a different staff size: at a smaller size
891 the font becomes heavier, to match the relatively heavier staff lines.
892 The recommended font sizes are listed in the following table:
895 @multitable @columnfractions .15 .2 .22 .2
898 @tab @b{staff height (pt)}
899 @tab @b{staff height (mm)}
941 @c modern rental material?
946 These fonts are available in any sizes. The context property
947 @code{fontSize} and the layout property @code{staff-space} (in
948 @internalsref{StaffSymbol}) can be used to tune the size for individual
949 staves. The sizes of individual staves are relative to the global size.
957 This manual: @ref{Selecting notation font size}.
960 @node Selecting notation font size
961 @subsection Selecting notation font size
963 The easiest method of setting the font size of any context, is by
964 setting the @code{fontSize} property.
966 @lilypond[quote,fragment,relative=1,verbatim]
975 It does not change the size of variable symbols, such as beams or
978 Internally, the @code{fontSize} context property will cause the
979 @code{font-size} property to be set in all layout objects. The value
980 of @code{font-size} is a number indicating the size relative to the
981 standard size for the current staff height. Each step up is an
982 increase of approximately 12% of the font size. Six steps is exactly a
983 factor two. The Scheme function @code{magstep} converts a
984 @code{font-size} number to a scaling factor.
986 @lilypond[quote,fragment,relative=1,verbatim]
988 \override NoteHead #'font-size = #-4
990 \override NoteHead #'font-size = #3
994 LilyPond has fonts in different design sizes. The music fonts for
995 smaller sizes are chubbier, while the text fonts are relatively wider.
996 Font size changes are achieved by scaling the design size that is
997 closest to the desired size. The standard font size (for
998 @code{font-size} equals 0), depends on the standard staff height. For
999 a 20pt staff, a 10pt font is selected.
1001 The @code{font-size} property can only be set on layout objects that
1002 use fonts. These are the ones supporting the
1003 @internalsref{font-interface} layout interface.
1007 The following commands set @code{fontSize} for the current voice:
1009 @cindex @code{\tiny}
1011 @cindex @code{\small}
1013 @cindex @code{\normalsize}
1018 @subsection Score layout
1020 @cindex @code{\layout}
1022 While @code{\paper} contains settings that relate to the page formatting
1023 of the whole document, @code{\layout} contains settings for score-specific
1030 \override VerticalAxisGroup #'minimum-Y-extent = #'(-6 . 6)
1033 \override TextScript #'padding = #1.0
1034 \override Glissando #'thickness = #3
1042 This manual: @ref{Changing context default settings}
1045 @node Vertical spacing
1046 @subsection Vertical spacing
1048 @cindex vertical spacing
1049 @cindex distance between staves
1050 @cindex staff distance
1051 @cindex between staves, distance
1052 @cindex staves per page
1053 @cindex space between staves
1055 The height of each system is determined automatically. To prevent
1056 systems from bumping into each other, some minimum distances are set.
1057 By changing these, you can put staves closer together, and thus put
1058 more systems onto one page.
1060 Normally staves are stacked vertically. To make staves maintain a
1061 distance, their vertical size is padded. This is done with the
1062 property @code{minimum-Y-extent}. When applied to a
1063 @internalsref{VerticalAxisGroup}, it controls the size of a horizontal
1064 line, such as a staff or a line of lyrics. @code{minimum-Y-extent}
1065 takes a pair of numbers, so
1066 if you want to make it smaller than its default @code{#'(-4 . 4)}
1070 \override Staff.VerticalAxisGroup #'minimum-Y-extent = #'(-3 . 3)
1074 This sets the vertical size of the current staff to 3 staff spaces on
1075 either side of the center staff line. The value @code{(-3 . 3)} is
1076 interpreted as an interval, where the center line is the 0, so the
1077 first number is generally negative. The staff can be made larger at
1078 the bottom by setting it to @code{(-6 . 4)}.
1080 The spacing of staves in a system may also be tuned per system. This is
1081 done with the command
1085 #"Score.NonMusicalPaperColumn"
1086 #'line-break-system-details
1087 #'((alignment-extra-space . 15))
1091 at the line break before the system to be changed. The distance
1092 @code{15} is distributed over all staves that have a fixed distance
1093 alignment. For example,
1095 @lilypond[ragged-right, fragment, relative=2, staffsize=13]
1101 #"Score.NonMusicalPaperColumn"
1102 #'line-break-system-details
1103 #'((fixed-alignment-extra-space . 15))
1111 The distance for @code{alignment-extra-space} may also be negative.
1114 To change the amount of space between systems, use
1115 @code{between-system-space}. A score with only one staff is still
1116 considered to have systems, so setting @code{between-system-space} will
1117 be much more useful than changing @code{minimum-Y-extent} of a Staff
1122 between-system-space = 10\mm
1126 If you simply want to tell LilyPond ``fit as much as possible onto
1127 these pages, then expand to fill any available space on the pages,''
1128 then use the following
1132 between-system-padding = #1
1134 ragged-last-bottom=##f
1139 @c let's wait for a some comments before writing more.
1141 The vertical spacing on a page can also be changed for each system individually.
1142 Some examples are found in the example file
1143 @inputfileref{input/regression/,page-spacing.ly}.
1145 When setting @code{annotatespacing} in the @code{\paper} block LilyPond
1146 will graphically indicate the dimensions of properties that may be set
1150 #(set-default-paper-size "a7" 'landscape)
1151 \paper { annotatespacing = ##t }
1156 All units dimensions are measured in staff spaces. The pairs
1157 (@var{a},@var{b}) are intervals, where @var{a} is the lower edge and
1158 @var{b} the upper edge of the interval.
1162 Internals: Vertical alignment of staves is handled by the
1163 @internalsref{VerticalAlignment} object. The context parameters
1164 specifying the vertical extent are described in connection with
1165 the @internalsref{Axis_group_engraver}.
1167 Example files: @inputfileref{input/regression/,page-spacing.ly},
1168 @inputfileref{input/regression/,alignment-vertical-spacing.ly}.
1173 @node Vertical spacing of piano staves
1174 @subsection Vertical spacing of piano staves
1176 The distance between staves of a @internalsref{PianoStaff} cannot be
1177 computed during formatting. Rather, to make cross-staff beaming work
1178 correctly, that distance has to be fixed beforehand.
1180 The distance of staves in a @code{PianoStaff} is set with the
1181 @code{forced-distance} property of the
1182 @internalsref{VerticalAlignment} object, created in
1183 @internalsref{PianoStaff}.
1185 It can be adjusted as follows
1187 \new PianoStaff \with @{
1188 \override VerticalAlignment #'forced-distance = #7
1195 This would bring the staves together at a distance of 7 staff spaces,
1196 measured from the center line of each staff.
1198 The difference is demonstrated in the following example,
1199 @lilypond[quote,verbatim]
1201 \new PianoStaff \with {
1202 \override VerticalAlignment #'forced-distance = #7
1215 It is also possible to change the distance between for each system
1216 individually. This is done by including the command
1220 #"Score.NonMusicalPaperColumn"
1221 #'line-break-system-details
1222 #'((fixed-alignment-extra-space . 15))
1226 at the line break before the system to be changed. The distance
1227 @code{15} is distributed over all staves that have a fixed distance
1228 alignment. For example,
1230 @lilypond[ragged-right, fragment, relative=2, staffsize=13]
1236 #"Score.NonMusicalPaperColumn"
1237 #'line-break-system-details
1238 #'((fixed-alignment-extra-space . 15))
1246 The distance for @code{fixed-alignment-extra-space} may also be
1251 Example files: @inputfileref{input/regression/,alignment-vertical-spacing.ly}.
1253 @node Horizontal spacing
1254 @subsection Horizontal Spacing
1256 The spacing engine translates differences in durations into stretchable
1257 distances (``springs'') of differring lengths. Longer durations get
1258 more space, shorter durations get less. The shortest durations get a
1259 fixed amount of space (which is controlled by
1260 @code{shortest-duration-space} in the @internalsref{SpacingSpanner}
1261 object). The longer the duration, the more space it gets: doubling a
1262 duration adds a fixed amount (this amount is controlled by
1263 @code{spacing-increment}) of space to the note.
1265 For example, the following piece contains lots of half, quarter, and
1266 8th notes; the eighth note is followed by 1 note head width (NHW).
1267 The quarter note is followed by 2 NHW, the half by 3 NHW, etc.
1269 @lilypond[quote,fragment,verbatim,relative=1]
1270 c2 c4. c8 c4. c8 c4. c8 c8
1274 Normally, @code{spacing-increment} is set to 1.2 staff space, which is
1275 approximately the width of a note head, and
1276 @code{shortest-duration-space} is set to 2.0, meaning that the
1277 shortest note gets 2.4 staff space (2.0 times the
1278 @code{spacing-increment}) of horizontal space. This space is counted
1279 from the left edge of the symbol, so the shortest notes are generally
1280 followed by one NHW of space.
1282 If one would follow the above procedure exactly, then adding a single
1283 32nd note to a score that uses 8th and 16th notes, would widen up the
1284 entire score a lot. The shortest note is no longer a 16th, but a 32nd,
1285 thus adding 1 NHW to every note. To prevent this, the shortest
1286 duration for spacing is not the shortest note in the score, but rather
1287 the one which occurs most frequently.
1290 The most common shortest duration is determined as follows: in every
1291 measure, the shortest duration is determined. The most common shortest
1292 duration is taken as the basis for the spacing, with the stipulation
1293 that this shortest duration should always be equal to or shorter than
1294 an 8th note. The shortest duration is printed when you run
1295 @code{lilypond} with the @code{--verbose} option.
1297 These durations may also be customized. If you set the
1298 @code{common-shortest-duration} in @internalsref{SpacingSpanner}, then
1299 this sets the base duration for spacing. The maximum duration for this
1300 base (normally an 8th), is set through @code{base-shortest-duration}.
1302 @cindex @code{common-shortest-duration}
1303 @cindex @code{base-shortest-duration}
1304 @cindex @code{stem-spacing-correction}
1305 @cindex @code{spacing}
1307 Notes that are even shorter than the common shortest note are
1308 followed by a space that is proportional to their duration relative to
1309 the common shortest note. So if we were to add only a few 16th notes
1310 to the example above, they would be followed by half a NHW:
1312 @lilypond[quote,fragment,verbatim,relative=2]
1313 c2 c4. c8 c4. c16[ c] c4. c8 c8 c8 c4 c4 c4
1317 In the introduction (see @ref{Engraving}), it was explained that stem
1318 directions influence spacing. This is controlled with the
1319 @code{stem-spacing-correction} property in the
1320 @internalsref{NoteSpacing}, object. These are generated for every
1321 @internalsref{Voice} context. The @code{StaffSpacing} object
1322 (generated in @internalsref{Staff} context) contains the same property
1323 for controlling the stem/bar line spacing. The following example shows
1324 these corrections, once with default settings, and once with
1325 exaggerated corrections:
1327 @lilypond[quote,ragged-right]
1331 \override Staff.NoteSpacing #'stem-spacing-correction = #1.5
1332 \override Staff.StaffSpacing #'stem-spacing-correction = #1.5
1338 Proportional notation is supported; see @ref{Proportional notation}.
1340 By default, spacing in tuplets depends on various non-duration
1341 factors (such as accidentals, clef changes, etc). To disregard
1342 such symbols and force uniform equal-duration spacing, use
1343 @code{Score.SpacingSpanner #'uniform-stretching}. This
1344 property can only be changed at the beginning of a score,
1346 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1348 \override SpacingSpanner #'uniform-stretching = ##t
1366 When @code{strict-note-spacing} is set, notes are spaced without
1367 regard for clefs, bar lines, and grace notes,
1369 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1370 \override Score.SpacingSpanner #'strict-note-spacing = ##t
1371 \new Staff { c8[ c \clef alto c \grace { c16[ c] } c8 c c] c32[ c32] }
1377 Internals: @internalsref{SpacingSpanner}, @internalsref{NoteSpacing},
1378 @internalsref{StaffSpacing}, @internalsref{SeparationItem}, and
1379 @internalsref{SeparatingGroupSpanner}.
1383 Spacing is determined on a score wide basis. If you have a score that
1384 changes its character (measured in durations) halfway during the
1385 score, the part containing the longer durations will be spaced too
1388 There is no convenient mechanism to manually override spacing. The
1389 following work-around may be used to insert extra space into a score.
1391 \once \override Score.SeparationItem #'padding = #1
1394 No work-around exists for decreasing the amount of space.
1398 @subsection Line length
1401 @cindex breaking pages
1403 @cindex @code{indent}
1404 @cindex @code{line-width}
1405 @cindex @code{ragged-right}
1406 @cindex @code{ragged-last}
1408 @c Although line-width can be set in \layout, it should be set in paper
1409 @c block, to get page layout right.
1410 @c Setting indent in \paper block makes not much sense, but it works.
1412 @c Bit verbose and vague, use examples?
1413 The most basic settings influencing the spacing are @code{indent} and
1414 @code{line-width}. They are set in the @code{\layout} block. They
1415 control the indentation of the first line of music, and the lengths of
1418 If @code{ragged-right} is set to true in the @code{\layout} block, then
1419 systems ends at their natural horizontal length, instead of being spread
1420 horizontally to fill the whole line. This is useful for
1421 short fragments, and for checking how tight the natural spacing is.
1424 @cindex vertical spacing
1426 The option @code{ragged-last} is similar to @code{ragged-right}, but
1427 only affects the last line of the piece. No restrictions are put on
1428 that line. The result is similar to formatting text paragraphs. In a
1429 paragraph, the last line simply takes its natural horizontal length.
1430 @c Note that for text there are several options for the last line.
1431 @c While Knuth TeX uses natural length, lead typesetters use the same
1432 @c stretch as the previous line. eTeX uses \lastlinefit to
1433 @c interpolate between both these solutions.
1445 @subsection Line breaking
1448 @cindex breaking lines
1450 Line breaks are normally computed automatically. They are chosen so
1451 that lines look neither cramped nor loose, and that consecutive lines
1452 have similar density.
1454 Occasionally you might want to override the automatic breaks; you can
1455 do this by specifying @code{\break}. This will force a line break at
1456 this point. Line breaks can only occur at places where there are bar
1457 lines. If you want to have a line break where there is no bar line,
1458 you can force an invisible bar line by entering @code{\bar
1459 ""}. Similarly, @code{\noBreak} forbids a line break at a
1463 @cindex regular line breaks
1464 @cindex four bar music.
1466 For line breaks at regular intervals use @code{\break} separated by
1467 skips and repeated with @code{\repeat}:
1469 << \repeat unfold 7 @{
1470 s1 \noBreak s1 \noBreak
1471 s1 \noBreak s1 \break @}
1472 @emph{the real music}
1477 This makes the following 28 measures (assuming 4/4 time) be broken every
1478 4 measures, and only there.
1482 @code{\break}, and @code{\noBreak}.
1483 @cindex @code{\break}
1484 @cindex @code{\noBreak}
1488 Internals: @internalsref{BreakEvent}.
1490 A linebreaking configuration can now be saved as a @code{.ly} file
1491 automatically. This allows vertical alignments to be stretched to
1492 fit pages in a second formatting run. This is fairly new and
1493 complicated; see @inputfileref{input/regression/,page-layout-twopass.ly}
1498 Line breaks can only occur if there is a ``proper'' bar line. A note
1499 which is hanging over a bar line is not proper, such as
1501 @lilypond[quote,ragged-right,relative=2,fragment,verbatim]
1502 c4 c2 c2 \break % this does nothing
1503 c2 c4 | % a break here would work
1504 c4 c2 c4 ~ \break % as does this break
1510 @subsection Page breaking
1512 The default page breaking may be overriden by inserting
1513 @code{\pageBreak} or @code{\noPageBreak} commands. These commands are
1514 analogous to @code{\break} and @code{\noBreak}. They should be
1515 inserted at a bar line. These commands force and forbid a page-break
1516 from happening. Of course, the @code{\pageBreak} command also forces
1519 Page breaks are computed by the @code{page-breaking} function in the
1520 @code{\paper} block.
1522 To force a new page for a new piece (in a collection of pieces or a
1523 piece in several movements), use @code{breakbefore} in the header.
1534 @cindex @code{\pageBreak}
1536 @cindex @code{\noPageBreak}
1542 The @code{breakbefore=##t} header requires that there is a @code{piece} header as well. It may be used as a normal header, or left blank (@code{=""}) as in the example above, but it must be present.
1546 @node Multiple movements
1547 @section Multiple movements
1549 @cindex bibliographic information
1552 @cindex Music engraving by LilyPond
1554 A document may contain multiple pieces of music and texts. Examples
1555 of these are an etude book, or an orchestral part with multiple
1556 movements. Each movement is entered with a @code{\score} block,
1564 and texts are entered with a @code{\markup} block,
1572 @cindex @code{\book}
1574 The movements and texts are combined together in a @code{\book} block,
1592 The header for each piece of music can be put inside the @code{\score}
1593 block. The @code{piece} name from the header will be printed before
1594 each movement. The title for the entire book can be put inside the
1595 @code{\book}, but if it is not present, the @code{\header} which is at
1596 the top of the file is inserted.
1598 @cindex Engraved by LilyPond
1599 @cindex signature line
1604 title = "Eight miniatures"
1605 composer = "Igor Stravinsky"
1609 \header @{ piece = "Romanze" @}
1612 ..text of second verse..
1615 ..text of third verse..
1619 \header @{ piece = "Menuetto" @}
1627 @section MIDI output
1632 MIDI (Musical Instrument Digital Interface) is a standard for
1633 connecting and controlling digital instruments. A MIDI file is a
1634 series of notes in a number of tracks. It is not an actual
1635 sound file; you need special software to translate between the
1636 series of notes and actual sounds.
1638 Pieces of music can be converted to MIDI files, so you can listen to
1639 what was entered. This is convenient for checking the music; octaves
1640 that are off or accidentals that were mistyped stand out very much
1641 when listening to the MIDI output.
1645 Many musically interesting effects, such as swing, articulation,
1646 slurring, etc., are not translated to midi.
1648 The midi output allocates a channel for each staff, and one for global
1649 settings. Therefore the midi file should not have more than 15 staves
1650 (or 14 if you do not use drums). Other staves will remain silent.
1652 Not all midi players correctly handle tempo changes in the midi
1653 output. Players that are known to work include
1654 @uref{http://@/timidity@/.sourceforge@/.net/,timidity}.
1657 * Creating MIDI files::
1659 * MIDI instrument names::
1662 @node Creating MIDI files
1663 @subsection Creating MIDI files
1665 To create a MIDI from a music piece of music, add a @code{\midi} block
1666 to a score, for example,
1671 \midi @{ \tempo 4=72 @}
1675 The tempo is specified using the @code{\tempo} command. In this
1676 example the tempo of quarter notes is set to 72 beats per minute.
1679 If there is a @code{\midi} command in a @code{\score}, only MIDI will
1680 be produced. When notation is needed too, a @code{\layout} block must
1686 \midi @{ \tempo 4=72 @}
1690 @cindex layout block
1694 Ties, dynamics, and tempo changes are interpreted. Dynamic marks,
1695 crescendi and decrescendi translate into MIDI volume levels. Dynamic
1696 marks translate to a fixed fraction of the available MIDI volume
1697 range, crescendi and decrescendi make the volume vary linearly between
1698 their two extremes. The fractions can be adjusted by
1699 @code{dynamicAbsoluteVolumeFunction} in @internalsref{Voice} context.
1700 For each type of MIDI instrument, a volume range can be defined. This
1701 gives a basic equalizer control, which can enhance the quality of
1702 the MIDI output remarkably. The equalizer can be controlled by
1703 setting @code{instrumentEqualizer}, or by setting
1706 \set Staff.midiMinimumVolume = #0.2
1707 \set Staff.midiMaximumVolume = #0.8
1710 To remove dynamics from the MIDI output, insert the following lines
1711 in the @code{\midi@{@}} section.
1718 \remove "Dynamic_performer"
1719 \remove "Span_dynamic_performer"
1727 Unterminated (de)crescendos will not render properly in the midi file,
1728 resulting in silent passages of music. The workaround is to explicitly
1729 terminate the (de)crescendo. For example,
1736 will not work properly but
1747 @subsection MIDI block
1751 The MIDI block is analogous to the layout block, but it is somewhat
1752 simpler. The @code{\midi} block can contain
1756 @item a @code{\tempo} definition, and
1757 @item context definitions.
1760 A number followed by a period is interpreted as a real number, so
1761 for setting the tempo for dotted notes, an extra space should be
1762 inserted, for example
1765 \midi @{ \tempo 4 . = 120 @}
1769 @cindex context definition
1771 Context definitions follow precisely the same syntax as within the
1772 \layout block. Translation modules for sound are called performers.
1773 The contexts for MIDI output are defined in @file{ly/@/performer@/-init@/.ly}.
1776 @node MIDI instrument names
1777 @subsection MIDI instrument names
1779 @cindex instrument names
1780 @cindex @code{Staff.midiInstrument}
1782 The MIDI instrument name is set by the @code{Staff.midiInstrument}
1783 property. The instrument name should be chosen from the list in
1784 @ref{MIDI instruments}.
1787 \set Staff.midiInstrument = "glockenspiel"
1791 If the selected instrument does not exactly match an instrument from
1792 the list of MIDI instruments, the Grand Piano (@code{"acoustic grand"})