X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fnotation%2Ftext.itely;h=a770eb1d9cf6b62712ac893c66b11e94ec1cfde0;hb=6646c71a5309b40a4594db67b5426c6f3786f372;hp=09337c43f07d9c44b337c5ec3b48c54301493292;hpb=4ffdbfcd368a1ae630aafa48f85708386ce9881a;p=lilypond.git diff --git a/Documentation/notation/text.itely b/Documentation/notation/text.itely index 09337c43f0..a770eb1d9c 100644 --- a/Documentation/notation/text.itely +++ b/Documentation/notation/text.itely @@ -7,7 +7,7 @@ Guide, node Updating translation committishes.. @end ignore -@c \version "2.12.0" +@c \version "2.15.17" @node Text @section Text @@ -63,19 +63,18 @@ in @ref{Direction and placement}. a8^"pizz." g f e a4-"scherz." f @end lilypond -This syntax is actually a shorthand; more complex text -formatting may be added to a note by explicitly using a -@code{\markup} block, as described in @ref{Formatting text}. +This syntax is actually a shorthand; more complex text formatting may be +added to a note by explicitly using a @code{\markup} block, as described +in @ref{Formatting text}. @lilypond[quote,verbatim,relative=2] a8^\markup { \italic pizz. } g f e a4_\markup { \tiny scherz. \bold molto } f @end lilypond -By default, text indications do not influence the note spacing. -However, their widths can be taken into account: -in the following example, the first text string does not affect -spacing, whereas the second one does. +By default, text indications do not influence the note spacing. However, +their widths can be taken into account: in the following example, the +first text string does not affect spacing, whereas the second one does. @lilypond[quote,verbatim,relative=2] a8^"pizz." g f e @@ -106,7 +105,8 @@ Learning Manual: Notation Reference: @ref{Formatting text}, -@ref{Direction and placement}. +@ref{Direction and placement}, +@ref{Articulations and ornamentations}. Snippets: @rlsr{Text}. @@ -122,14 +122,12 @@ Internals Reference: @knownissues - Checking to make sure that text scripts and lyrics are within the -margins is a relatively large computational task. To speed up -processing, LilyPond does not perform such calculations by -default; to enable it, use +margins requires additonal calculations. In cases where slightly faster +performance is desired, use @example -\override Score.PaperColumn #'keep-inside-line = ##t +\override Score.PaperColumn #'keep-inside-line = ##f @end example @@ -140,8 +138,9 @@ default; to enable it, use Some performance indications, e.g., @notation{rallentando} or @notation{accelerando}, are written as text and are extended over -multiple notes with dotted lines. Such objects, called @qq{spanners}, -may be created from one note to another using the following syntax: +multiple notes with dotted lines. Such objects, called +@qq{spanners}, may be created from one note to another using the +following syntax: @lilypond[verbatim,quote,relative=2] \override TextSpanner #'(bound-details left text) = "rit." @@ -155,8 +154,8 @@ e,\stopTextSpan @noindent The string to be printed is set through object properties. By default it is printed in italic characters, but different formatting can be -obtained using @code{\markup} blocks, as described in @ref{Formatting -text}. +obtained using @code{\markup} blocks, as described in +@ref{Formatting text}. @lilypond[quote,relative=2,verbatim] \override TextSpanner #'(bound-details left text) = @@ -167,9 +166,6 @@ e,\stopTextSpan The line style, as well as the text string, can be defined as an object property. This syntax is described in @ref{Line styles}. -Text spanners are part of the @code{Dynamics} context; see -@rinternals{Dynamics}. - @funindex \textSpannerUp @funindex textSpannerUp @@ -190,24 +186,24 @@ LilyPond is only able to handle one text spanner per voice. @snippets -@lilypondfile[verbatim,lilyquote,texidoc,doctitle] +@lilypondfile[verbatim,quote,texidoc,doctitle] {dynamics-text-spanner-postfix.ly} -@lilypondfile[verbatim,lilyquote,texidoc,doctitle] +@lilypondfile[verbatim,quote,texidoc,doctitle] {dynamics-custom-text-spanner-postfix.ly} @seealso Notation Reference: @ref{Line styles}, -@ref{Dynamics}. +@ref{Dynamics}, +@ref{Formatting text}. Snippets: @rlsr{Text}, @rlsr{Expressive marks}. Internals Reference: -@rinternals{TextSpanner}, -@rinternals{Dynamics}. +@rinternals{TextSpanner}. @node Text marks @@ -227,8 +223,8 @@ Internals Reference: @funindex \markup @funindex markup -Various text elements may be added to a score using -the syntax described in @ref{Rehearsal marks}: +Various text elements may be added to a score using the syntax described +in @ref{Rehearsal marks}: @c \mark needs to be placed on a separate line (it's not @c attached to an object like \markup is). -vv @@ -262,10 +258,11 @@ or fermata, by specifying the appropriate symbol name as explained in @end lilypond @noindent -Such objects are only typeset above the top staff of the score; depending on -whether they are specified at the end or the middle of a bar, they -can be placed above the bar line or between notes. When specified at a -line break, the mark will be printed at the beginning of the next line. +Such objects are only typeset above the top staff of the score; +depending on whether they are specified at the end or the middle of a +bar, they can be placed above the bar line or between notes. When +specified at a line break, the mark will be printed at the beginning of +the next line. @lilypond[quote,verbatim,relative=2] \mark "Allegro" @@ -277,13 +274,13 @@ c c @snippets -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] +@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle] {printing-marks-at-the-end-of-a-line.ly} -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] +@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle] {aligning-marks-with-various-notation-objects.ly} -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] +@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle] {printing-marks-on-every-staff.ly} @@ -351,18 +348,18 @@ requires, are described in @ref{Multi-page markup}. @funindex \markup @funindex markup -@funindex \markuplines -@funindex markuplines +@funindex \markuplist +@funindex markuplist @predefined @code{\markup}, -@code{\markuplines}. +@code{\markuplist}. @endpredefined @snippets -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] +@lilypondfile[verbatim,quote,ragged-right,texidoc,doctitle] {stand-alone-two-column-markup.ly} @@ -415,8 +412,8 @@ syntax called @qq{markup mode}. @cindex syntax, markup The markup syntax is similar to LilyPond's usual syntax: a -@code{\markup} expression is enclosed in curly braces @code{@{ -@dots{} @}}. A single word is regarded as a minimal expression, +@code{\markup} expression is enclosed in curly braces +@code{@{@dots{} @}}. A single word is regarded as a minimal expression, and therefore does not need to be enclosed with braces. Unlike simple @qq{quoted text} indications, @code{\markup} blocks may @@ -444,7 +441,7 @@ c A @code{\markup} block may also contain quoted text strings. Such strings are treated as minimal text expressions, and therefore any -markup command or special character (such as @code{\} and @code{#}) +markup command or special character (such as @code{\} and@tie{}@code{#}) will be printed verbatim without affecting the formatting of the text. Double quotation marks themselves may be printed by preceding them with backslashes. @@ -493,12 +490,11 @@ Notation Reference: Snippets: @rlsr{Text}. -Installed files: -@file{scm/@/markup@/.scm}. +Installed Files: +@file{scm/markup.scm}. @knownissues - Syntax errors for markup mode can be confusing. @@ -615,8 +611,8 @@ example, there is no difference between the first and the second word. @noindent Some of these font families, used for specific items such as numbers -or dynamics, do not provide all characters, as mentioned in @ref{New -dynamic marks} and @ref{Manual repeat marks}. +or dynamics, do not provide all characters, as mentioned in +@ref{New dynamic marks} and @ref{Manual repeat marks}. @c \concat is actually documented in Align (it is not @c a font-switching command). But we need it here. -vv @@ -689,8 +685,14 @@ Snippets: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/@/define@/-markup@/-commands@/.scm}. +Installed Files: +@file{scm/define-markup-commands.scm}. + +@knownissues +Using the font sizing commands @code{\teeny}, @code{\tiny}, +@code{\small}, @code{\normalsize}, @code{\large}, and +@code{\huge} will lead to inconsistent line spacing compared to +using @code{\fontsize}. @node Text alignment @@ -752,7 +754,8 @@ a,-\markup { \halign #2 poco } @noindent Some objects may have alignment procedures of their own, and therefore are not affected by these commands. It is possible to move such -markup objects as a whole, as shown for instance in @ref{Text marks}. +markup objects as a whole, as shown for instance in +@ref{Text marks}. @cindex text, vertical alignment @cindex vertical text alignment @@ -945,8 +948,8 @@ Snippets: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/@/define@/-markup@/-commands@/.scm}. +Installed Files: +@file{scm/define-markup-commands.scm}. @node Graphic notation inside markup @@ -1118,7 +1121,8 @@ An exhaustive list of graphics-specific commands can be found in @seealso Notation Reference: @ref{Graphic}, -@ref{Editorial annotations}. +@ref{Editorial annotations}, +@ref{Align}. Snippets: @rlsr{Text}. @@ -1126,9 +1130,9 @@ Snippets: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/@/define@/-markup@/-commands@/.scm}, -@file{scm/@/stencil@/.scm}. +Installed Files: +@file{scm/define-markup-commands.scm}, +@file{scm/stencil.scm}. @node Music notation inside markup @@ -1184,8 +1188,8 @@ d-\markup { More generally, any available musical symbol may be included separately in a markup object, as demonstrated below; an exhaustive -list of these symbols and their names can be found in @ref{The Feta -font}. +list of these symbols and their names can be found in +@ref{The Feta font}. @lilypond[quote,verbatim,relative=2] c2 @@ -1196,8 +1200,9 @@ c16 c2^\markup { \musicglyph #"timesig.neomensural94" } @end lilypond -Another way of printing non-text glyphs is described in @ref{Fonts -explained}. This is useful for printing braces of various sizes. +Another way of printing non-text glyphs is described in +@ref{Fonts explained}. This is useful for printing braces of various +sizes. The markup mode also supports diagrams for specific instruments: @@ -1212,10 +1217,10 @@ c^\markup { c c^\markup { \combine - \musicglyph #"accordion.accDiscant" + \musicglyph #"accordion.discant" \combine - \raise #0.5 \musicglyph #"accordion.accDot" - \raise #1.5 \musicglyph #"accordion.accDot" + \raise #0.5 \musicglyph #"accordion.dot" + \raise #1.5 \musicglyph #"accordion.dot" } @end lilypond @@ -1258,10 +1263,10 @@ Snippets: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/@/define@/-markup@/-commands@/.scm}, -@file{scm/@/fret@/-diagrams@/.scm}, -@file{scm/@/harp@/-pedals@/.scm}. +Installed Files: +@file{scm/define-markup-commands.scm}, +@file{scm/fret-diagrams.scm}, +@file{scm/harp-pedals.scm}. @node Multi-page markup @@ -1272,8 +1277,8 @@ Installed files: @cindex markup text, multi-page @cindex text spread over multiple pages -@funindex \markuplines -@funindex markuplines +@funindex \markuplist +@funindex markuplist @funindex \justified-lines @funindex justified-lines @funindex \wordwrap-lines @@ -1284,7 +1289,7 @@ makes it possible to enter lines of text that can spread over multiple pages: @lilypond[quote,verbatim] -\markuplines { +\markuplist { \justified-lines { A very long text of justified lines. ... @@ -1324,15 +1329,15 @@ Extending: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/@/define@/-markup@/-commands@/.scm}. +Installed Files: +@file{scm/define-markup-commands.scm}. -@funindex \markuplines -@funindex markuplines +@funindex \markuplist +@funindex markuplist @predefined -@code{\markuplines}. +@code{\markuplist}. @endpredefined @@ -1395,9 +1400,9 @@ left braces; right braces may be obtained by rotation, see @ref{Rotating objects}. Three families of text fonts are made available: the @emph{roman} -(serif) font, that defaults to New Century Schoolbook, the @emph{sans} -font and the monospaced @emph{typewriter} font -- these last two -families are determined by the Pango installation. +(serif) font, that defaults to New Century Schoolbook, the +@emph{sans} font and the monospaced @emph{typewriter} font -- these +last two families are determined by the Pango installation. Each family may include different shapes and series. The following example demonstrates the ability to select alternate families, shapes, @@ -1416,8 +1421,8 @@ c4^smaller @noindent A similar syntax may be used in markup mode; however in this case it -is preferable to use the simpler syntax explained in @ref{Selecting -font and font size}: +is preferable to use the simpler syntax explained in +@ref{Selecting font and font size}: @lilypond[quote,verbatim] \markup { @@ -1450,6 +1455,7 @@ possible to use other fonts, as explained in the following sections: Notation Reference: @ref{The Feta font}, @ref{Music notation inside markup}, +@ref{Rotating objects}, @ref{Selecting font and font size}, @ref{Font}. @@ -1495,8 +1501,8 @@ Snippets: @rlsr{Text}. @c A source file gets never installed... -@c Installed files: -@c @file{lily/@/font@/-config@/-scheme@/.cc}. +@c Installed Files: +@c @file{lily/font-config-scheme.cc}. @node Entire document fonts