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: @internalsref{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: @internalsref{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: @internalsref{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: @internalsref{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 syntax,
334 called @qq{markup mode}.
335 Specific commands can be entered in this mode, using the
336 backslash @code{\} character.
337 @c TODO: move the following sentence (and add an example?) -vv
338 To @emph{print} such characters as
339 @code{\} and @code{#} in the output, use double
342 @lilypond[quote,verbatim,fragment,relative=1]
344 c1_\markup { hi there }
345 c1^\markup { hi \bold there, is \italic {anyone home?} }
346 c1_\markup { "\special {weird} #characters" }
350 An exhaustive list of @code{\markup}-specific commands can be found in
351 @ref{Text markup commands}.
354 @lilypond[quote,verbatim]
355 \header{ title = \markup{ \bold { foo \italic { bar! } } } }
358 \override Score.RehearsalMark
359 #'break-visibility = #begin-of-line-invisible
360 \override Score.RehearsalMark #'self-alignment-X = #right
362 \set Staff.instrumentName = \markup{ \column{ Alto solo } }
363 c2^\markup{ don't be \flat }
364 \override TextSpanner #'bound-details #'left #'text = \markup{\italic rit }
366 a2\mark \markup{ \large \bold Fine }
370 \addlyrics { bar, foo \markup{ \italic bar! } }
376 @cindex font switching
378 Some font switching commands are demonstrated here. Such commands
379 apply only to the first following word; several words may be affected
380 by enclosing them in braces.
383 \markup @{ \bold @{ hi there @} @}
386 @c TODO: remove the following line and example? -vv
388 For clarity, you can also do this for single arguments, e.g.,
391 \markup @{ is \italic @{ anyone @} home @}
394 The markup mode can be used to compose expressions, similar to
395 mathematical expressions, XML documents, and music expressions.
396 Such expressions can be vertically stacked, horizontally centered,
397 or aligned in different ways:
399 @lilypond[quote,verbatim,fragment,relative=1]
400 c1^\markup { \column { a bbbb \line { c d } } }
401 c1^\markup { \center-align { a bbbb c } }
402 c1^\markup { \line { a b c } }
405 Lists with no previous command are not kept distinct. In
406 the following example, the two @code{\markup} expressions
409 @c TODO: merge these two examples in a @lilypond example -vv
412 \center-align @{ @{ a b @} @{ c d @} @}
413 \center-align @{ a b c d @}
418 To keep lists of words distinct, please use quotes @code{"} or
419 the @code{\line} command
421 @lilypond[quote,verbatim,fragment,relative=1]
423 c4^\markup{ \center-align { on three lines } }
424 c4^\markup{ \center-align { "all one line" } }
425 c4^\markup{ \center-align { { on three lines } } }
426 c4^\markup{ \center-align { \line { on one line } } }
429 Markups can be stored in variables and these variables may be
430 attached to notes, like
433 allegro = \markup @{ \bold \large @{ Allegro @} @}
434 @{ a^\allegro b c d @}
437 Some objects have alignment procedures of their own, which cancel
438 out any effects of alignments applied to their markup arguments as
439 a whole. For example, the @internalsref{RehearsalMark} is
440 horizontally centered, so using @code{\mark \markup @{ \left-align
441 .. @}} has no effect.
443 In addition, vertical placement is performed after creating the
444 text markup object. If you wish to move an entire piece of
445 markup, you need to use the #'padding property or create an
446 @q{anchor} point inside the markup (generally with @code{\hspace
449 @lilypond[quote,verbatim,fragment,relative=1]
451 c'4^\markup{ \raise #5 "not raised" }
452 \once \override TextScript #'padding = #3
453 c'4^\markup{ raised }
454 c'4^\markup{ \hspace #0 \raise #1.5 raised }
457 Some situations (such as dynamic marks) have preset font-related
458 properties. If you are creating text in such situations, it is
459 advisable to cancel those properties with @code{normal-text}. See
460 @ref{Text markup commands}, for more details.
463 TODO: here are some commands that could be described here.
464 I'm putting them in bulk, prior to working on this section. -vv
476 \page-ref (see also "Table of contents")
500 This manual: @ref{Text markup commands}.
505 Internals Reference: @internalsref{TextScript}.
507 Init files: @file{scm/@/new@/-markup@/.scm}.
512 Kerning or generation of ligatures is only done when the @TeX{}
513 backend is used. In this case, LilyPond does not account for them
514 so texts will be spaced slightly too wide.
516 Syntax errors for markup mode are confusing.
518 @node Common markup commands
519 @subsubsection Common markup commands
521 Some basic formatting can be used blah blah
530 @c TODO: what's the difference between the following commands? -vv
536 Some alternate font families can easily be selected:
541 \number (only for numbers, such as fingerings and time signatures)
542 @c TODO: add \slashed-digit here? -vv
544 The size can be blah blah blah
548 Some predefined font sizes can be used blah blah
557 Some shorcuts allow to change the font size relatively to its previous value
565 Text may be printed as subscript or superscript:
570 To obtain subscripts or superscripts in a normal text size, use
574 All these settings (except the size) can be reverted to the default font:
580 @subsubsection Text alignment
587 Horizontal alignment:
598 Building a "large" markup:
611 Alignment inside a "large" markup:
621 @node Graphic notation inside markup
622 @subsubsection Graphic notation inside markup
623 Graphics around text:
630 "Standalone" graphics:
650 @node Music notation inside markup
651 @subsubsection Music notation inside markup
653 Notes can be printed in markup mode blah blah:
658 Accidental symbols can be obtained easily:
670 Some other notation objects blah blah
678 @c TODO: add \text here? -vv
680 Any musical symbol can be printed
683 @c TODO: add \lookup here? -vv
686 The markup mode has support for fret diagrams:
690 \fret-diagram-verbose
692 An entire @code{\score} block can even be nested in a @code{\markup}
693 block. In such a case, the @code{\score} must contain a @code{\layout} block.
699 @lilypond[quote,verbatim,ragged-right]
703 \relative { c4 d e f }
716 @node Multi-page markup
717 @subsubsection Multi-page markup
719 Whereas @code{\markup} is used to enter a non-breakable block of
720 text, @code{\markuplines} can be used at top-level to enter lines
721 of text that can spread over multiple pages:
726 A very long text of justified lines.
730 An other very long paragraph.
737 @code{\markuplines} accepts a list of markup, that is either the
738 result of a markup list command, or a list of markups or of markup
739 lists. The built-in markup list commands are described in
740 @ref{Text markup list commands}.
744 This manual: @ref{Text markup list commands}, @ref{New
745 markup list command definition}.
752 @funindex \markuplines
757 @c TODO: move the following subsubsec into NR3 -vv
763 * Entire document fonts::
764 * Single entry fonts::
767 @node Entire document fonts
768 @subsubsection Entire document fonts
770 It is also possible to change the default font family for the
771 entire document. This is done by calling the
772 @code{make-pango-font-tree} from within the @code{\paper} block.
773 The function takes names for the font families to use for roman,
774 sans serif and monospaced text. For example,
776 @cindex font families, setting
785 (make-pango-font-tree "Times New Roman"
792 c'^\markup { roman: foo \sans bla \typewriter bar }
796 @c we don't do Helvetica / Courier, since GS incorrectly loads
800 @node Single entry fonts
801 @subsubsection Single entry fonts
803 @cindex font selection
804 @cindex font magnification
805 @funindex font-interface
807 By setting the object properties described below, you can select a
808 font from the preconfigured font families. LilyPond has default
809 support for the feta music fonts. Text fonts are selected through
810 Pango/FontConfig. The serif font defaults to New Century
811 Schoolbook, the sans and typewriter to whatever the Pango
812 installation defaults to.
816 @item @code{font-encoding}
817 is a symbol that sets layout of the glyphs. This should only be
818 set to select different types of non-text fonts, e.g.
820 @code{fetaBraces} for piano staff braces, @code{fetaMusic} the
821 standard music font, including ancient glyphs, @code{fetaDynamic}
822 for dynamic signs and @code{fetaNumber} for the number font.
824 @item @code{font-family}
825 is a symbol indicating the general class of the typeface.
826 Supported are @code{roman} (Computer Modern), @code{sans}, and
829 @item @code{font-shape}
830 is a symbol indicating the shape of the font. There are typically
831 several font shapes available for each font family. Choices are
832 @code{italic}, @code{caps}, and @code{upright}.
834 @item @code{font-series}
835 is a symbol indicating the series of the font. There are
836 typically several font series for each font family and shape.
837 Choices are @code{medium} and @code{bold}.
841 Fonts selected in the way sketched above come from a predefined
842 style sheet. If you want to use a font from outside the style
843 sheet, then set the @code{font-name} property,
845 @lilypond[fragment,verbatim]
847 \override Staff.TimeSignature #'font-name = #"Charter"
848 \override Staff.TimeSignature #'font-size = #2
851 \override #'(font-name . "Vera Bold")
852 { This text is in Vera Bold }
858 Any font can be used, as long as it is available to
859 Pango/FontConfig. To get a full list of all available fonts, run
863 lilypond -dshow-available-fonts blabla
866 (the last argument of the command can be anything, but has to be
870 The size of the font may be set with the @code{font-size}
871 property. The resulting size is taken relative to the
872 @code{text-font-size} as defined in the @code{\paper} block.
875 @cindex font magnification