(define-builtin-markup-command (underline layout props arg)
(markup?)
- music
+ font
((thickness 1))
"
@cindex underlining text
thickness and y offset.
@lilypond[verbatim,quote]
-\\markup \\underline { CONTENTS }
+\\markup \\override #'(thickness . 2) \\underline {
+ CONTENTS
+}
@end lilypond"
(let* ((thick (* (ly:output-def-lookup layout 'line-thickness)
thickness))
"
@cindex creating horizontal spaces in text
-This produces a invisible object taking horizontal space. For example,
+This produces an invisible object taking horizontal space. For example,
@example
-\\markup @{ A \\hspace #2.0 B @}
+\\markup @{ A \\hspace #2.0 B @}
@end example
@noindent
puts extra space between A and@tie{}B, on top of the space that is
-normally inserted before elements on a line."
+normally inserted before elements on a line.
+
+@lilypond[verbatim,quote]
+\\markup {
+ one
+ \\hspace #2
+ two
+ \\hspace #8
+ three
+}
+@end lilypond"
(if (> amount 0)
(ly:make-stencil "" (cons 0 amount) '(-1 . 1))
(ly:make-stencil "" (cons amount amount) '(-1 . 1))))
"
@cindex creating empty text objects
-An empty markup with extents of a single point."
+An empty markup with extents of a single point.
+
+@lilypond[verbatim,quote]
+\\markup \\null
+@end lilypond"
point-stencil)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@cindex simple text strings
A simple text string; @code{\\markup @{ foo @}} is equivalent with
-@code{\\markup @{ \\simple #\"foo\" @}}."
+@code{\\markup @{ \\simple #\"foo\" @}}.
+
+@lilypond[verbatim,quote]
+\\markup {
+ \\simple #\"simple\"
+ \\simple #\"text\"
+ \\simple #\"strings\"
+}
+@end lilypond"
(interpret-markup layout props str))
(define-builtin-markup-command (tied-lyric layout props str)
"
@cindex simple text strings with tie characters
-Like simple-markup, but use tie characters for @q{~} tilde symbols."
+Like simple-markup, but use tie characters for @q{~} tilde symbols.
+
+@lilypond[verbatim,quote]
+\\markup \\tied-lyric #\"Lasciate~i monti\"
+@end lilypond"
(if (string-contains str "~")
(let*
((parts (string-split str #\~))
(line-width #f))
"Put @var{markups} in a horizontal line of width @var{line-width}.
The markups are spaced or flushed to fill the entire line.
-If there are no arguments, return an empty stencil."
-
+If there are no arguments, return an empty stencil.
+
+@lilypond[verbatim,quote]
+\\markup \\column {
+ \\fill-line {
+ Words evenly spaced across the page
+ }
+ \\null
+ \\fill-line {
+ \\line { Text markups }
+ \\line \\italic { evenly spaced }
+ \\line { across the page }
+ }
+}
+@end lilypond"
(let* ((orig-stencils (interpret-markup-list layout props markups))
(stencils
(map (lambda (stc)
((word-space)
(text-direction RIGHT))
"Put @var{args} in a horizontal line. The property @code{word-space}
-determines the space between each markup in @var{args}."
+determines the space between each markup in @var{args}.
+
+@lilypond[verbatim,quote]
+\\markup \\line {
+ A simple line of text
+}
+@end lilypond"
(let ((stencils (interpret-markup-list layout props args)))
(if (= text-direction LEFT)
(set! stencils (reverse stencils)))
Concatenate @var{args} in a horizontal line, without spaces inbetween.
Strings and simple markups are concatenated on the input level, allowing
ligatures. For example, @code{\\concat @{ \"f\" \\simple #\"i\" @}} is
-equivalent to @code{\"fi\"}."
+equivalent to @code{\"fi\"}.
+
+@lilypond[verbatim,quote]
+\\markup \\bold {
+ au
+ \\concat {
+ Mouv
+ \\super t
+ }
+}
+@end lilypond"
(define (concat-string-args arg-list)
(fold-right (lambda (arg result-list)
(let ((result (if (pair? result-list)
markup in @var{args}.
@lilypond[verbatim,quote]
-\\markup \\column { one two three }
+\\markup \\column {
+ one
+ two
+ three
+}
@end lilypond"
(let ((arg-stencils (interpret-markup-list layout props args)))
(stack-lines -1 0.0 baseline-skip
Put @code{args} in a centered column.
@lilypond[verbatim,quote]
-\\markup \\center-align { one two three }
+\\markup \\center-align {
+ one
+ two
+ three
+}
@end lilypond"
(let* ((mols (interpret-markup-list layout props args))
(cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols)))
"
@cindex vertically centering text
-Align @code{arg} to its Y@tie{}center."
+Align @code{arg} to its Y@tie{}center.
+
+@lilypond[verbatim,quote]
+\\markup {
+ \\arrow-head #X #RIGHT ##f
+ \\vcenter
+ Centered
+ \\arrow-head #X #LEFT ##f
+}
+@end lilypond"
(let* ((mol (interpret-markup layout props arg)))
(ly:stencil-aligned-to mol Y CENTER)))
"
@cindex horizontally centering text
-Align @code{arg} to its X@tie{}center."
+Align @code{arg} to its X@tie{}center.
+
+@lilypond[verbatim,quote]
+\\markup \\column {
+ ↓
+ \\hcenter
+ centered
+}
+@end lilypond"
(let* ((mol (interpret-markup layout props arg)))
(ly:stencil-aligned-to mol X CENTER)))
"
@cindex right aligning text
-Align @var{arg} on its right edge."
+Align @var{arg} on its right edge.
+
+@lilypond[verbatim,quote]
+\\markup \\column {
+ ↓
+ \\right-align
+ right-aligned
+}
+@end lilypond"
(let* ((m (interpret-markup layout props arg)))
(ly:stencil-aligned-to m X RIGHT)))
"
@cindex left aligning text
-Align @var{arg} on its left edge."
+Align @var{arg} on its left edge.
+
+@lilypond[verbatim,quote]
+\\markup \\column {
+ ↓
+ \\left-align
+ left-aligned
+}
+@end lilypond"
(let* ((m (interpret-markup layout props arg)))
(ly:stencil-aligned-to m X LEFT)))
@cindex setting horizontal text alignment
Set horizontal alignment. If @var{dir} is @code{-1}, then it is
-left-aligned, while @code{+1} is right. Values inbetween interpolate
-alignment accordingly."
+left-aligned, while @code{+1} is right. Values in between interpolate
+alignment accordingly.
+
+@lilypond[verbatim,quote]
+\\markup \\column {
+ ↓
+ \\halign #LEFT
+ Left
+ ↓
+ \\halign #CENTER
+ Center
+ ↓
+ \\halign #RIGHT
+ Right
+ ↓
+ \\halign #1.2
+ \\line { Arbitrary alignment }
+}
+@end lilypond"
(let* ((m (interpret-markup layout props arg)))
(ly:stencil-aligned-to m X dir)))
(markup?)
font
()
- "Decrease the font size relative to current setting."
+ "Decrease the font size relative to current setting.
+
+@lilypond[verbatim,quote]
+\\markup \\fontsize #3 {
+ some large text
+ \\hspace #2
+ \\smaller {
+ a bit smaller
+ }
+}
+@end lilypond"
(interpret-markup layout props
`(,fontsize-markup -1 ,arg)))
-(define-builtin-markup-command larger
+(define-builtin-markup-command (larger layout props arg)
(markup?)
font
- bigger-markup)
+ ()
+ "Copy of the @code{\\bigger} command.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\larger
+ larger
+}
+@end lilypond"
+ (interpret-markup layout props (make-bigger-markup arg)))
(define-builtin-markup-command (finger layout props arg)
(markup?)
()
"Set the argument as small numbers.
@lilypond[verbatim,quote]
-\\markup \\finger { 1 2 3 4 5 }
+\\markup \\finger {
+ 1 2 3 4 5
+}
@end lilypond"
(interpret-markup layout
(cons '((font-size . -5) (font-encoding . fetaNumber)) props)
((font-size 0)
(word-space 1)
(baseline-skip 2))
- "Add @var{increment} to the font-size. Adjust baseline skip accordingly."
+ "Add @var{increment} to the font-size. Adjust baseline skip accordingly.
+@lilypond[verbatim,quote]
+\\markup \\fontsize #-1.5 {
+ Valse mélancolique et langoureux vertige!
+}
+@end lilypond"
(let ((entries (list
(cons 'baseline-skip (* baseline-skip (magstep increment)))
(cons 'word-space (* word-space (magstep increment)))
@end example
Note: Magnification only works if a font name is explicitly selected.
-Use @code{\\fontsize} otherwise."
+Use @code{\\fontsize} otherwise.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\magnify #1.5 {
+ 50% larger
+ }
+}
+@end lilypond"
(interpret-markup
layout
(prepend-alist-chain 'font-size (magnification->font-size sz) props)
(markup?)
font
()
- "Switch to the sans serif family."
+ "Switch to the sans serif family.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\sans {
+ sans serif
+ }
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg))
(define-builtin-markup-command (number layout props arg)
some punctuation. It doesn't have any letters.
@lilypond[verbatim,quote]
-\\markup \\number { 0 1 2 3 4 5 6 7 8 9 . , + - }
+\\markup \\number {
+ 0 1 2 3 4 5 6 7 8 9 . ,
+}
@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg))
(markup?)
font
()
- "Set font family to @code{roman}."
+ "Set font family to @code{roman}.
+
+@lilypond[verbatim,quote]
+\\markup \\sans \\bold {
+ bold sans serif
+ \\hspace #2
+ \\roman {
+ text in roman font family
+ }
+ \\hspace #2
+ return to sans
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-family 'roman props) arg))
(define-builtin-markup-command (huge layout props arg)
(markup?)
font
()
- "Set font size to +2."
+ "Set font size to +2.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\huge
+ huge
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size 2 props) arg))
(define-builtin-markup-command (large layout props arg)
(markup?)
font
()
- "Set font size to +1."
+ "Set font size to +1.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\large
+ large
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size 1 props) arg))
(define-builtin-markup-command (normalsize layout props arg)
(markup?)
font
()
- "Set font size to default."
+ "Set font size to default.
+
+@lilypond[verbatim,quote]
+\\markup \\teeny {
+ this is very small
+ \\hspace #1
+ \\normalsize {
+ revert to normal size
+ }
+ \\hspace #1
+ teeny again
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size 0 props) arg))
(define-builtin-markup-command (small layout props arg)
(markup?)
font
()
- "Set font size to -1."
+ "Set font size to -1.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\small
+ small
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size -1 props) arg))
(define-builtin-markup-command (tiny layout props arg)
(markup?)
font
()
- "Set font size to -2."
+ "Set font size to -2.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\tiny
+ tiny
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size -2 props) arg))
(define-builtin-markup-command (teeny layout props arg)
(markup?)
font
()
- "Set font size to -3."
+ "Set font size to -3.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\teeny
+ teeny
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-size -3 props) arg))
(define-builtin-markup-command (fontCaps layout props arg)
(markup?)
font
()
- "Turn @code{text}, which should be a string, to small caps.
-@example
-\\markup \\smallCaps \"Text between double quotes\"
-@end example
+ "Emit @var{arg} as small caps.
+
+Note: @code{\\smallCaps} does not support accented characters.
-Note: @code{\\smallCaps} does not support accented characters."
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\smallCaps {
+ Text in small caps
+ }
+}
+@end lilypond"
(define (char-list->markup chars lower)
(let ((final-string (string-upcase (reverse-list->string chars))))
(if lower
(markup?)
font
()
- "Emit @var{arg} as small caps.
+ "Copy of the @code{\\smallCaps} command.
@lilypond[verbatim,quote]
\\markup \\caps {
@q{pi@`{u}@tie{}@b{f}}, the normal words (like @q{pi@`{u}}) should be
done in a different font. The recommended font for this is bold and italic.
@lilypond[verbatim,quote]
-\\markup { \\dynamic sfzp }
+\\markup \\dynamic { sfzp }
@end lilypond"
(interpret-markup
layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg))
(markup?)
font
()
- "Use a text font instead of music symbol or music alphabet font."
+ "Use a text font instead of music symbol or music alphabet font.
+
+@lilypond[verbatim,quote]
+\\markup \\number {
+ 1, 2,
+ \\text {
+ three, four,
+ }
+ 5
+}
+@end lilypond"
;; ugh - latin1
(interpret-markup layout (prepend-alist-chain 'font-encoding 'latin1 props)
"Use italic @code{font-shape} for @var{arg}.
@lilypond[verbatim,quote]
-\\markup \\italic { scherzando e leggiero }
+\\markup \\italic {
+ scherzando e leggiero
+}
@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg))
(markup?)
font
()
- "Use @code{font-family} typewriter for @var{arg}."
+ "Use @code{font-family} typewriter for @var{arg}.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\hspace #2
+ \\typewriter
+ typewriter
+}
+@end lilypond"
(interpret-markup
layout (prepend-alist-chain 'font-family 'typewriter props) arg))
(markup?)
font
()
- "Set font shape to @code{upright}. This is the opposite of @code{italic}."
+ "Set font shape to @code{upright}. This is the opposite of @code{italic}.
+
+@lilypond[verbatim,quote]
+\\markup \\italic {
+ italic text
+ \\hspace #2
+ \\upright {
+ upright text
+ }
+ \\hspace #2
+ italic again
+}
+@end lilypond"
(interpret-markup
layout (prepend-alist-chain 'font-shape 'upright props) arg))
(markup?)
font
()
- "Switch to medium font series (in contrast to bold)."
+ "Switch to medium font series (in contrast to bold).
+
+@lilypond[verbatim,quote]
+\\markup \\bold {
+ some bold text
+ \\hspace #2
+ \\medium {
+ medium font series
+ }
+ \\hspace #2
+ bold again
+}
+@end lilypond"
(interpret-markup layout (prepend-alist-chain 'font-series 'medium props)
arg))
font
()
"Set all font related properties (except the size) to get the default
-normal text font, no matter what font was used earlier."
+normal text font, no matter what font was used earlier.
+
+@lilypond[verbatim,quote]
+\\markup \\huge \\bold \\sans \\caps {
+ Some text with font overrides
+ \\hspace #2
+ \\normal-text {
+ Default text, same font-size
+ }
+ \\hspace #2
+ More text
+}
+@end lilypond"
;; ugh - latin1
(interpret-markup layout
(cons '((font-family . roman) (font-shape . upright)
(string?)
other
()
- "Lookup a glyph by name."
+ "Lookup a glyph by name.
+
+@lilypond[verbatim,quote]
+\\markup \\override #'(font-encoding . fetaBraces) {
+ \\lookup #\"brace200\"
+ \\hspace #2
+ \\rotate #180
+ \\lookup #\"brace180\"
+}
+@end lilypond"
(ly:font-get-glyph (ly:paper-get-font layout props)
glyph-name))
(skipping letter@tie{}I), and continue with double letters.
@lilypond[verbatim,quote]
-\\markup { \\markletter #8 \\hspace #2 \\markletter #26 }
+\\markup {
+ \\markletter #8
+ \\hspace #2
+ \\markletter #26
+}
@end lilypond"
(ly:text-interface::interpret-markup layout props
(number->markletter-string number->mark-letter-vector num)))
and continue with double letters.
@lilypond[verbatim,quote]
-\\markup { \\markalphabet #8 \\hspace #2 \\markalphabet #26 }
+\\markup {
+ \\markalphabet #8
+ \\hspace #2
+ \\markalphabet #26
+}
@end lilypond"
(ly:text-interface::interpret-markup layout props
(number->markletter-string number->mark-alphabet-vector num)))
Make a fraction of two markups.
@lilypond[verbatim,quote]
-\\markup { π ≈ \\fraction 355 113 }
+\\markup {
+ π ≈
+ \\fraction 355 113
+}
@end lilypond"
(let* ((m1 (interpret-markup layout props arg1))
(m2 (interpret-markup layout props arg2))
"
@cindex setting superscript in standard font size
-Set @var{arg} in superscript with a normal font size."
+Set @var{arg} in superscript with a normal font size.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\normal-size-super {
+ superscript in standard size
+ }
+}
+@end lilypond"
(ly:stencil-translate-axis
(interpret-markup layout props arg)
(* 0.5 baseline-skip) Y))
@code{\\sub}:
@lilypond[verbatim,quote]
-\\markup { E = \\concat { mc \\super 2 } }
+\\markup {
+ E =
+ \\concat {
+ mc
+ \\super
+ 2
+ }
+}
@end lilypond"
(ly:stencil-translate-axis
(interpret-markup
"
@cindex subscript text
-Set @var{arg} in subscript."
+Set @var{arg} in subscript.
+
+@lilypond[verbatim,quote]
+\\markup \\concat {
+ H
+ \\sub 2
+ O
+}
+@end lilypond"
(ly:stencil-translate-axis
(interpret-markup
layout
"
@cindex setting subscript in standard font size
-Set @var{arg} in subscript, in a normal font size."
+Set @var{arg} in subscript, in a normal font size.
+
+@lilypond[verbatim,quote]
+\\markup {
+ default
+ \\normal-size-sub {
+ subscript in standard size
+ }
+}
+@end lilypond"
(ly:stencil-translate-axis
(interpret-markup layout props arg)
(* -0.5 baseline-skip)
"
@cindex placing horizontal brackets around text
-Draw horizontal brackets around @var{arg}."
+Draw horizontal brackets around @var{arg}.
+
+@lilypond[verbatim,quote]
+\\markup \\hbracket \\line {
+ one two three
+}
+@end lilypond"
(let ((th 0.1) ;; todo: take from GROB.
(m (interpret-markup layout props arg)))
(bracketify-stencil m X th (* 2.5 th) th)))
projects / lilypond.git / commitdiff