1 @c -*- coding: utf-8; mode: texinfo; -*-
3 Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
5 When revising a translation, copy the HEAD committish of the
6 version that you are working on. See TRANSLATION for details.
14 @lilypondfile[quote]{text-headword.ly}
16 This section explains how to include text (with various
17 formatting) in music scores.
20 Some text elements that are not dealt with here are discussed in other
21 specific sections: @ref{Vocal music}, @ref{Titles and headers}.
24 @cindex Text, other languages
25 @warning{To write accented and special text (such as characters
26 from other languages), simply insert the characters directly into
27 the LilyPond file. The file must be saved as UTF-8. For more
28 information, see @ref{Text encoding}.}
38 @subsection Writing text
40 This section introduces different ways of adding text to a score.
51 @subsubsection Text scripts
54 @cindex text items, non-empty
55 @cindex non-empty texts
57 It is possible to add arbitrary text indications
58 to a score, as demonstrated in the following example.
59 Such indications can also be manually placed
60 above or below the staff, using the
61 simple syntax described in @ref{Controlling direction and
64 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
65 d8^"pizz." e f g a4-"scherz." f
68 In LilyPond, such text strings are called @command{markup}
69 objects. This syntax is actually a shorthand; more complex text
70 formatting may be added to a note by explicitly using a
71 @code{\markup} block, as described in @ref{Formatting text}.
73 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
74 d8^\markup { \italic pizz. } e f g
75 a4_\markup { \tiny scherz. \bold molto } f
78 By default, text indications do not influence the note spacing.
79 However, their widths can be taken into account:
80 in the following example, the first text string does not affect
81 spacing, whereas the second one does.
83 @lilypond[quote,fragment,ragged-right,verbatim,relative=1]
84 d8^"pizz." e f g \textLengthOn a4_"scherzando" f
89 @funindex \textLengthOn
91 @funindex \textLengthOff
97 Notation Reference: @ref{Formatting text},
98 @ref{Controlling direction and placement}.
103 Internals Reference: @rinternals{TextScript}.
107 Checking to make sure that text scripts and lyrics are within the
108 margins is a relatively large computational task. To speed up
109 processing, LilyPond does not perform such calculations by
110 default; to enable it, use
113 \override Score.PaperColumn #'keep-inside-line = ##t
118 @subsubsection Text spanners
120 @cindex Text spanners
122 Some performance indications, e.g., @i{rallentando} or
123 @i{accelerando}, are written as text and are extended over many
124 measures with dotted lines.
125 Such objects, called @q{spanners}, may be created
126 from one note to another using the following syntax:
128 @lilypond[verbatim,quote,ragged-right,fragment,relative=2]
129 \override TextSpanner #'bound-details #'left #'text = "rit."
135 The string to be printed is set through
136 object properties. By default it is printed in italic characters,
137 but different formatting can be obtained using
138 @code{\markup} blocks, as described in @ref{Formatting text}.
140 @lilypond[quote,ragged-right,fragment,relative=2,verbatim]
141 \override TextSpanner #'bound-details #'left #'text =
142 \markup { \upright "rit." }
147 The line style, as well as the text string, can be defined as an
148 object property. This syntax is described in @ref{Line styles}.
152 @funindex textSpannerUp
153 @code{\textSpannerUp},
154 @funindex textSpannerDown
155 @code{\textSpannerDown},
156 @funindex textSpannerNeutral
157 @code{\textSpannerNeutral}
161 Notation Reference: @ref{Line styles}.
166 Internals Reference: @rinternals{TextSpanner}.
170 @subsubsection Text marks
172 @cindex coda on bar line
173 @cindex segno on bar line
174 @cindex fermata on bar line
175 @cindex bar lines, symbols on
178 Various text elements can be added to a score using
179 the syntax described in @ref{Rehearsal marks}:
181 @lilypond[verbatim,quote,ragged-right,fragment,relative=2]
182 c4\mark "Allegro" c c c
185 This syntax makes possible to put any text on a bar line;
186 more complex text formatting may be added using a @code{\markup}
187 block, as described in @ref{Formatting text}. This can be used to print
188 signs like coda, segno or fermata, by specifying the appropriate
191 @lilypond[fragment,quote,ragged-right,verbatim,relative=2]
192 c1 \mark \markup { \musicglyph #"scripts.ufermata" }
197 Such objects are only typeset above the top staff of the score; depending on
198 whether they are specified at the end or the middle of a bar, they
199 can be placed above the bar line or between notes. When specified at the
200 beginning of a score or at a line break, marks will be printed at
201 the beginning of the line (the next line, in case of a line break).
203 @lilypond[fragment,quote,ragged-right,verbatim,relative=2]
205 c\mark "assai" \break
212 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
213 {printing-marks-at-the-end-of-a-line-or-a-score.ly}
215 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
216 {aligning-marks-with-various-notation-objects.ly}
218 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc]
219 {printing-marks-on-every-staff.ly}
223 Notation Reference: @ref{Rehearsal marks},
224 @ref{Formatting text}, @ref{The Feta font}.
229 Internals Reference: @rinternals{RehearsalMark}.
232 @c IMO this is a bug; hopefully it'll be fixed soon, so I can
233 @c delete this sentence. -gp
234 @c A workaround is suggested in the first @snippets item -vv
236 If a mark is entered at the end of the last bar of the score (where
237 there is no next line), then the mark will not be printed at
241 @subsubsection Separate text
243 @cindex separate text
244 @cindex standalone text
245 @cindex top-level text
246 @cindex text, standalone
249 A @code{\markup} block can exist by itself, outside of any
250 any @code{\score} block, as a @qq{top-level
251 expression}. This syntax is described in @ref{File structure}.
253 @lilypond[quote,ragged-right,verbatim]
255 Tomorrow, and tomorrow, and tomorrow...
260 This allows to print text separately
261 from the music, which is particularly
262 useful when the input file contains
263 several music pieces, as described in
264 @ref{Multiple scores in a book}.
266 @lilypond[quote,ragged-right,verbatim]
271 Tomorrow, and tomorrow, and tomorrow...
278 Using a specific syntax, text blocks can be spread
279 over multiple pages, making possible to print
280 text documents or books -- and therefore to
281 use LilyPond as a word processor. This syntax is described in
282 @ref{Multi-page markup}.
288 @funindex \markuplines
294 TODO: add convenient snippets in input/new -vv
299 Notation Reference: @ref{Formatting text},
300 @ref{File structure},
301 @ref{Multiple scores in a book},
302 @ref{Multi-page markup}.
307 Internals Reference: @rinternals{TextScript}.
310 @node Formatting text
311 @subsection Formatting text
313 This section presents basic and advanced text formatting,
314 using the @code{\markup} mode specific syntax.
317 * Text markup introduction::
318 * Common markup commands::
320 * Graphic notation inside markup::
321 * Music notation inside markup::
322 * Multi-page markup::
325 @node Text markup introduction
326 @subsubsection Text markup introduction
333 A @code{\markup} block is used to typeset text with an extensible
334 specific syntax called @qq{markup mode}.
336 @c TODO: make a nicer example (maybe ask Trevor B?) -vv
337 @lilypond[quote,verbatim]
338 \header{ title = \markup{ \bold { foo \italic { bar! } } } }
341 \override Score.RehearsalMark
342 #'break-visibility = #begin-of-line-invisible
343 \override Score.RehearsalMark #'self-alignment-X = #right
345 \set Staff.instrumentName = \markup{ \column{ Alto solo } }
346 c2^\markup{ don't be \flat }
347 \override TextSpanner #'bound-details #'left #'text = \markup{\italic rit }
349 a2\mark \markup{ \large \bold Fine }
353 \addlyrics { bar, foo \markup{ \italic bar! } }
357 @cindex markup expressions
358 @cindex markup syntax
360 The markup syntax is similar to LilyPond's usual syntax: a
361 @code{\markup} expression is enclosed in curly braces @code{@{
364 Markup expressions may also be enclosed in double quotes
365 @code{"..."}, but these are treated as text strings. Commands are
366 interpreted literally.
368 In markup mode, specific commands are entered using the backslash
369 @code{\} character. Such commands only affect the first following
372 In this example, the first markup is made of one word without any
373 braces or quotes, while the following markups demonstrate the usefulness
374 of nested markup expressions using braces.
375 This syntax is prefered, as it allows both single-word and multi-word
378 @lilypond[quote,verbatim,fragment,relative=1]
380 a2^\markup { poco \italic più forte }
382 d2_\markup { \italic "string. assai" }
384 b1^\markup { \bold { molto agitato } }
388 @cindex special characters in markup mode
389 @cindex markup mode, special characters
390 @cindex reserved characters, printing
391 @cindex printing special characters
393 Special characters such as @code{\} and @code{#}
394 can be printed in the output simply using double
395 quotes. Double quotation marks are only printed
396 in the output when preceded by backslashes:
398 @lilypond[quote,verbatim,fragment,relative=1]
400 a^\markup "##\ LEPORELLO \##"
401 a_\markup "Bravi! \"Cosa rara\"!"
406 The way markup expressions are defined affects
407 how these expressions will stacked, centered and aligned;
408 this syntax is described in @ref{Text alignment}.
410 @lilypond[quote,verbatim,fragment,relative=1]
411 c1^\markup { \column { a bbbb \line { c d } } }
412 c1^\markup { \center-align { a bbbb c } }
413 c1^\markup { \line { a b c } }
416 Lists of words that are not enclosed with double quotes
417 or preceded by a previous command are not kept distinct. In
418 the following example, the first two @code{\markup} expressions
421 @lilypond[quote,verbatim,fragment,relative=1]
422 c1^\markup { \center-align { a bbb c } }
423 c1^\markup { \center-align { a { bbb c } } }
424 c1^\markup { \center-align { a \line { bbb c } } }
428 Markups can be stored in variables. These variables may be
431 @lilypond[quote,verbatim]
432 allegro = \markup { \bold \large Allegro }
442 An exhaustive list of @code{\markup}-specific commands can be found in
443 @ref{Text markup commands}.
446 TODO: here are some commands that could be described here.
447 I'm putting them in bulk, prior to working on this section. -vv
459 \page-ref (see also "Table of contents")
483 This manual: @ref{Text markup commands}.
488 Internals Reference: @rinternals{TextScript}.
490 Init files: @file{scm/@/new@/-markup@/.scm}.
495 Kerning or generation of ligatures is only done when the @TeX{}
496 backend is used. In this case, LilyPond does not account for them
497 so texts will be spaced slightly too wide.
499 Syntax errors for markup mode are confusing.
501 @node Common markup commands
502 @subsubsection Common markup commands
504 Some basic formatting can be used blah blah
507 @cindex font switching
509 Some font switching commands are demonstrated here.
518 @c TODO: what's the difference between the following commands? -vv
524 Some alternate font families can easily be selected:
529 \number (only for numbers, such as fingerings and time signatures)
530 @c TODO: add \slashed-digit here? -vv
532 The size can be blah blah blah
536 Some predefined font sizes can be used blah blah
545 Some shorcuts allow to change the font size relatively to its previous value
553 Text may be printed as subscript or superscript:
558 To obtain subscripts or superscripts in a normal text size, use
562 All these settings (except the size) can be reverted to the default font:
568 @subsubsection Text alignment
571 Some objects have alignment procedures of their own, which cancel
572 out any effects of alignments applied to their markup arguments as
573 a whole. For example, the @rinternals{RehearsalMark} is
574 horizontally centered, so using @code{\mark \markup @{ \left-align
575 .. @}} has no effect.
577 In addition, vertical placement is performed after creating the
578 text markup object. If you wish to move an entire piece of
579 markup, you need to use the #'padding property or create an
580 @q{anchor} point inside the markup (generally with @code{\hspace
583 @lilypond[quote,verbatim,fragment,relative=1]
585 c'4^\markup{ \raise #5 "not raised" }
586 \once \override TextScript #'padding = #3
587 c'4^\markup{ raised }
588 c'4^\markup{ \hspace #0 \raise #1.5 raised }
591 Some situations (such as dynamic marks) have preset font-related
592 properties. If you are creating text in such situations, it is
593 advisable to cancel those properties with @code{normal-text}. See
594 @ref{Text markup commands}, for more details.
602 Horizontal alignment:
613 Building a "large" markup:
626 Alignment inside a "large" markup:
636 @node Graphic notation inside markup
637 @subsubsection Graphic notation inside markup
638 Graphics around text:
645 "Standalone" graphics:
665 @node Music notation inside markup
666 @subsubsection Music notation inside markup
668 Notes can be printed in markup mode blah blah:
673 Accidental symbols can be obtained easily:
685 Some other notation objects blah blah
693 @c TODO: add \text here? -vv
695 Any musical symbol can be printed
698 @c TODO: add \lookup here? -vv
701 The markup mode has support for fret diagrams:
705 \fret-diagram-verbose
707 An entire @code{\score} block can even be nested in a @code{\markup}
708 block. In such a case, the @code{\score} must contain a @code{\layout} block.
714 @lilypond[quote,verbatim,ragged-right]
718 \relative { c4 d e f }
731 @node Multi-page markup
732 @subsubsection Multi-page markup
734 Whereas @code{\markup} is used to enter a non-breakable block of
735 text, @code{\markuplines} can be used at top-level to enter lines
736 of text that can spread over multiple pages:
741 A very long text of justified lines.
745 An other very long paragraph.
752 @code{\markuplines} accepts a list of markup, that is either the
753 result of a markup list command, or a list of markups or of markup
754 lists. The built-in markup list commands are described in
755 @ref{Text markup list commands}.
759 This manual: @ref{Text markup list commands}, @ref{New
760 markup list command definition}.
767 @funindex \markuplines
772 @c TODO: move the following subsubsec into NR3 -vv
778 * Entire document fonts::
779 * Single entry fonts::
782 @node Entire document fonts
783 @subsubsection Entire document fonts
785 It is also possible to change the default font family for the
786 entire document. This is done by calling the
787 @code{make-pango-font-tree} from within the @code{\paper} block.
788 The function takes names for the font families to use for roman,
789 sans serif and monospaced text. For example,
791 @cindex font families, setting
800 (make-pango-font-tree "Times New Roman"
807 c'^\markup { roman: foo \sans bla \typewriter bar }
811 @c we don't do Helvetica / Courier, since GS incorrectly loads
815 @node Single entry fonts
816 @subsubsection Single entry fonts
818 @cindex font selection
819 @cindex font magnification
820 @funindex font-interface
822 By setting the object properties described below, you can select a
823 font from the preconfigured font families. LilyPond has default
824 support for the feta music fonts. Text fonts are selected through
825 Pango/FontConfig. The serif font defaults to New Century
826 Schoolbook, the sans and typewriter to whatever the Pango
827 installation defaults to.
831 @item @code{font-encoding}
832 is a symbol that sets layout of the glyphs. This should only be
833 set to select different types of non-text fonts, e.g.
835 @code{fetaBraces} for piano staff braces, @code{fetaMusic} the
836 standard music font, including ancient glyphs, @code{fetaDynamic}
837 for dynamic signs and @code{fetaNumber} for the number font.
839 @item @code{font-family}
840 is a symbol indicating the general class of the typeface.
841 Supported are @code{roman} (Computer Modern), @code{sans}, and
844 @item @code{font-shape}
845 is a symbol indicating the shape of the font. There are typically
846 several font shapes available for each font family. Choices are
847 @code{italic}, @code{caps}, and @code{upright}.
849 @item @code{font-series}
850 is a symbol indicating the series of the font. There are
851 typically several font series for each font family and shape.
852 Choices are @code{medium} and @code{bold}.
856 Fonts selected in the way sketched above come from a predefined
857 style sheet. If you want to use a font from outside the style
858 sheet, then set the @code{font-name} property,
860 @lilypond[fragment,verbatim]
862 \override Staff.TimeSignature #'font-name = #"Charter"
863 \override Staff.TimeSignature #'font-size = #2
866 \override #'(font-name . "Vera Bold")
867 { This text is in Vera Bold }
873 Any font can be used, as long as it is available to
874 Pango/FontConfig. To get a full list of all available fonts, run
878 lilypond -dshow-available-fonts blabla
881 (the last argument of the command can be anything, but has to be
885 The size of the font may be set with the @code{font-size}
886 property. The resulting size is taken relative to the
887 @code{text-font-size} as defined in the @code{\paper} block.
890 @cindex font magnification