X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-markup-commands.scm;h=9b5c5c5c82ac75bfb74b7994ff06b40c7a2ee9cf;hb=7cf608d94950fc22c3ec60a72a2efba69b8d396d;hp=611e3eb08d36783821df171303cee0fe4a32f745;hpb=306a877dfa0fa36c53f647df9d8bfa8306dc3c50;p=lilypond.git diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index 611e3eb08d..9b5c5c5c82 100644 --- a/scm/define-markup-commands.scm +++ b/scm/define-markup-commands.scm @@ -2,7 +2,7 @@ ;;;; ;;;; source file of the GNU LilyPond music typesetter ;;;; -;;;; (c) 2000--2007 Han-Wen Nienhuys +;;;; (c) 2000--2009 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen @@ -30,33 +30,38 @@ " @cindex drawing lines within text -A simple line." +A simple line. +@lilypond[verbatim,quote] +\\markup { + \\draw-line #'(4 . 4) + \\override #'(thickness . 5) + \\draw-line #'(-3 . 0) +} +@end lilypond" (let ((th (* (ly:output-def-lookup layout 'line-thickness) thickness)) (x (car dest)) (y (cdr dest))) - (ly:make-stencil - `(draw-line - ,th - 0 0 - ,x ,y) - (cons (min x 0) (max x 0)) - (cons (min y 0) (max y 0))))) - -(define-builtin-markup-command (draw-circle layout props radius thickness fill) + (make-line-stencil th 0 0 x y))) + +(define-builtin-markup-command (draw-circle layout props radius thickness filled) (number? number? boolean?) graphic () " @cindex drawing circles within text -A circle of radius @var{radius}, thickness @var{thickness} and +A circle of radius @var{radius} and thickness @var{thickness}, optionally filled. @lilypond[verbatim,quote] -\\markup { \\draw-circle #2 #0.5 ##f \\hspace #2 \\draw-circle #2 #0 ##t } +\\markup { + \\draw-circle #2 #0.5 ##f + \\hspace #2 + \\draw-circle #2 #0 ##t +} @end lilypond" - (make-circle-stencil radius thickness fill)) + (make-circle-stencil radius thickness filled)) (define-builtin-markup-command (triangle layout props filled) (boolean?) @@ -70,7 +75,11 @@ optionally filled. A triangle, either filled or empty. @lilypond[verbatim,quote] -\\markup { \\triangle ##t \\hspace #2 \\triangle ##f } +\\markup { + \\triangle ##t + \\hspace #2 + \\triangle ##f +} @end lilypond" (let ((ex (* (magstep font-size) 0.8 baseline-skip))) (ly:make-stencil @@ -94,7 +103,15 @@ A triangle, either filled or empty. Draw a circle around @var{arg}. Use @code{thickness}, @code{circle-padding} and @code{font-size} properties to determine line -thickness and padding around the markup." +thickness and padding around the markup. + +@lilypond[verbatim,quote] +\\markup { + \\circle { + Hi + } +} +@end lilypond" (let ((th (* (ly:output-def-lookup layout 'line-thickness) thickness)) (pad (* (magstep font-size) circle-padding)) @@ -114,7 +131,9 @@ the PDF backend. @lilypond[verbatim,quote] \\markup { \\with-url #\"http://lilypond.org/web/\" { - LilyPond ... \\italic { music notation for everyone } + LilyPond ... \\italic { + music notation for everyone + } } } @end lilypond" @@ -133,7 +152,12 @@ the PDF backend. " @cindex drawing beams within text -Create a beam with the specified parameters." +Create a beam with the specified parameters. +@lilypond[verbatim,quote] +\\markup { + \\beam #5 #1 #2 +} +@end lilypond" (let* ((y (* slope width)) (yext (cons (min 0 y) (max 0 y))) (half (/ thickness 2))) @@ -152,23 +176,31 @@ Create a beam with the specified parameters." (define-builtin-markup-command (underline layout props arg) (markup?) - music + font ((thickness 1)) " @cindex underlining text Underline @var{arg}. Looks at @code{thickness} to determine line -thickness and y offset." +thickness and y-offset. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\override #'(thickness . 2) + \\underline { + underline + } +} +@end lilypond" (let* ((thick (* (ly:output-def-lookup layout 'line-thickness) thickness)) (markup (interpret-markup layout props arg)) (x1 (car (ly:stencil-extent markup X))) (x2 (cdr (ly:stencil-extent markup X))) (y (* thick -2)) - (line (ly:make-stencil - `(draw-line ,thick ,x1 ,y ,x2 ,y) - (cons (min x1 0) (max x2 0)) - (cons thick thick)))) + (line (make-line-stencil thick x1 y x2 y))) (ly:stencil-add markup line))) (define-builtin-markup-command (box layout props arg) @@ -182,7 +214,15 @@ thickness and y offset." Draw a box round @var{arg}. Looks at @code{thickness}, @code{box-padding} and @code{font-size} properties to determine line -thickness and padding around the markup." +thickness and padding around the markup. + +@lilypond[verbatim,quote] +\\markup { + \\override #'(box-padding . 0.5) + \\box + \\line { V. S. } +} +@end lilypond" (let* ((th (* (ly:output-def-lookup layout 'line-thickness) thickness)) (pad (* (magstep font-size) box-padding)) @@ -204,14 +244,15 @@ Draw a box with rounded corners of dimensions @var{xext} and @end verbatim creates a box extending horizontally from -0.3 to 1.8 and vertically from -0.3 up to 1.8, with corners formed from a -circle of diameter@tie{}0 (i.e. sharp corners). +circle of diameter@tie{}0 (i.e., sharp corners). @lilypond[verbatim,quote] \\markup { \\filled-box #'(0 . 4) #'(0 . 4) #0 \\filled-box #'(0 . 2) #'(-4 . 2) #0.4 \\filled-box #'(1 . 8) #'(0 . 7) #0.2 - \\with-color #white \\filled-box #'(-4.5 . -2.5) #'(3.5 . 5.5) #0.7 + \\with-color #white + \\filled-box #'(-4.5 . -2.5) #'(3.5 . 5.5) #0.7 } @end lilypond" (ly:round-filled-box @@ -224,15 +265,19 @@ circle of diameter@tie{}0 (i.e. sharp corners). (corner-radius 1) (font-size 0) (box-padding 0.5)) - "@cindex enclosing text in a bow with rounded corners + "@cindex enclosing text in a box with rounded corners @cindex drawing boxes with rounded corners around text Draw a box with rounded corners around @var{arg}. Looks at @code{thickness}, @code{box-padding} and @code{font-size} properties to determine line thickness and padding around the markup; the @code{corner-radius} property -makes possible to define another shape for the corners (default is 1). +makes it possible to define another shape for the corners (default is 1). -@lilypond[quote,verbatim,fragment,relative=2] -c^\\markup{ \\rounded-box Overtura } +@lilypond[quote,verbatim,relative=2] +c4^\\markup { + \\rounded-box { + Overtura + } +} c,8. c16 c4 r @end lilypond" (let ((th (* (ly:output-def-lookup layout 'line-thickness) @@ -249,7 +294,18 @@ c,8. c16 c4 r " @cindex rotating text -Rotate object with @var{ang} degrees around its center." +Rotate object with @var{ang} degrees around its center. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\rotate #45 + \\line { + rotated 45° + } +} +@end lilypond" (let* ((stil (interpret-markup layout props arg))) (ly:stencil-rotate stil ang 0 0))) @@ -260,10 +316,18 @@ Rotate object with @var{ang} degrees around its center." " @cindex adding a white background to text -Provide a white background for @var{arg}." +Provide a white background for @var{arg}. + +@lilypond[verbatim,quote] +\\markup { + \\combine + \\filled-box #'(-1 . 10) #'(-3 . 4) #1 + \\whiteout whiteout +} +@end lilypond" (stencil-whiteout (interpret-markup layout props arg))) -(define-builtin-markup-command (pad-markup layout props padding arg) +(define-builtin-markup-command (pad-markup layout props amount arg) (number? markup?) align () @@ -271,7 +335,21 @@ Provide a white background for @var{arg}." @cindex padding text @cindex putting space around text -Add space around a markup object." +Add space around a markup object. + +@lilypond[verbatim,quote] +\\markup { + \\box { + default + } + \\hspace #2 + \\box { + \\pad-markup #1 { + padded + } + } +} +@end lilypond" (let* ((stil (interpret-markup layout props arg)) (xext (ly:stencil-extent stil X)) @@ -279,8 +357,8 @@ Add space around a markup object." (ly:make-stencil (ly:stencil-expr stil) - (interval-widen xext padding) - (interval-widen yext padding)))) + (interval-widen xext amount) + (interval-widen yext amount)))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; space @@ -308,15 +386,17 @@ Create a box of the same height as the space in the current font." " @cindex creating horizontal spaces in text -This produces a invisible object taking horizontal space. For example, - -@example -\\markup @{ A \\hspace #2.0 B @} -@end example +Create an invisible object taking up horizontal space @var{amount}. -@noindent -puts extra space between A and@tie{}B, on top of the space that is -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)))) @@ -333,7 +413,13 @@ normally inserted before elements on a line." " @cindex importing stencils into text -Use a stencil as markup." +Use a stencil as markup. + +@lilypond[verbatim,quote] +\\markup { + \\stencil #(make-circle-stencil 2 0 #t) +} +@end lilypond" stil) (define bbox-regexp @@ -380,30 +466,8 @@ Inline an EPS image. The image is scaled along @var{axis} to () " @cindex inserting PostScript directly into text - This inserts @var{str} directly into the output as a PostScript -command string. Due to technicalities of the output backends, -different scales should be used for the @TeX{} and PostScript backend, -selected with @code{-f}. - -For the @TeX{} backend, the following string prints a rotated text - -@example -0 0 moveto /ecrm10 findfont -1.75 scalefont setfont 90 rotate (hello) show -@end example - -@noindent -The magical constant 1.75 scales from LilyPond units (staff spaces) to -@TeX{} dimensions. - -For the postscript backend, use the following - -@example -gsave /ecrm10 findfont - 10.0 output-scale div - scalefont setfont 90 rotate (hello) show grestore -@end example +command string. @lilypond[verbatim,quote] eyeglassesps = #\" @@ -431,7 +495,10 @@ eyeglasses = \\markup { \\postscript #eyeglassesps } -\\relative c'' { c2^\\eyeglasses a_\\eyeglasses } +\\relative c'' { + c2^\\eyeglasses + a2_\\eyeglasses +} @end lilypond" ;; FIXME (ly:make-stencil @@ -509,7 +576,13 @@ Inline an image of music. " @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) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -524,7 +597,18 @@ An empty markup with extents of a single point." @cindex simple text strings A simple text string; @code{\\markup @{ foo @}} is equivalent with -@code{\\markup @{ \\simple #\"foo\" @}}." +@code{\\markup @{ \\simple #\"foo\" @}}. + +Note: for creating standard text markup or defining new markup commands, +the use of @code{\\simple} is unnecessary. + +@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) @@ -534,7 +618,13 @@ A simple text string; @code{\\markup @{ foo @}} is equivalent with " @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 #\~)) @@ -583,7 +673,7 @@ Like simple-markup, but use tie characters for @q{~} tilde symbols." (/ (+ (car text-widths) (car (cdr text-widths))) 2)) (get-fill-space word-count line-width (cdr text-widths)))))) -(define-builtin-markup-command (fill-line layout props markups) +(define-builtin-markup-command (fill-line layout props args) (markup-list?) align ((text-direction RIGHT) @@ -591,9 +681,26 @@ Like simple-markup, but use tie characters for @q{~} tilde symbols." (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." - - (let* ((orig-stencils (interpret-markup-list layout props markups)) +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 args)) (stencils (map (lambda (stc) (if (ly:stencil-empty? stc) @@ -648,7 +755,15 @@ If there are no arguments, return an empty stencil." ((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 markups in @var{args}. + +@lilypond[verbatim,quote] +\\markup { + \\line { + one two three + } +} +@end lilypond" (let ((stencils (interpret-markup-list layout props args))) (if (= text-direction LEFT) (set! stencils (reverse stencils))) @@ -664,10 +779,20 @@ determines the space between each markup in @var{args}." @cindex concatenating text @cindex ligatures in text -Concatenate @var{args} in a horizontal line, without spaces inbetween. +Concatenate @var{args} in a horizontal line, without spaces in between. 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 { + \\concat { + one + two + three + } +} +@end lilypond" (define (concat-string-args arg-list) (fold-right (lambda (arg result-list) (let ((result (if (pair? result-list) @@ -763,9 +888,20 @@ equivalent to @code{\"fi\"}." " @cindex justifying text -Like wordwrap, but with lines stretched to justify the margins. +Like @code{\\wordwrap}, but with lines stretched to justify the margins. Use @code{\\override #'(line-width . @var{X})} to set the line width; -@var{X}@tie{}is the number of staff spaces." +@var{X}@tie{}is the number of staff spaces. + +@lilypond[verbatim,quote] +\\markup { + \\justify { + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed + do eiusmod tempor incididunt ut labore et dolore magna aliqua. + Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat. + } +} +@end lilypond" (stack-lines DOWN 0.0 baseline-skip (wordwrap-internal-markup-list layout props #t args))) @@ -775,7 +911,18 @@ Use @code{\\override #'(line-width . @var{X})} to set the line width; ((baseline-skip) wordwrap-internal-markup-list) "Simple wordwrap. Use @code{\\override #'(line-width . @var{X})} to set -the line width, where @var{X} is the number of staff spaces." +the line width, where @var{X} is the number of staff spaces. + +@lilypond[verbatim,quote] +\\markup { + \\wordwrap { + Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed + do eiusmod tempor incididunt ut labore et dolore magna aliqua. + Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat. + } +} +@end lilypond" (stack-lines DOWN 0.0 baseline-skip (wordwrap-internal-markup-list layout props #f args))) @@ -811,7 +958,24 @@ the line width, where @var{X} is the number of staff spaces." align ((baseline-skip) wordwrap-string-internal-markup-list) - "Wordwrap a string. Paragraphs may be separated with double newlines." + "Wordwrap a string. Paragraphs may be separated with double newlines. + +@lilypond[verbatim,quote] +\\markup { + \\override #'(line-width . 40) + \\wordwrap-string #\"Lorem ipsum dolor sit amet, consectetur + adipisicing elit, sed do eiusmod tempor incididunt ut labore + et dolore magna aliqua. + + + Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat. + + + Excepteur sint occaecat cupidatat non proident, sunt in culpa + qui officia deserunt mollit anim id est laborum\" +} +@end lilypond" (stack-lines DOWN 0.0 baseline-skip (wordwrap-string-internal-markup-list layout props #f arg))) @@ -820,7 +984,24 @@ the line width, where @var{X} is the number of staff spaces." align ((baseline-skip) wordwrap-string-internal-markup-list) - "Justify a string. Paragraphs may be separated with double newlines" + "Justify a string. Paragraphs may be separated with double newlines + +@lilypond[verbatim,quote] +\\markup { + \\override #'(line-width . 40) + \\justify-string #\"Lorem ipsum dolor sit amet, consectetur + adipisicing elit, sed do eiusmod tempor incididunt ut labore + et dolore magna aliqua. + + + Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat. + + + Excepteur sint occaecat cupidatat non proident, sunt in culpa + qui officia deserunt mollit anim id est laborum\" +} +@end lilypond" (stack-lines DOWN 0.0 baseline-skip (wordwrap-string-internal-markup-list layout props #t arg))) @@ -828,7 +1009,31 @@ the line width, where @var{X} is the number of staff spaces." (symbol?) align () - "Wordwrap the data which has been assigned to @var{symbol}." + "Wordwrap the data which has been assigned to @var{symbol}. + +@lilypond[verbatim,quote] +\\header { + title = \"My title\" + description = \"Lorem ipsum dolor sit amet, consectetur adipisicing + elit, sed do eiusmod tempor incididunt ut labore et dolore magna + aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat.\" +} + +\\paper { + bookTitleMarkup = \\markup { + \\column { + \\fill-line { \\fromproperty #'header:title } + \\null + \\wordwrap-field #'header:descr + } + } +} + +\\markup { + \\null +} +@end lilypond" (let* ((m (chain-assoc-get symbol props))) (if (string? m) (wordwrap-string-markup layout props m) @@ -838,13 +1043,37 @@ the line width, where @var{X} is the number of staff spaces." (symbol?) align () - "Justify the data which has been assigned to @var{symbol}." + "Justify the data which has been assigned to @var{symbol}. + +@lilypond[verbatim,quote] +\\header { + title = \"My title\" + description = \"Lorem ipsum dolor sit amet, consectetur adipisicing + elit, sed do eiusmod tempor incididunt ut labore et dolore magna + aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco + laboris nisi ut aliquip ex ea commodo consequat.\" +} + +\\paper { + bookTitleMarkup = \\markup { + \\column { + \\fill-line { \\fromproperty #'header:title } + \\null + \\justify-field #'header:description + } + } +} + +\\markup { + \\null +} +@end lilypond" (let* ((m (chain-assoc-get symbol props))) (if (string? m) (justify-string-markup layout props m) empty-stencil))) -(define-builtin-markup-command (combine layout props m1 m2) +(define-builtin-markup-command (combine layout props arg1 arg2) (markup? markup?) align () @@ -852,15 +1081,25 @@ the line width, where @var{X} is the number of staff spaces." @cindex merging text Print two markups on top of each other. + +Note: @code{\\combine} cannot take a list of markups enclosed in +curly braces as an argument; the follow example will not compile: + +@example +\\combine @{ a list @} +@end example + @lilypond[verbatim,quote] \\markup { \\fontsize #5 \\override #'(thickness . 2) - \\combine \\draw-line #'(0 . 4) \\arrow-head #Y #DOWN ##f + \\combine + \\draw-line #'(0 . 4) + \\arrow-head #Y #DOWN ##f } @end lilypond" - (let* ((s1 (interpret-markup layout props m1)) - (s2 (interpret-markup layout props m2))) + (let* ((s1 (interpret-markup layout props arg1)) + (s2 (interpret-markup layout props arg2))) (ly:stencil-add s1 s2))) ;; @@ -874,7 +1113,18 @@ Print two markups on top of each other. @cindex stacking text in a column Stack the markups in @var{args} vertically. The property -@code{baseline-skip} determines the space between each markup in @var{args}." +@code{baseline-skip} determines the space between markups +in @var{args}. + +@lilypond[verbatim,quote] +\\markup { + \\column { + one + two + three + } +} +@end lilypond" (let ((arg-stencils (interpret-markup-list layout props args))) (stack-lines -1 0.0 baseline-skip (remove ly:stencil-empty? arg-stencils)))) @@ -887,24 +1137,98 @@ Stack the markups in @var{args} vertically. The property " @cindex changing direction of text columns -Make a column of args, going up or down, depending on the setting -of the @code{#'direction} layout property." +Make a column of @var{args}, going up or down, depending on the +setting of the @code{direction} layout property. + +@lilypond[verbatim,quote] +\\markup { + \\override #`(direction . ,UP) { + \\dir-column { + going up + } + } + \\hspace #1 + \\dir-column { + going down + } + \\hspace #1 + \\override #'(direction . 1) { + \\dir-column { + going up + } + } +} +@end lilypond" (stack-lines (if (number? direction) direction -1) 0.0 baseline-skip (interpret-markup-list layout props args))) -(define-builtin-markup-command (center-align layout props args) +(define (general-column align-dir baseline mols) + "Stack @var{mols} vertically, aligned to @var{align-dir} horizontally." + + (let* ((aligned-mols (map (lambda (x) (ly:stencil-aligned-to x X align-dir)) mols))) + (stack-lines -1 0.0 baseline aligned-mols))) + +(define-builtin-markup-command (center-column layout props args) (markup-list?) align ((baseline-skip)) " @cindex centering a column of text -Put @code{args} in a centered column." - (let* ((mols (interpret-markup-list layout props args)) - (cmols (map (lambda (x) (ly:stencil-aligned-to x X CENTER)) mols))) - (stack-lines -1 0.0 baseline-skip cmols))) +Put @code{args} in a centered column. + +@lilypond[verbatim,quote] +\\markup { + \\center-column { + one + two + three + } +} +@end lilypond" + (general-column CENTER baseline-skip (interpret-markup-list layout props args))) + +(define-builtin-markup-command (left-column layout props args) + (markup-list?) + align + ((baseline-skip)) + " +@cindex text columns, left-aligned + +Put @code{args} in a left-aligned column. + +@lilypond[verbatim,quote] +\\markup { + \\left-column { + one + two + three + } +} +@end lilypond" + (general-column LEFT baseline-skip (interpret-markup-list layout props args))) + +(define-builtin-markup-command (right-column layout props args) + (markup-list?) + align + ((baseline-skip)) + " +@cindex text columns, right-aligned + +Put @code{args} in a right-aligned column. + +@lilypond[verbatim,quote] +\\markup { + \\right-column { + one + two + three + } +} +@end lilypond" + (general-column RIGHT baseline-skip (interpret-markup-list layout props args))) (define-builtin-markup-command (vcenter layout props arg) (markup?) @@ -913,18 +1237,38 @@ Put @code{args} in a centered column." " @cindex vertically centering text -Align @code{arg} to its Y@tie{}center." +Align @code{arg} to its Y@tie{}center. + +@lilypond[verbatim,quote] +\\markup { + one + \\vcenter + two + three +} +@end lilypond" (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol Y CENTER))) -(define-builtin-markup-command (hcenter layout props arg) +(define-builtin-markup-command (center-align layout props arg) (markup?) align () " @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 { + one + \\center-align + two + three + } +} +@end lilypond" (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol X CENTER))) @@ -935,7 +1279,18 @@ Align @code{arg} to its X@tie{}center." " @cindex right aligning text -Align @var{arg} on its right edge." +Align @var{arg} on its right edge. + +@lilypond[verbatim,quote] +\\markup { + \\column { + one + \\right-align + two + three + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X RIGHT))) @@ -946,7 +1301,18 @@ Align @var{arg} on its right edge." " @cindex left aligning text -Align @var{arg} on its left edge." +Align @var{arg} on its left edge. + +@lilypond[verbatim,quote] +\\markup { + \\column { + one + \\left-align + two + three + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X LEFT))) @@ -957,20 +1323,76 @@ Align @var{arg} on its left edge." " @cindex controlling general text alignment -Align @var{arg} in @var{axis} direction to the @var{dir} side." - (let* ((m (interpret-markup layout props arg))) - (ly:stencil-aligned-to m axis dir))) +Align @var{arg} in @var{axis} direction to the @var{dir} side. -(define-builtin-markup-command (halign layout props dir arg) - (number? markup?) - align - () +@lilypond[verbatim,quote] +\\markup { + \\column { + one + \\general-align #X #LEFT + two + three + \\null + one + \\general-align #X #CENTER + two + three + \\null + \\line { + one + \\general-align #Y #UP + two + three + } + \\null + \\line { + one + \\general-align #Y #3.2 + two + three + } + } +} +@end lilypond" + (let* ((m (interpret-markup layout props arg))) + (ly:stencil-aligned-to m axis dir))) + +(define-builtin-markup-command (halign layout props dir arg) + (number? markup?) + align + () " @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 { + one + \\halign #LEFT + two + three + \\null + one + \\halign #CENTER + two + three + \\null + one + \\halign #RIGHT + two + three + \\null + one + \\halign #-5 + two + three + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X dir))) @@ -989,7 +1411,21 @@ Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}." (number? markup?) align () - "Add padding @var{amount} all around @var{arg}." + "Add padding @var{amount} all around @var{arg}. + +@lilypond[verbatim,quote] +\\markup { + \\box { + default + } + \\hspace #2 + \\box { + \\pad-around #0.5 { + padded + } + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) (y (ly:stencil-extent m Y))) @@ -1004,7 +1440,21 @@ Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}." " @cindex padding text horizontally -Add padding @var{amount} around @var{arg} in the X@tie{}direction." +Add padding @var{amount} around @var{arg} in the X@tie{}direction. + +@lilypond[verbatim,quote] +\\markup { + \\box { + default + } + \\hspace #4 + \\box { + \\pad-x #2 { + padded + } + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) (y (ly:stencil-extent m Y))) @@ -1012,8 +1462,8 @@ Add padding @var{amount} around @var{arg} in the X@tie{}direction." (interval-widen x amount) y))) -(define-builtin-markup-command (put-adjacent layout props arg1 axis dir arg2) - (markup? integer? ly:dir? markup?) +(define-builtin-markup-command (put-adjacent layout props axis dir arg1 arg2) + (integer? ly:dir? markup? markup?) align () "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}." @@ -1025,7 +1475,15 @@ Add padding @var{amount} around @var{arg} in the X@tie{}direction." (markup?) other () - "Make the argument transparent." + "Make @var{arg} transparent. + +@lilypond[verbatim,quote] +\\markup { + \\transparent { + invisible text + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) (y (ly:stencil-extent m Y))) @@ -1035,7 +1493,21 @@ Add padding @var{amount} around @var{arg} in the X@tie{}direction." (number-pair? number-pair? markup?) align () - "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space." + "Make @var{arg} take at least @var{x-ext}, @var{y-ext} space. + +@lilypond[verbatim,quote] +\\markup { + \\box { + default + } + \\hspace #4 + \\box { + \\pad-to-box #'(0 . 10) #'(0 . 3) { + padded + } + } +} +@end lilypond" (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) (y (ly:stencil-extent m Y))) @@ -1048,12 +1520,32 @@ Add padding @var{amount} around @var{arg} in the X@tie{}direction." align () "Center @var{arg} horizontally within a box of extending -@var{length}/2 to the left and right." +@var{length}/2 to the left and right. + +@lilypond[quote,verbatim] +\\new StaffGroup << + \\new Staff { + \\set Staff.instrumentName = \\markup { + \\hcenter-in #12 + Oboe + } + c''1 + } + \\new Staff { + \\set Staff.instrumentName = \\markup { + \\hcenter-in #12 + Bassoon + } + \\clef tenor + c'1 + } +>> +@end lilypond" (interpret-markup layout props (make-pad-to-box-markup (cons (/ length -2) (/ length 2)) '(0 . 0) - (make-hcenter-markup arg)))) + (make-center-align-markup arg)))) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; property @@ -1065,7 +1557,21 @@ Add padding @var{amount} around @var{arg} in the X@tie{}direction." () "Read the @var{symbol} from property settings, and produce a stencil from the markup contained within. If @var{symbol} is not defined, it -returns an empty markup." +returns an empty markup. + +@lilypond[verbatim,quote] +\\header { + myTitle = \"myTitle\" + title = \\markup { + from + \\italic + \\fromproperty #'header:myTitle + } +} +\\markup { + \\null +} +@end lilypond" (let ((m (chain-assoc-get symbol props))) (if (markup? m) (interpret-markup layout props m) @@ -1090,13 +1596,28 @@ returns an empty markup." " @cindex overriding properties within text markup -Add the first argument in to the property list. Properties may be -any sort of property supported by @rinternals{font-interface} and -@rinternals{text-interface}, for example +Add the argument @var{new-prop} to the property list. Properties +may be any property supported by @rinternals{font-interface}, +@rinternals{text-interface} and +@rinternals{instrument-specific-markup-interface}. -@example -\\override #'(font-family . married) \"bla\" -@end example" +@lilypond[verbatim,quote] +\\markup { + \\line { + \\column { + default + baseline-skip + } + \\hspace #2 + \\override #'(baseline-skip . 4) { + \\column { + increased + baseline-skip + } + } + } +} +@end lilypond" (interpret-markup layout (cons (list new-prop) props) arg)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -1107,10 +1628,12 @@ any sort of property supported by @rinternals{font-interface} and (string?) other () - "Read the contents of a file, and include it verbatim. + "Read the contents of file @var{name}, and include it verbatim. @lilypond[verbatim,quote] -\\markup \\verbatim-file #\"simple.ly\" +\\markup { + \\verbatim-file #\"simple.ly\" +} @end lilypond" (interpret-markup layout props (if (ly:get-option 'safe) @@ -1124,46 +1647,108 @@ any sort of property supported by @rinternals{font-interface} and ;; fonts. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-builtin-markup-command (bigger layout props arg) - (markup?) - font - () - "Increase the font size relative to current setting." - (interpret-markup layout props - `(,fontsize-markup 1 ,arg))) (define-builtin-markup-command (smaller layout props arg) (markup?) font () - "Decrease the font size relative to current setting." + "Decrease the font size relative to the current setting. + +@lilypond[verbatim,quote] +\\markup { + \\fontsize #3.5 { + some large text + \\hspace #2 + \\smaller { + a bit smaller + } + \\hspace #2 + more large text + } +} +@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) + () + "Increase the font size relative to the current setting. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\larger + larger +} +@end lilypond" + (interpret-markup layout props + `(,fontsize-markup 1 ,arg))) (define-builtin-markup-command (finger layout props arg) (markup?) font () - "Set the argument as small numbers. + "Set @var{arg} 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) arg)) +(define-builtin-markup-command (abs-fontsize layout props size arg) + (number? markup?) + font + () + "Use @var{size} as the absolute font size to display @var{arg}. +Adjusts @code{baseline-skip} and @code{word-space} accordingly. + +@lilypond[verbatim,quote] +\\markup { + default text font size + \\hspace #2 + \\abs-fontsize #16 { text font size 16 } + \\hspace #2 + \\abs-fontsize #12 { text font size 12 } +} +@end lilypond" + (let* ((ref-size (ly:output-def-lookup layout 'text-font-size 12)) + (text-props (list (ly:output-def-lookup layout 'text-font-defaults))) + (ref-word-space (chain-assoc-get 'word-space text-props 0.6)) + (ref-baseline (chain-assoc-get 'baseline-skip text-props 3)) + (magnification (/ size ref-size))) + (interpret-markup layout + (cons `((baseline-skip . ,(* magnification ref-baseline)) + (word-space . ,(* magnification ref-word-space)) + (font-size . ,(magnification->font-size magnification))) + props) + arg))) + (define-builtin-markup-command (fontsize layout props increment arg) (number? markup?) font ((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. Adjusts @code{baseline-skip} +accordingly. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\fontsize #-1.5 + smaller +} +@end lilypond" (let ((entries (list (cons 'baseline-skip (* baseline-skip (magstep increment))) (cons 'word-space (* word-space (magstep increment))) @@ -1185,7 +1770,17 @@ A \\magnify #1.1 @{ A @} A @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) @@ -1195,14 +1790,33 @@ Use @code{\\fontsize} otherwise." (markup?) font () - "Switch to bold font-series." + "Switch to bold font-series. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\bold + bold +} +@end lilypond" (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg)) (define-builtin-markup-command (sans layout props arg) (markup?) font () - "Switch to the sans serif family." + "Switch to the sans serif font 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) @@ -1210,11 +1824,15 @@ Use @code{\\fontsize} otherwise." font () "Set font family to @code{number}, which yields the font used for -time signatures and fingerings. This font only contains numbers and -some punctuation. It doesn't have any letters. +time signatures and fingerings. This font contains numbers and +some punctuation; it has no 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)) @@ -1222,69 +1840,152 @@ some punctuation. It doesn't have any letters. (markup?) font () - "Set font family to @code{roman}." + "Set font family to @code{roman}. + +@lilypond[verbatim,quote] +\\markup { + \\sans \\bold { + sans serif, bold + \\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 #2 + \\normalsize { + normal size + } + \\hspace #2 + 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 () - "Set @code{font-shape} to @code{caps}." + "Set @code{font-shape} to @code{caps} + +Note: @code{\\fontCaps} requires the installation and selection of +fonts which support the @code{caps} font shape." (interpret-markup layout (prepend-alist-chain 'font-shape 'caps props) arg)) ;; Poor man's caps -(define-builtin-markup-command (smallCaps layout props text) +(define-builtin-markup-command (smallCaps 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 @@ -1312,15 +2013,25 @@ Note: @code{\\smallCaps} does not support accented characters." currents current-is-lower) prev-result))))))) (interpret-markup layout props - (if (string? text) - (make-small-caps (string->list text) (list) #f (list)) - text))) + (if (string? arg) + (make-small-caps (string->list arg) (list) #f (list)) + arg))) (define-builtin-markup-command (caps layout props arg) (markup?) font () - "Emit @var{arg} as small caps." + "Copy of the @code{\\smallCaps} command. + +@lilypond[verbatim,quote] +\\markup { + default + \\hspace #2 + \\caps { + Text in small caps + } +} +@end lilypond" (interpret-markup layout props (make-smallCaps-markup arg))) (define-builtin-markup-command (dynamic layout props arg) @@ -1332,7 +2043,11 @@ Note: @code{\\smallCaps} does not support accented characters." @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)) @@ -1341,7 +2056,19 @@ done in a different font. The recommended font for this is bold and italic. (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) @@ -1354,7 +2081,12 @@ done in a different font. The recommended font for this is bold and italic. "Use italic @code{font-shape} for @var{arg}. @lilypond[verbatim,quote] -\\markup \\italic { scherzando e leggiero } +\\markup { + default + \\hspace #2 + \\italic + italic +} @end lilypond" (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg)) @@ -1362,7 +2094,16 @@ done in a different font. The recommended font for this is bold and italic. (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)) @@ -1370,7 +2111,22 @@ done in a different font. The recommended font for this is bold and italic. (markup?) font () - "Set font shape to @code{upright}. This is the opposite of @code{italic}." + "Set @code{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)) @@ -1378,7 +2134,21 @@ done in a different font. The recommended font for this is bold and italic. (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)) @@ -1387,7 +2157,21 @@ done in a different font. The recommended font for this is bold and italic. 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 as before + } +} +@end lilypond" ;; ugh - latin1 (interpret-markup layout (cons '((font-family . roman) (font-shape . upright) @@ -1406,7 +2190,9 @@ normal text font, no matter what font was used earlier." "Draw a double sharp symbol. @lilypond[verbatim,quote] -\\markup { \\doublesharp } +\\markup { + \\doublesharp +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1 standard-alteration-glyph-name-alist "")))) @@ -1417,7 +2203,9 @@ normal text font, no matter what font was used earlier." "Draw a 3/2 sharp symbol. @lilypond[verbatim,quote] -\\markup { \\sesquisharp } +\\markup { + \\sesquisharp +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 3/4 standard-alteration-glyph-name-alist "")))) @@ -1428,7 +2216,9 @@ normal text font, no matter what font was used earlier." "Draw a sharp symbol. @lilypond[verbatim,quote] -\\markup { \\sharp } +\\markup { + \\sharp +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1/2 standard-alteration-glyph-name-alist "")))) @@ -1436,10 +2226,12 @@ normal text font, no matter what font was used earlier." () music () - "Draw a semi sharp symbol. + "Draw a semisharp symbol. @lilypond[verbatim,quote] -\\markup { \\semisharp } +\\markup { + \\semisharp +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 1/4 standard-alteration-glyph-name-alist "")))) @@ -1450,7 +2242,9 @@ normal text font, no matter what font was used earlier." "Draw a natural symbol. @lilypond[verbatim,quote] -\\markup { \\natural } +\\markup { + \\natural +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get 0 standard-alteration-glyph-name-alist "")))) @@ -1461,7 +2255,9 @@ normal text font, no matter what font was used earlier." "Draw a semiflat symbol. @lilypond[verbatim,quote] -\\markup { \\semiflat } +\\markup { + \\semiflat +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1/4 standard-alteration-glyph-name-alist "")))) @@ -1472,7 +2268,9 @@ normal text font, no matter what font was used earlier." "Draw a flat symbol. @lilypond[verbatim,quote] -\\markup { \\flat } +\\markup { + \\flat +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1/2 standard-alteration-glyph-name-alist "")))) @@ -1483,7 +2281,9 @@ normal text font, no matter what font was used earlier." "Draw a 3/2 flat symbol. @lilypond[verbatim,quote] -\\markup { \\sesquiflat } +\\markup { + \\sesquiflat +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -3/4 standard-alteration-glyph-name-alist "")))) @@ -1494,7 +2294,9 @@ normal text font, no matter what font was used earlier." "Draw a double flat symbol. @lilypond[verbatim,quote] -\\markup { \\doubleflat } +\\markup { + \\doubleflat +} @end lilypond" (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist "")))) @@ -1505,7 +2307,20 @@ normal text font, no matter what font was used earlier." " @cindex coloring text -Draw @var{arg} in color specified by @var{color}." +Draw @var{arg} in color specified by @var{color}. + +@lilypond[verbatim,quote] +\\markup { + \\with-color #red + red + \\hspace #2 + \\with-color #green + green + \\hspace #2 + \\with-color #blue + blue +} +@end lilypond" (let ((stil (interpret-markup layout props arg))) (ly:make-stencil (list 'color color (ly:stencil-expr stil)) (ly:stencil-extent stil X) @@ -1515,7 +2330,7 @@ Draw @var{arg} in color specified by @var{color}." ;; glyphs ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-builtin-markup-command (arrow-head layout props axis direction filled) +(define-builtin-markup-command (arrow-head layout props axis dir filled) (integer? ly:dir? boolean?) graphic () @@ -1523,13 +2338,14 @@ Draw @var{arg} in color specified by @var{color}." Use the filled head if @var{filled} is specified. @lilypond[verbatim,quote] \\markup { - \\fontsize #5 - \\general-align #Y #DOWN { - \\arrow-head #Y #UP ##t - \\arrow-head #Y #DOWN ##f - \\hspace #2 - \\arrow-head #X #RIGHT ##f - \\arrow-head #X #LEFT ##f + \\fontsize #5 { + \\general-align #Y #DOWN { + \\arrow-head #Y #UP ##t + \\arrow-head #Y #DOWN ##f + \\hspace #2 + \\arrow-head #X #RIGHT ##f + \\arrow-head #X #LEFT ##f + } } } @end lilypond" @@ -1539,7 +2355,7 @@ Use the filled head if @var{filled} is specified. "close" "open") axis - direction))) + dir))) (ly:font-get-glyph (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)) @@ -1561,8 +2377,10 @@ the possible glyphs. \\musicglyph #\"clefs.G_change\" } @end lilypond" - - (let* ((font (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) + (let* ((font (ly:paper-get-font layout + (cons '((font-encoding . fetaMusic) + (font-name . #f)) + props))) (glyph (ly:font-get-glyph font glyph-name))) (if (null? (ly:stencil-expr glyph)) @@ -1570,11 +2388,23 @@ the possible glyphs. glyph)) + (define-builtin-markup-command (lookup layout props glyph-name) (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)) @@ -1582,8 +2412,14 @@ the possible glyphs. (integer?) other () - "Produce a single character. For example, @code{\\char #65} produces the -letter @q{A}." + "Produce a single character. Characters encoded in hexadecimal +format require the prefix @code{#x}. + +@lilypond[verbatim,quote] +\\markup { + \\char #65 \\char ##x00a9 +} +@end lilypond" (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num))) (define number->mark-letter-vector (make-vector 25 #\A)) @@ -1616,7 +2452,11 @@ letter @q{A}." (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))) @@ -1629,11 +2469,76 @@ letter @q{A}." 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))) +(define-public (horizontal-slash-interval num forward number-interval mag) + (if forward + (cond ;((= num 6) (interval-widen number-interval (* mag 0.5))) + ;((= num 5) (interval-widen number-interval (* mag 0.5))) + (else (interval-widen number-interval (* mag 0.25)))) + (cond ((= num 6) (interval-widen number-interval (* mag 0.5))) + ;((= num 5) (interval-widen number-interval (* mag 0.5))) + (else (interval-widen number-interval (* mag 0.25)))) + )) + +(define-public (adjust-slash-stencil num forward stencil mag) + (if forward + (cond ((= num 2) + (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2)))) + ((= num 3) + (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.2)))) + ;((= num 5) + ;(ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.07)))) + ;((= num 7) + ; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15)))) + (else stencil)) + (cond ((= num 6) + (ly:stencil-translate stencil (cons (* mag -0.00) (* mag 0.15)))) + ;((= num 8) + ; (ly:stencil-translate stencil (cons (* mag -0.00) (* mag -0.15)))) + (else stencil)) + ) +) + +(define (slashed-digit-internal layout props num forward font-size thickness) + (let* ((mag (magstep font-size)) + (thickness (* mag + (ly:output-def-lookup layout 'line-thickness) + thickness)) + ; backward slashes might use slope and point in the other direction! + (dy (* mag (if forward 0.4 -0.4))) + (number-stencil (interpret-markup layout + (prepend-alist-chain 'font-encoding 'fetaNumber props) + (number->string num))) + (num-x (horizontal-slash-interval num forward (ly:stencil-extent number-stencil X) mag)) + (center (interval-center (ly:stencil-extent number-stencil Y))) + ; Use the real extents of the slash, not the whole number, because we + ; might translate the slash later on! + (num-y (interval-widen (cons center center) (abs dy))) + (is-sane (and (interval-sane? num-x) (interval-sane? num-y))) + (slash-stencil (if is-sane + (make-line-stencil thickness + (car num-x) (- (interval-center num-y) dy) + (cdr num-x) (+ (interval-center num-y) dy)) + #f))) + (if (ly:stencil? slash-stencil) + (begin + ; for some numbers we need to shift the slash/backslash up or down to make + ; the slashed digit look better + (set! slash-stencil (adjust-slash-stencil num forward slash-stencil mag)) + (set! number-stencil + (ly:stencil-add number-stencil slash-stencil))) + (ly:warning "Unable to create slashed digit ~a" num)) + number-stencil)) + + (define-builtin-markup-command (slashed-digit layout props num) (integer?) other @@ -1652,42 +2557,28 @@ figured bass notation. \\slashed-digit #7 } @end lilypond" - (let* ((mag (magstep font-size)) - (thickness (* mag - (ly:output-def-lookup layout 'line-thickness) - thickness)) - (dy (* mag 0.15)) - (number-stencil (interpret-markup layout - (prepend-alist-chain 'font-encoding 'fetaNumber props) - (number->string num))) - (num-x (interval-widen (ly:stencil-extent number-stencil X) - (* mag 0.2))) - (num-y (ly:stencil-extent number-stencil Y)) - (is-sane (and (interval-sane? num-x) (interval-sane? num-y))) - (slash-stencil (if is-sane - (ly:make-stencil - `(draw-line ,thickness - ,(car num-x) ,(- (interval-center num-y) dy) - ,(cdr num-x) ,(+ (interval-center num-y) dy)) - num-x num-y) - #f))) - (set! slash-stencil - (cond ((not (ly:stencil? slash-stencil)) #f) - ((= num 5) - (ly:stencil-translate slash-stencil - ;;(cons (* mag -0.05) (* mag 0.42)) - (cons (* mag -0.00) (* mag -0.07)))) - ((= num 7) - (ly:stencil-translate slash-stencil - ;;(cons (* mag -0.05) (* mag 0.42)) - (cons (* mag -0.00) (* mag -0.15)))) - (else slash-stencil))) - (if slash-stencil - (set! number-stencil - (ly:stencil-add number-stencil slash-stencil)) - (ly:warning "invalid number for slashed digit ~a" num)) - number-stencil)) - + (slashed-digit-internal layout props num #t font-size thickness)) + +(define-builtin-markup-command (backslashed-digit layout props num) + (integer?) + other + ((font-size 0) + (thickness 1.6)) + " +@cindex backslashed digits + +A feta number, with backslash. This is for use in the context of +figured bass notation. +@lilypond[verbatim,quote] +\\markup { + \\backslashed-digit #5 + \\hspace #2 + \\override #'(thickness . 3) + \\backslashed-digit #7 +} +@end lilypond" + (slashed-digit-internal layout props num #f font-size thickness)) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; the note command. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -1703,8 +2594,15 @@ figured bass notation. @cindex notes within text by log and dot-count Construct a note symbol, with stem. By using fractional values for -@var{dir}, you can obtain longer or shorter stems." +@var{dir}, longer or shorter stems can be obtained. +@lilypond[verbatim,quote] +\\markup { + \\note-by-number #3 #0 #DOWN + \\hspace #2 + \\note-by-number #1 #2 #0.8 +} +@end lilypond" (define (get-glyph-name-candidates dir log style) (map (lambda (dir-name) (format "noteheads.~a~a~a" dir-name (min log 2) @@ -1807,10 +2705,20 @@ Construct a note symbol, with stem. By using fractional values for This produces a note with a stem pointing in @var{dir} direction, with the @var{duration} for the note head type and augmentation dots. For example, @code{\\note #\"4.\" #-0.75} creates a dotted quarter note, with -a shortened down stem." +a shortened down stem. + +@lilypond[verbatim,quote] +\\markup { + \\override #'(style . cross) { + \\note #\"4..\" #UP + } + \\hspace #2 + \\note #\"breve\" #0 +} +@end lilypond" (let ((parsed (parse-simple-duration duration))) (note-by-number-markup layout props (car parsed) (cadr parsed) dir))) - + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;; translating. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -1823,20 +2731,39 @@ a shortened down stem." @cindex lowering text Lower @var{arg} by the distance @var{amount}. -A negative @var{amount} indicates raising; see also @code{\\raise}." +A negative @var{amount} indicates raising; see also @code{\\raise}. + +@lilypond[verbatim,quote] +\\markup { + one + \\lower #3 + two + three +} +@end lilypond" (ly:stencil-translate-axis (interpret-markup layout props arg) (- amount) Y)) (define-builtin-markup-command (translate-scaled layout props offset arg) (number-pair? markup?) - other + align ((font-size 0)) " @cindex translating text @cindex scaling text Translate @var{arg} by @var{offset}, scaling the offset by the -@code{font-size}." +@code{font-size}. + +@lilypond[verbatim,quote] +\\markup { + \\fontsize #5 { + * \\translate #'(2 . 3) translate + \\hspace #2 + * \\translate-scaled #'(2 . 3) translate-scaled + } +} +@end lilypond" (let* ((factor (magstep font-size)) (scaled (cons (* factor (car offset)) (* factor (cdr offset))))) @@ -1864,7 +2791,13 @@ positions it next to the staff cancels any shift made with and/or @code{extra-offset} properties. @lilypond[verbatim,quote] -\\markup { C \\small \\raise #1.0 \\bold 9/7+ } +\\markup { + C + \\small + \\bold + \\raise #1.0 + 9/7+ +} @end lilypond" (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y)) @@ -1877,7 +2810,10 @@ and/or @code{extra-offset} properties. 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)) @@ -1908,7 +2844,16 @@ Make a fraction of two markups. " @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)) @@ -1921,11 +2866,17 @@ Set @var{arg} in superscript with a normal font size." " @cindex superscript text -Raising and lowering texts can be done with @code{\\super} and -@code{\\sub}: +Set @var{arg} in superscript. @lilypond[verbatim,quote] -\\markup { E = \\concat { mc \\super 2 } } +\\markup { + E = + \\concat { + mc + \\super + 2 + } +} @end lilypond" (ly:stencil-translate-axis (interpret-markup @@ -1942,17 +2893,17 @@ Raising and lowering texts can be done with @code{\\super} and " @cindex translating text -This translates an object. Its first argument is a cons of numbers. +Translate @var{arg} relative to its surroundings. @var{offset} +is a pair of numbers representing the displacement in the X and Y axis. -@example -A \\translate #(cons 2 -3) @{ B C @} D -@end example - -This moves @q{B C} 2@tie{}spaces to the right, and 3 down, relative to its -surroundings. This command cannot be used to move isolated scripts -vertically, for the same reason that @code{\\raise} cannot be used for -that." - (ly:stencil-translate (interpret-markup layout props arg) +@lilypond[verbatim,quote] +\\markup { + * + \\translate #'(2 . 3) + \\line { translated two spaces right, three up } +} +@end lilypond" + (ly:stencil-translate (interpret-markup layout props arg) offset)) (define-builtin-markup-command (sub layout props arg) @@ -1963,7 +2914,19 @@ that." " @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 @@ -1979,7 +2942,16 @@ Set @var{arg} in subscript." " @cindex setting subscript in standard font size -Set @var{arg} in subscript, in a normal font size." +Set @var{arg} in subscript with 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) @@ -1996,7 +2968,17 @@ Set @var{arg} in subscript, in a normal font size." " @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))) @@ -2008,7 +2990,15 @@ Draw horizontal brackets around @var{arg}." " @cindex placing vertical brackets around text -Draw vertical brackets around @var{arg}." +Draw vertical brackets around @var{arg}. + +@lilypond[verbatim,quote] +\\markup { + \\bracket { + \\note #\"2.\" #UP + } +} +@end lilypond" (let ((th 0.1) ;; todo: take from GROB. (m (interpret-markup layout props arg))) (bracketify-stencil m Y th (* 2.5 th) th))) @@ -2050,13 +3040,26 @@ when @var{label} is not found." ;; Markup list commands ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -(define-public (space-lines baseline-skip lines) - (map (lambda (line) - (stack-lines DOWN 0.0 (/ baseline-skip 2.0) - (list point-stencil - line - point-stencil))) - lines)) +(define-public (space-lines baseline stils) + (let space-stil ((stils stils) + (result (list))) + (if (null? stils) + (reverse! result) + (let* ((stil (car stils)) + (dy-top (max (- (/ baseline 1.5) + (interval-bound (ly:stencil-extent stil Y) UP)) + 0.0)) + (dy-bottom (max (+ (/ baseline 3.0) + (interval-bound (ly:stencil-extent stil Y) DOWN)) + 0.0)) + (new-stil (ly:make-stencil + (ly:stencil-expr stil) + (ly:stencil-extent stil X) + (cons (- (interval-bound (ly:stencil-extent stil Y) DOWN) + dy-bottom) + (+ (interval-bound (ly:stencil-extent stil Y) UP) + dy-top))))) + (space-stil (cdr stils) (cons new-stil result)))))) (define-builtin-markup-list-command (justified-lines layout props args) (markup-list?)