@c -*- coding: utf-8; mode: texinfo; -*- @c This file is part of lilypond.tely @ignore Translation of GIT committish: FILL-IN-HEAD-COMMITTISH When revising a translation, copy the HEAD committish of the version that you are working on. See TRANSLATION for details. @end ignore @c \version "2.11.38" @node Input syntax @chapter Input syntax This section deals with general LilyPond input syntax issues, rather than specific notation. FIXME: don't complain about anything in this chapter. It's still under heavy development. FIXME: add comments @verbatim % %{ @end verbatim to 3.1. @menu * Input structure:: * Useful concepts and properties:: * Titles and headers:: * Working with input files:: * Controlling output:: @end menu @node Input structure @section Input structure The main format of input for LilyPond are text files. By convention, these files end with @code{.ly}. @menu * Structure of a score:: * Multiple scores in a book:: * File structure:: @end menu @node Structure of a score @subsection Structure of a score A @code{\score} must contain a single music expression. However, this music expression may be of any size. Recall that music expressions may be included inside other expressions to form larger expressions. All of these examples are single music expressions; note the curly braces @{ @} or angle brackets << >> at the beginning and ending of the music. @example @{ c'4 c' c' c' @} @end example @lilypond[ragged-right,verbatim,quote] { { c'4 c' c' c'} { d'4 d' d' d'} } @end lilypond @lilypond[ragged-right,verbatim,quote] << \new Staff { c'4 c' c' c' } \new Staff { d'4 d' d' d' } >> @end lilypond @example @{ \new GrandStaff << \new StaffGroup << \new Staff @{ \flute @} \new Staff @{ \oboe @} >> \new StaffGroup << \new Staff @{ \violinI @} \new Staff @{ \violinII @} >> >> @} @end example @node Multiple scores in a book @subsection Multiple scores in a book @funindex \book @cindex movements, multiple A document may contain multiple pieces of music and texts. Examples of these are an etude book, or an orchestral part with multiple movements. Each movement is entered with a @code{\score} block, @example \score @{ @var{..music..} @} @end example and texts are entered with a @code{\markup} block, @example \markup @{ @var{..text..} @} @end example @funindex \book All the movements and texts which appear in the same @code{.ly} file will normally be typeset in the form of a single output file. @example \score @{ @var{..} @} \markup @{ @var{..} @} \score @{ @var{..} @} @end example However, if you want multiple output files from the same @code{.ly} file, then you can add multiple @code{\book} blocks, where each such @code{\book} block will result in a separate output. If you do not specify any @code{\book} block in the file, LilyPond will implicitly treat the full file as a single @code{\book} block, see @ref{File structure}. One important exception is within lilypond-book documents, where you explicitly have to add a @code{\book} block, otherwise only the first @code{\score} or @code{\markup} will appear in the output. The header for each piece of music can be put inside the @code{\score} block. The @code{piece} name from the header will be printed before each movement. The title for the entire book can be put inside the @code{\book}, but if it is not present, the @code{\header} which is at the top of the file is inserted. @example \header @{ title = "Eight miniatures" composer = "Igor Stravinsky" @} \score @{ @dots{} \header @{ piece = "Romanze" @} @} \markup @{ ..text of second verse.. @} \markup @{ ..text of third verse.. @} \score @{ @dots{} \header @{ piece = "Menuetto" @} @} @end example @node File structure @subsection File structure A @code{.ly} file contains any number of toplevel expressions, where a toplevel expression is one of the following @itemize @item An output definition, such as @code{\paper}, @code{\midi}, and @code{\layout}. Such a definition at the toplevel changes the default settings for the block entered. @item A direct scheme expression, such as @code{#(set-default-paper-size "a7" 'landscape)} or @code{#(ly:set-option 'point-and-click #f)}. @item A @code{\header} block. This sets the global header block. This is the block containing the definitions for book-wide settings, like composer, title, etc. @item A @code{\score} block. This score will be collected with other toplevel scores, and combined as a single @code{\book}. This behavior can be changed by setting the variable @code{toplevel-score-handler} at toplevel. The default handler is defined in the init file @file{scm/@/lily@/.scm}. The @code{\score} must begin with a music expression, and may contain only one music expression. @item A @code{\book} block logically combines multiple movements (i.e., multiple @code{\score} blocks) in one document. If there are a number of @code{\scores}, one output file will be created for each @code{\book} block, in which all corresponding movements are concatenated. The only reason to explicitly specify @code{\book} blocks in a @code{.ly} file is if you wish multiple output files from a single input file. One exception is within lilypond-book documents, where you explicitly have to add a @code{\book} block if you want more than a single @code{\score} or @code{\markup} in the same example. This behavior can be changed by setting the variable @code{toplevel-book-handler} at toplevel. The default handler is defined in the init file @file{scm/@/lily@/.scm}. @item A compound music expression, such as @example @{ c'4 d' e'2 @} @end example This will add the piece in a @code{\score} and format it in a single book together with all other toplevel @code{\score}s and music expressions. In other words, a file containing only the above music expression will be translated into @example \book @{ \score @{ \new Staff @{ \new Voice @{ @{ c'4 d' e'2 @} @} @} @} \layout @{ @} \header @{ @} @} @end example This behavior can be changed by setting the variable @code{toplevel-music-handler} at toplevel. The default handler is defined in the init file @file{scm/@/lily@/.scm}. @item A markup text, a verse for example @example \markup @{ 2. The first line verse two. @} @end example Markup texts are rendered above, between or below the scores or music expressions, wherever they appear. @cindex variables @item An variable, such as @example foo = @{ c4 d e d @} @end example This can be used later on in the file by entering @code{\foo}. The name of an variable should have alphabetic characters only; no numbers, underscores or dashes. @end itemize The following example shows three things that may be entered at toplevel @example \layout @{ % movements are non-justified by default ragged-right = ##t @} \header @{ title = "Do-re-mi" @} @{ c'4 d' e2 @} @end example At any point in a file, any of the following lexical instructions can be entered: @itemize @item @code{\version} @item @code{\include} @item @code{\sourcefilename} @item @code{\sourcefileline} @end itemize @node Useful concepts and properties @section Useful concepts and properties @menu * Input modes:: * When to add a -:: * Controlling direction and placement:: * Distances and measurements:: * Spanners:: @end menu @node Input modes @subsection Input modes \notemode \notemode turns the front end of LilyPond into note mode (which is the default parsing mode). It's certainly useful in certain situations, for example if you are in \lyricmode or \chordmode or ... and want to insert something that only can be done with \notemode syntax. See for example http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00418.html http://lists.gnu.org/archive/html/lilypond-user/2007-03/msg00218.html http://lists.gnu.org/archive/html/lilypond-user/2006-12/msg00236.html http://lists.gnu.org/archive/html/lilypond-user/2006-11/msg00061.html \chords \drums \fretmode ? @node When to add a - @subsection When to add a - One of these works, the other doesn't. @verbatim \version "2.11.38" { c'\mp\fermata\accent-\markup { "forcefully"} } % { c'\mp\fermata\accent\markup { "forcefully"} } @end verbatim @node Controlling direction and placement @subsection Controlling direction and placement TODO: everything By default, LilyPond does a pretty jazz'n job of picking directions. But in some cases, it may be desirable to force a direction. @verbatim - ^ _ @end verbatim Also cover #UP #DOWN #LEFT #RIGHT. Maybe rename section to "directions". Also mention \override Foo #'direction = #'DOWN. also mention the typical \fooDown, \fooNeutral predefined commands. also mention that some directions are (without other tweaking) always up or always down (like dynamics or fermata), while other things can alternate between up or down based on the stem direction (like slurs or accents). @node Distances and measurements @subsection Distances and measurements DISCUSS after working on other sections. TODO: staff spaces, #UP #DOWN #LEFT #RIGHT. Maybe move into tweaks? @node Spanners @subsection Spanners @node Titles and headers @section Titles and headers Almost all printed music includes a title and the composer's name; some pieces include a lot more information. @menu * Creating titles:: * Custom titles:: * Reference to page numbers:: * Table of contents:: @end menu @node Creating titles @subsection Creating titles Titles are created for each @code{\score} block, as well as for the full input file (or @code{\book} block). The contents of the titles are taken from the @code{\header} blocks. The header block for a book supports the following @table @code @funindex dedication @item dedication The dedicatee of the music, centered at the top of the first page. @funindex title @item title The title of the music, centered just below the dedication. @funindex subtitle @item subtitle Subtitle, centered below the title. @funindex subsubtitle @item subsubtitle Subsubtitle, centered below the subtitle. @funindex poet @item poet Name of the poet, flush-left below the subtitle. @funindex composer @item composer Name of the composer, flush-right below the subtitle. @funindex meter @item meter Meter string, flush-left below the poet. @funindex opus @item opus Name of the opus, flush-right below the composer. @funindex arranger @item arranger Name of the arranger, flush-right below the opus. @funindex instrument @item instrument Name of the instrument, centered below the arranger. Also centered at the top of pages (other than the first page). @funindex piece @item piece Name of the piece, flush-left below the instrument. @cindex page breaks, forcing @funindex breakbefore @item breakbefore This forces the title to start on a new page (set to ##t or ##f). @funindex copyright @item copyright Copyright notice, centered at the bottom of the first page. To insert the copyright symbol, see @ref{Text encoding}. @funindex tagline @item tagline Centered at the bottom of the last page. @end table Here is a demonstration of the fields available. Note that you may use any @ref{Formatting text}, commands in the header. @lilypond[quote,verbatim,line-width=11.0\cm] \paper { line-width = 9.0\cm paper-height = 10.0\cm } \book { \header { dedication = "dedicated to me" title = \markup \center-align { "Title first line" "Title second line, longer" } subtitle = "the subtitle," subsubtitle = #(string-append "subsubtitle LilyPond version " (lilypond-version)) poet = "Poet" composer = \markup \center-align { "composer" \small "(1847-1973)" } texttranslator = "Text Translator" meter = \markup { \teeny "m" \tiny "e" \normalsize "t" \large "e" \huge "r" } arranger = \markup { \fontsize #8.5 "a" \fontsize #2.5 "r" \fontsize #-2.5 "r" \fontsize #-5.3 "a" \fontsize #7.5 "nger" } instrument = \markup \bold \italic "instrument" piece = "Piece" } \score { { c'1 } \header { piece = "piece1" opus = "opus1" } } \markup { and now... } \score { { c'1 } \header { piece = "piece2" opus = "opus2" } } } @end lilypond As demonstrated before, you can use multiple @code{\header} blocks. When same fields appear in different blocks, the latter is used. Here is a short example. @example \header @{ composer = "Composer" @} \header @{ piece = "Piece" @} \score @{ \new Staff @{ c'4 @} \header @{ piece = "New piece" % overwrite previous one @} @} @end example If you define the @code{\header} inside the @code{\score} block, then normally only the @code{piece} and @code{opus} headers will be printed. Note that the music expression must come before the @code{\header}. @lilypond[quote,verbatim,line-width=11.0\cm] \score { { c'4 } \header { title = "title" % not printed piece = "piece" opus = "opus" } } @end lilypond @funindex printallheaders @noindent You may change this behavior (and print all the headers when defining @code{\header} inside @code{\score}) by using @example \paper@{ printallheaders=##t @} @end example @cindex copyright @cindex tagline The default footer is empty, except for the first page, where the @code{copyright} field from @code{\header} is inserted, and the last page, where @code{tagline} from @code{\header} is added. The default tagline is @qq{Music engraving by LilyPond (@var{version})}.@footnote{Nicely printed parts are good PR for us, so please leave the tagline if you can.} Headers may be completely removed by setting them to false. @example \header @{ tagline = ##f composer = ##f @} @end example @node Custom titles @subsection Custom titles A more advanced option is to change the definitions of the following variables in the @code{\paper} block. The init file @file{ly/titling-init.ly} lists the default layout. @table @code @funindex bookTitleMarkup @item bookTitleMarkup This is the title added at the top of the entire output document. Typically, it has the composer and the title of the piece @funindex scoreTitleMarkup @item scoreTitleMarkup This is the title put over a @code{\score} block. Typically, it has the name of the movement (@code{piece} field). @funindex oddHeaderMarkup @item oddHeaderMarkup This is the page header for odd-numbered pages. @funindex evenHeaderMarkup @item evenHeaderMarkup This is the page header for even-numbered pages. If unspecified, the odd header is used instead. By default, headers are defined such that the page number is on the outside edge, and the instrument is centered. @funindex oddFooterMarkup @item oddFooterMarkup This is the page footer for odd-numbered pages. @funindex evenFooterMarkup @item evenFooterMarkup This is the page footer for even-numbered pages. If unspecified, the odd header is used instead. By default, the footer has the copyright notice on the first, and the tagline on the last page. @end table @cindex \paper @cindex header @cindex footer @cindex page layout @cindex titles The following definition will put the title flush left, and the composer flush right on a single line. @verbatim \paper { bookTitleMarkup = \markup { \fill-line { \fromproperty #'header:title \fromproperty #'header:composer } } } @end verbatim @node Reference to page numbers @subsection Reference to page numbers A particular place of a score can be marked using the @code{\label} command, either at top-level or inside music. This label can then be referred to in a markup, to get the number of the page where the marked point is placed, using the @code{\page-ref} markup command. @lilypond[verbatim,line-width=11.0\cm] \header { tagline = ##f } \book { \label #'firstScore \score { { c'1 \pageBreak \mark A \label #'markA c' } } \markup { The first score begins on page \page-ref #'firstScore "0" "?" } \markup { Mark A is on page \page-ref #'markA "0" "?" } } @end lilypond The @code{\page-ref} markup command takes three arguments: @enumerate @item the label, a scheme symbol, eg. @code{#'firstScore}; @item a markup that will be used as a gauge to estimate the dimensions of the markup; @item a markup that will be used in place of the page number if the label is not known; @end enumerate The reason why a gauge is needed is that, at the time markups are interpreted, the page breaking has not yet occurred, so the page numbers are not yet known. To work around this issue, the actual markup interpretation is delayed to a later time; however, the dimensions of the markup have to be known before, so a gauge is used to decide these dimensions. If the book has between 10 and 99 pages, it may be "00", ie. a two digit number. @predefined @funindex \label @code{\label} @funindex \page-ref @code{\page-ref} @node Table of contents @subsection Table of contents A table of contents is included using the @code{\markuplines \table-of-contents} command. The elements which should appear in the table of contents are entered with the @code{\tocItem} command, which may be used either at top-level, or inside a music expression. @verbatim \markuplines \table-of-contents \pageBreak \tocItem \markup "First score" \score { { c' % ... \tocItem \markup "Some particular point in the first score" d' % ... } } \tocItem \markup "Second score" \score { { e' % ... } } @end verbatim The markups which are used to format the table of contents are defined in the @code{\paper} block. The default ones are @code{tocTitleMarkup}, for formatting the title of the table, and @code{tocItemMarkup}, for formatting the toc elements, composed of the element title and page number. These variables may be changed by the user: @verbatim \paper { %% Translate the toc title into French: tocTitleMarkup = \markup \huge \column { \fill-line { \null "Table des matières" \null } \hspace #1 } %% use larger font size tocItemMarkup = \markup \large \fill-line { \fromproperty #'toc:text \fromproperty #'toc:page } } @end verbatim Note how the toc element text and page number are referred to in the @code{tocItemMarkup} definition. New commands and markups may also be defined to build more elaborated table of contents: @itemize @item first, define a new markup variable in the @code{\paper} block @item then, define a music function which aims at adding a toc element using this markup paper variable. @end itemize In the following example, a new style is defined for entering act names in the table of contents of an opera: @verbatim \paper { tocActMarkup = \markup \large \column { \hspace #1 \fill-line { \null \italic \fromproperty #'toc:text \null } \hspace #1 } } tocAct = #(define-music-function (parser location text) (markup?) (add-toc-item! 'tocActMarkup text)) @end verbatim @lilypond[line-width=11.0\cm] \header { tagline = ##f } \paper { tocActMarkup = \markup \large \column { \hspace #1 \fill-line { \null \italic \fromproperty #'toc:text \null } \hspace #1 } } tocAct = #(define-music-function (parser location text) (markup?) (add-toc-item! 'tocActMarkup text)) \book { \markuplines \table-of-contents \tocAct \markup { Atto Primo } \tocItem \markup { Coro. Viva il nostro Alcide } \tocItem \markup { Cesare. Presti omai l'Egizzia terra } \tocAct \markup { Atto Secondo } \tocItem \markup { Sinfonia } \tocItem \markup { Cleopatra. V'adoro, pupille, saette d'Amore } \markup \null } @end lilypond @seealso Init files: @file{ly/@/toc@/-init@/.ly}. @predefined @funindex \table-of-contents @code{\table-of-contents} @funindex \tocItem @code{\tocItem} @node Working with input files @section Working with input files @menu * Including LilyPond files:: * Different editions from one source:: * Text encoding:: * Displaying LilyPond notation:: @end menu @node Including LilyPond files @subsection Including LilyPond files @funindex \include @cindex including files A large project may be split up into separate files. To refer to another file, use @example \include "otherfile.ly" @end example The line @code{\include "file.ly"} is equivalent to pasting the contents of file.ly into the current file at the place where you have the \include. For example, for a large project you might write separate files for each instrument part and create a @q{full score} file which brings together the individual instrument files. The initialization of LilyPond is done in a number of files that are included by default when you start the program, normally transparent to the user. Run @code{lilypond --verbose} to see a list of paths and files that Lily finds. Files placed in directory @file{PATH/TO/share/lilypond/VERSION/ly/} (where VERSION is in the form @q{2.6.1}) are on the path and available to @code{\include}. Files in the current working directory are available to \include, but a file of the same name in LilyPond's installation takes precedence. Files are available to \include from directories in the search path specified as an option when invoking @code{lilypond --include=DIR} which adds DIR to the search path. The @code{\include} statement can use full path information, but with the UNIX convention @code{/} rather than the DOS/Windows @code{\}. For example, if @file{stuff.ly} is located one directory higher than the current working directory, use @example \include "../stuff.ly" @end example @node Different editions from one source @subsection Different editions from one source @funindex \tag @cindex tag The @code{\tag} command marks music expressions with a name. These tagged expressions can be filtered out later. With this mechanism it is possible to make different versions of the same music source. In the following example, we see two versions of a piece of music, one for the full score, and one with cue notes for the instrumental part @example c1 << \tag #'part << R1 \\ @{ \set fontSize = #-1 c4_"cue" f2 g4 @} >> \tag #'score R1 >> c1 @end example The same can be applied to articulations, texts, etc.: they are made by prepending @example -\tag #@var{your-tag} @end example to an articulation, for example, @example c1-\tag #'part ^4 @end example This defines a note with a conditional fingering indication. @cindex keepWithTag @cindex removeWithTag By applying the @code{\keepWithTag} and @code{\removeWithTag} commands, tagged expressions can be filtered. For example, @example << @var{the music} \keepWithTag #'score @var{the music} \keepWithTag #'part @var{the music} >> @end example would yield @c FIXME: broken @c @lilypondfile[ragged-right,quote]{tag-filter.ly} The arguments of the @code{\tag} command should be a symbol (such as @code{#'score} or @code{#'part}), followed by a music expression. It is possible to put multiple tags on a piece of music with multiple @code{\tag} entries, @example \tag #'original-part \tag #'transposed-part @dots{} @end example @knownissues Multiple rests are not merged if you create the score with both tagged sections. @node Text encoding @subsection Text encoding LilyPond uses the Pango library to format multi-lingual texts, and does not perform any input-encoding conversions. This means that any text, be it title, lyric text, or musical instruction containing non-ASCII characters, must be utf-8. The easiest way to enter such text is by using a Unicode-aware editor and saving the file with utf-8 encoding. Most popular modern editors have utf-8 support, for example, vim, Emacs, jEdit, and GEdit do. @c Currently not working @ignore Depending on the fonts installed, the following fragment shows Hebrew and Cyrillic lyrics, @cindex Cyrillic @cindex Hebrew @cindex ASCII, non @li lypondfile[fontload]{utf-8.ly} The @TeX{} backend does not handle encoding specially at all. Strings in the input are put in the output as-is. Extents of text items in the @TeX{} backend, are determined by reading a file created via the @file{texstr} backend, @example lilypond -dbackend=texstr input/les-nereides.ly latex les-nereides.texstr @end example The last command produces @file{les-nereides.textmetrics}, which is read when you execute @example lilypond -dbackend=tex input/les-nereides.ly @end example Both @file{les-nereides.texstr} and @file{les-nereides.tex} need suitable LaTeX wrappers to load appropriate La@TeX{} packages for interpreting non-ASCII strings. @end ignore To use a Unicode escape sequence, use @example #(ly:export (ly:wide-char->utf-8 #x2014)) @end example @node Displaying LilyPond notation @subsection Displaying LilyPond notation @funindex \displayLilyMusic Displaying a music expression in LilyPond notation can be done using the music function @code{\displayLilyMusic}. For example, @example @{ \displayLilyMusic \transpose c a, @{ c e g a bes @} @} @end example will display @example @{ a, cis e fis g @} @end example By default, LilyPond will print these messages to the console along with all the other messages. To split up these messages and save the results of @code{\display@{STUFF@}}, redirect the output to a file. @example lilypond file.ly >display.txt @end example @node Controlling output @section Controlling output @menu * Extracting fragments of notation:: * Skipping corrected music:: @end menu @node Extracting fragments of notation @subsection Extracting fragments of notation It is possible to quote small fragments of a large score directly from the output. This can be compared to clipping a piece of a paper score with scissors. This is done by defining the measures that need to be cut out separately. For example, including the following definition @verbatim \layout { clip-regions = #(list (cons (make-rhythmic-location 5 1 2) (make-rhythmic-location 7 3 4))) } @end verbatim @noindent will extract a fragment starting halfway the fifth measure, ending in the seventh measure. The meaning of @code{5 1 2} is: after a 1/2 note in measure 5, and @code{7 3 4} after 3 quarter notes in measure 7. More clip regions can be defined by adding more pairs of rhythmic-locations to the list. In order to use this feature, LilyPond must be invoked with @code{-dclip-systems}. The clips are output as EPS files, and are converted to PDF and PNG if these formats are switched on as well. For more information on output formats, see @rprogram{Invoking lilypond}. @node Skipping corrected music @subsection Skipping corrected music @funindex skipTypesetting @funindex showLastLength When entering or copying music, usually only the music near the end (where you are adding notes) is interesting to view and correct. To speed up this correction process, it is possible to skip typesetting of all but the last few measures. This is achieved by putting @verbatim showLastLength = R1*5 \score { ... } @end verbatim @noindent in your source file. This will render only the last 5 measures (assuming 4/4 time signature) of every @code{\score} in the input file. For longer pieces, rendering only a small part is often an order of magnitude quicker than rendering it completely Skipping parts of a score can be controlled in a more fine-grained fashion with the property @code{Score.skipTypesetting}. When it is set, no typesetting is performed at all. This property is also used to control output to the MIDI file. Note that it skips all events, including tempo and instrument changes. You have been warned. @lilypond[quote,fragment,ragged-right,verbatim] \relative c'' { c8 d \set Score.skipTypesetting = ##t e e e e e e e e \set Score.skipTypesetting = ##f c d b bes a g c2 } @end lilypond In polyphonic music, @code{Score.skipTypesetting} will affect all voices and staves, saving even more time.