X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fnotation%2Ftext.itely;h=3ba9e554a6342262a9ee34cbd49c02165b147ad5;hb=80340bdefc128536c79733d8c6f3467d91b01f72;hp=3f1d612441ce7d9d6f9f8a63b44edd6812b8196c;hpb=95a4237d0aca94993bd3b91afc4ff0e4e2daec9f;p=lilypond.git diff --git a/Documentation/notation/text.itely b/Documentation/notation/text.itely index 3f1d612441..3ba9e554a6 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.13.36" +@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 @@ -99,14 +98,14 @@ articulations, see @rlearning{Placement of objects}. @code{\textLengthOff}. @endpredefined - @seealso Learning Manual: @rlearning{Placement of objects}. Notation Reference: @ref{Formatting text}, -@ref{Direction and placement}. +@ref{Direction and placement}, +@ref{Articulations and ornamentations}. Snippets: @rlsr{Text}. @@ -114,22 +113,18 @@ Snippets: Internals Reference: @rinternals{TextScript}. - @cindex text outside margin @cindex margin, text running over @cindex text, keeping inside margin @cindex lyrics, keeping inside margin - @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 +135,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 +151,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 +163,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 +183,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 +220,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 +255,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,16 +271,15 @@ 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} - @seealso Notation Reference: @ref{Rehearsal marks}, @@ -351,21 +344,20 @@ 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} - @seealso Notation Reference: @ref{Formatting text}, @@ -415,8 +407,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 +436,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. @@ -485,7 +477,6 @@ allegro = \markup { \bold \large Allegro } An exhaustive list of @code{\markup}-specific commands can be found in @ref{Text markup commands}. - @seealso Notation Reference: @ref{Text markup commands}. @@ -493,12 +484,10 @@ Notation Reference: Snippets: @rlsr{Text}. -Installed files: +Installed Files: @file{scm/markup.scm}. - @knownissues - Syntax errors for markup mode can be confusing. @@ -615,8 +604,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 @@ -675,7 +664,6 @@ Defining custom font sets is also possible, as explained in @code{\larger}. @endpredefined - @seealso Notation Reference: @ref{Font}, @@ -683,14 +671,20 @@ Notation Reference: @ref{Manual repeat marks}, @ref{Fonts}. +Installed Files: +@file{scm/define-markup-commands.scm}. + Snippets: @rlsr{Text}. Internals Reference: @rinternals{TextScript}. -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 +746,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 @@ -930,7 +925,6 @@ as shown in the following example. An exhaustive list of text alignment commands can be found in @ref{Align}. - @seealso Learning Manual: @rlearning{Moving objects}. @@ -939,15 +933,15 @@ Notation Reference: @ref{Align}, @ref{Text marks}. +Installed Files: +@file{scm/define-markup-commands.scm}. + Snippets: @rlsr{Text}. Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/define-markup-commands.scm}. - @node Graphic notation inside markup @unnumberedsubsubsec Graphic notation inside markup @@ -1114,11 +1108,15 @@ c An exhaustive list of graphics-specific commands can be found in @ref{Graphic}. - @seealso Notation Reference: @ref{Graphic}, -@ref{Editorial annotations}. +@ref{Editorial annotations}, +@ref{Align}. + +Installed Files: +@file{scm/define-markup-commands.scm}, +@file{scm/stencil.scm}. Snippets: @rlsr{Text}. @@ -1126,10 +1124,6 @@ Snippets: Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/define-markup-commands.scm}, -@file{scm/stencil.scm}. - @node Music notation inside markup @unnumberedsubsubsec Music notation inside markup @@ -1184,8 +1178,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 +1190,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: @@ -1245,24 +1240,23 @@ c d e f An exhaustive list of music notation related commands can be found in @ref{Music}. - @seealso Notation Reference: @ref{Music}, @ref{The Feta font}, @ref{Fonts explained}. +Installed Files: +@file{scm/define-markup-commands.scm}, +@file{scm/fret-diagrams.scm}, +@file{scm/harp-pedals.scm}. + Snippets: @rlsr{Text}. Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/define-markup-commands.scm}, -@file{scm/fret-diagrams.scm}, -@file{scm/harp-pedals.scm}. - @node Multi-page markup @unnumberedsubsubsec Multi-page markup @@ -1272,8 +1266,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 +1278,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. ... @@ -1310,29 +1304,27 @@ a list of markup lists. An exhaustive list of markup list commands can be found in @ref{Text markup list commands}. - @seealso Notation Reference: -@ref{Text markup list commands}, +@ref{Text markup list commands}. + +Extending LilyPond: +@rextend{New markup list command definition}. + +Installed Files: +@file{scm/define-markup-commands.scm}. Snippets: @rlsr{Text}. -Extending: -@rextend{New markup list command definition}. - Internals Reference: @rinternals{TextScript}. -Installed files: -@file{scm/define-markup-commands.scm}. - - -@funindex \markuplines -@funindex markuplines +@funindex \markuplist +@funindex markuplist @predefined -@code{\markuplines}. +@code{\markuplist}. @endpredefined @@ -1395,9 +1387,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 +1408,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 { @@ -1445,11 +1437,11 @@ Although it is easy to switch between preconfigured fonts, it is also possible to use other fonts, as explained in the following sections: @ref{Single entry fonts} and @ref{Entire document fonts}. - @seealso Notation Reference: @ref{The Feta font}, @ref{Music notation inside markup}, +@ref{Rotating objects}, @ref{Selecting font and font size}, @ref{Font}. @@ -1485,7 +1477,6 @@ operating system: lilypond -dshow-available-fonts x @end example - @seealso Notation Reference: @ref{Fonts explained}, @@ -1495,7 +1486,7 @@ Snippets: @rlsr{Text}. @c A source file gets never installed... -@c Installed files: +@c Installed Files: @c @file{lily/font-config-scheme.cc}. @@ -1533,7 +1524,6 @@ explanation of fonts, see @ref{Fonts explained}. @c we don't do Helvetica / Courier, since GS incorrectly loads @c Apple TTF fonts - @seealso Notation Reference: @ref{Fonts explained},