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,doctitle]
213 {printing-marks-at-the-end-of-a-line-or-a-score.ly}
215 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
216 {aligning-marks-with-various-notation-objects.ly}
218 @lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle]
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 @cindex markup expressions
337 @cindex markup syntax
339 The markup syntax is similar to LilyPond's usual syntax: a
340 @code{\markup} expression is enclosed in curly braces @code{@{
343 In markup mode, specific commands are entered using the backslash
344 @code{\} character. Such commands only affect the first following
347 Markup expressions may also be enclosed in double quotes
348 @code{"..."}. Such expressions are treated as text strings
349 and may not contain nested expressions or commands.
350 Therefore, braces are generally prefered to double quotes;
351 the following example demonstrates both syntaxes.
353 @lilypond[quote,verbatim,fragment,relative=1]
355 a2^\markup { poco \italic più forte }
357 d2_\markup { \italic "string. assai" }
359 b1^\markup { \bold { molto \italic agitato } }
363 @cindex special characters in markup mode
364 @cindex markup mode, special characters
365 @cindex reserved characters, printing
366 @cindex printing special characters
368 Special characters such as @code{\} and @code{#}
369 can be printed in the output simply using double
370 quotes. Double quotation marks are only printed
371 in the output when preceded by backslashes:
373 @lilypond[quote,verbatim,fragment,relative=1]
375 a^\markup "##\ LEPORELLO \##"
376 a_\markup "Bravi! \"Cosa rara\"!"
381 The way markup expressions are defined affects
382 how these expressions will stacked, centered and aligned
383 when using the commands explained in @ref{Text alignment}.
385 @lilypond[quote,verbatim,fragment,relative=1]
386 c1^\markup { \column { a bbbb \line { c d } } }
387 c1^\markup { \center-align { a bbbb c } }
388 c1^\markup { \line { a b c } }
391 Lists of words that are not enclosed with double quotes
392 or preceded by a previous command are not kept distinct. In
393 the following example, the first two @code{\markup} expressions
396 @lilypond[quote,verbatim,fragment,relative=1]
397 c1^\markup { \center-align { a bbb c } }
398 c1^\markup { \center-align { a { bbb c } } }
399 c1^\markup { \center-align { a \line { bbb c } } }
403 Markups can be stored in variables. These variables may be
404 directly attached to notes:
406 @lilypond[quote,verbatim]
407 allegro = \markup { \bold \large Allegro }
417 An exhaustive list of @code{\markup}-specific commands can be found in
418 @ref{Text markup commands}.
423 This manual: @ref{Text markup commands}.
428 Internals Reference: @rinternals{TextScript}.
430 Init files: @file{scm/@/new@/-markup@/.scm}.
435 @c FIXME: this is totally deprecated, isn't it? -vv
436 Kerning or generation of ligatures is only done when the @TeX{}
437 backend is used. In this case, LilyPond does not account for them
438 so texts will be spaced slightly too wide.
440 @c is the following sentence really relevant? -vv
441 Syntax errors for markup mode are confusing.
444 @node Common markup commands
445 @subsubsection Common markup commands
447 Some basic formatting can be used blah blah
452 TODO: here are some commands that could be described here.
453 I'm putting them in bulk, prior to working on this section. -vv
465 \page-ref (see also "Table of contents")
489 @cindex font switching
491 Some font switching commands are demonstrated here.
500 @c TODO: what's the difference between the following commands? -vv
506 Some alternate font families can easily be selected:
511 \number (only for numbers, such as fingerings and time signatures)
512 @c TODO: add \slashed-digit here? -vv
514 The size can be blah blah blah
518 Some predefined font sizes can be used blah blah
527 Some shorcuts allow to change the font size relatively to its previous value
535 Text may be printed as subscript or superscript:
540 To obtain subscripts or superscripts in a normal text size, use
544 All these settings (except the size) can be reverted to the default font:
550 @subsubsection Text alignment
553 Some objects have alignment procedures of their own, which cancel
554 out any effects of alignments applied to their markup arguments as
555 a whole. For example, the @rinternals{RehearsalMark} is
556 horizontally centered, so using @code{\mark \markup @{ \left-align
557 .. @}} has no effect.
559 In addition, vertical placement is performed after creating the
560 text markup object. If you wish to move an entire piece of
561 markup, you need to use the #'padding property or create an
562 @q{anchor} point inside the markup (generally with @code{\hspace
565 @lilypond[quote,verbatim,fragment,relative=1]
567 c'4^\markup{ \raise #5 "not raised" }
568 \once \override TextScript #'padding = #3
569 c'4^\markup{ raised }
570 c'4^\markup{ \hspace #0 \raise #1.5 raised }
573 Some situations (such as dynamic marks) have preset font-related
574 properties. If you are creating text in such situations, it is
575 advisable to cancel those properties with @code{normal-text}. See
576 @ref{Text markup commands}, for more details.
584 Horizontal alignment:
595 Building a "large" markup:
608 Alignment inside a "large" markup:
618 @node Graphic notation inside markup
619 @subsubsection Graphic notation inside markup
620 Graphics around text:
627 "Standalone" graphics:
647 @node Music notation inside markup
648 @subsubsection Music notation inside markup
650 Notes can be printed in markup mode blah blah:
655 Accidental symbols can be obtained easily:
667 Some other notation objects blah blah
675 @c TODO: add \text here? -vv
677 Any musical symbol can be printed
680 @c TODO: add \lookup here? -vv
683 The markup mode has support for fret diagrams:
687 \fret-diagram-verbose
689 An entire @code{\score} block can even be nested in a @code{\markup}
690 block. In such a case, the @code{\score} must contain a @code{\layout} block.
696 @lilypond[quote,verbatim,ragged-right]
700 \relative { c4 d e f }
713 @node Multi-page markup
714 @subsubsection Multi-page markup
716 Whereas @code{\markup} is used to enter a non-breakable block of
717 text, @code{\markuplines} can be used at top-level to enter lines
718 of text that can spread over multiple pages:
723 A very long text of justified lines.
727 An other very long paragraph.
734 @code{\markuplines} accepts a list of markup, that is either the
735 result of a markup list command, or a list of markups or of markup
736 lists. The built-in markup list commands are described in
737 @ref{Text markup list commands}.
741 This manual: @ref{Text markup list commands}, @ref{New
742 markup list command definition}.
749 @funindex \markuplines
754 @c TODO: move the following subsubsec into NR3 -vv
760 * Entire document fonts::
761 * Single entry fonts::
764 @node Entire document fonts
765 @subsubsection Entire document fonts
767 It is also possible to change the default font family for the
768 entire document. This is done by calling the
769 @code{make-pango-font-tree} from within the @code{\paper} block.
770 The function takes names for the font families to use for roman,
771 sans serif and monospaced text. For example,
773 @cindex font families, setting
782 (make-pango-font-tree "Times New Roman"
789 c'^\markup { roman: foo \sans bla \typewriter bar }
793 @c we don't do Helvetica / Courier, since GS incorrectly loads
797 @node Single entry fonts
798 @subsubsection Single entry fonts
800 @cindex font selection
801 @cindex font magnification
802 @funindex font-interface
804 By setting the object properties described below, you can select a
805 font from the preconfigured font families. LilyPond has default
806 support for the feta music fonts. Text fonts are selected through
807 Pango/FontConfig. The serif font defaults to New Century
808 Schoolbook, the sans and typewriter to whatever the Pango
809 installation defaults to.
813 @item @code{font-encoding}
814 is a symbol that sets layout of the glyphs. This should only be
815 set to select different types of non-text fonts, e.g.
817 @code{fetaBraces} for piano staff braces, @code{fetaMusic} the
818 standard music font, including ancient glyphs, @code{fetaDynamic}
819 for dynamic signs and @code{fetaNumber} for the number font.
821 @item @code{font-family}
822 is a symbol indicating the general class of the typeface.
823 Supported are @code{roman} (Computer Modern), @code{sans}, and
826 @item @code{font-shape}
827 is a symbol indicating the shape of the font. There are typically
828 several font shapes available for each font family. Choices are
829 @code{italic}, @code{caps}, and @code{upright}.
831 @item @code{font-series}
832 is a symbol indicating the series of the font. There are
833 typically several font series for each font family and shape.
834 Choices are @code{medium} and @code{bold}.
838 Fonts selected in the way sketched above come from a predefined
839 style sheet. If you want to use a font from outside the style
840 sheet, then set the @code{font-name} property,
842 @lilypond[fragment,verbatim]
844 \override Staff.TimeSignature #'font-name = #"Charter"
845 \override Staff.TimeSignature #'font-size = #2
848 \override #'(font-name . "Vera Bold")
849 { This text is in Vera Bold }
855 Any font can be used, as long as it is available to
856 Pango/FontConfig. To get a full list of all available fonts, run
860 lilypond -dshow-available-fonts blabla
863 (the last argument of the command can be anything, but has to be
867 The size of the font may be set with the @code{font-size}
868 property. The resulting size is taken relative to the
869 @code{text-font-size} as defined in the @code{\paper} block.
872 @cindex font magnification