X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-markup-commands.scm;h=55a313f3ecf1e423cb7c198b73bb02db17e97c5a;hb=8c2a317c9b2d8d105e1ccb0009b3b792c1f1b702;hp=42ce759bb7c31cea59d90456db7e45c97d933511;hpb=a3765e1d290e5e49093e7ca7791bf3fe20be1726;p=lilypond.git diff --git a/scm/define-markup-commands.scm b/scm/define-markup-commands.scm index 42ce759bb7..55a313f3ec 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--2006 Han-Wen Nienhuys +;;;; (c) 2000--2007 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen @@ -26,20 +26,23 @@ (define-builtin-markup-command (draw-line layout props dest) (number-pair?) - "A simple line. Uses the @code{thickness} property. " + "A simple line. Uses the @code{thickness} property." (let* - ((th (chain-assoc-get 'thickness props 0.1)) + ((th (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) (x (car dest)) - (y (cdr dest))) + (y (cdr dest)) + (s (ly:make-stencil + `(draw-line + ,th + 0 0 + ,x ,y) - (ly:make-stencil - `(draw-line - ,th - 0 0 - ,x ,y) + (cons (min x 0) (max x 0)) + (cons (min y 0) (max y 0))))) - (cons (min x 0) (min y 0)) - (cons (max x 0) (max y 0))))) + s)) (define-builtin-markup-command (draw-circle layout props radius thickness fill) (number? number? boolean?) @@ -48,7 +51,7 @@ optionally filled." (make-circle-stencil radius thickness fill)) (define-builtin-markup-command (triangle layout props filled) (boolean?) - "A triangle, filled or not" + "A triangle, either filled or empty." (let* ((th (chain-assoc-get 'thickness props 0.1)) (size (chain-assoc-get 'font-size props 0)) @@ -73,7 +76,9 @@ optionally filled." @code{circle-padding} and @code{font-size} properties to determine line thickness and padding around the markup." - (let* ((th (chain-assoc-get 'thickness props 0.1)) + (let* ((th + (* (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1))) (size (chain-assoc-get 'font-size props 0)) (pad (* (magstep size) @@ -82,7 +87,7 @@ thickness and padding around the markup." (circle-stencil m th pad))) (define-builtin-markup-command (with-url layout props url arg) (string? markup?) - "Add a link to URL @var{url} around @var{arg}. This only works in + "Add a link to URL @var{url} around @var{arg}. This only works in the PDF backend." (let* ((stil (interpret-markup layout props arg)) (xextent (ly:stencil-extent stil X)) @@ -117,7 +122,9 @@ the PDF backend." @code{box-padding} and @code{font-size} properties to determine line thickness and padding around the markup." - (let* ((th (chain-assoc-get 'thickness props 0.1)) + (let* ((th (* + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 0.1))) (size (chain-assoc-get 'font-size props 0)) (pad (* (magstep size) (chain-assoc-get 'box-padding props 0.2))) @@ -131,9 +138,9 @@ thickness and padding around the markup." @verbatim \\filled-box #'(-.3 . 1.8) #'(-.3 . 1.8) #0 @end verbatim -create a box extending horizontally from -0.3 to 1.8 and +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 0 (ie sharp corners)." +circle of diameter@tie{}0 (i.e. sharp corners)." (ly:round-filled-box xext yext blot)) @@ -144,7 +151,7 @@ circle of diameter 0 (ie sharp corners)." (define-builtin-markup-command (whiteout layout props arg) (markup?) - "Provide a white underground for @var{arg}" + "Provide a white underground for @var{arg}." (stencil-whiteout (interpret-markup layout props arg))) (define-builtin-markup-command (pad-markup layout props padding arg) (number? markup?) @@ -176,13 +183,15 @@ circle of diameter 0 (ie sharp corners)." ;; todo: fix negative space (define-builtin-markup-command (hspace layout props amount) (number?) - "This produces a invisible object taking horizontal space. + "This produces a invisible object taking horizontal space. For example, + @example \\markup @{ A \\hspace #2.0 B @} @end example -will put extra space between A and B, on top of the space that is -normally inserted before elements on a line. -" + +@noindent +puts extra space between A and@tie{}B, on top of the space that is +normally inserted before elements on a line." (if (> amount 0) (ly:make-stencil "" (cons 0 amount) '(-1 . 1)) (ly:make-stencil "" (cons amount amount) '(-1 . 1)))) @@ -193,7 +202,7 @@ normally inserted before elements on a line. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-builtin-markup-command (stencil layout props stil) (ly:stencil?) - "Stencil as markup" + "Use a stencil as markup." stil) (define bbox-regexp @@ -212,7 +221,7 @@ normally inserted before elements on a line. #f))) (define-builtin-markup-command (epsfile layout props axis size file-name) (number? number? string?) - "Inline an EPS image. The image is scaled along @var{axis} to + "Inline an EPS image. The image is scaled along @var{axis} to @var{size}." (if (ly:get-option 'safe) @@ -226,28 +235,26 @@ 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 +For the @TeX{} backend, the following string prints a rotated text @cindex rotated text -@verbatim +@example 0 0 moveto /ecrm10 findfont 1.75 scalefont setfont 90 rotate (hello) show -@end verbatim +@end example @noindent The magical constant 1.75 scales from LilyPond units (staff spaces) to -TeX dimensions. +@TeX{} dimensions. For the postscript backend, use the following -@verbatim +@example gsave /ecrm10 findfont 10.0 output-scale div scalefont setfont 90 rotate (hello) show grestore -@end verbatim -" +@end example" ;; FIXME (ly:make-stencil @@ -274,7 +281,7 @@ grestore empty-stencil)))) (define-builtin-markup-command (null layout props) () - "An empty markup with extents of a single point" + "An empty markup with extents of a single point." point-stencil) @@ -290,9 +297,7 @@ grestore (interpret-markup layout props str)) (define-builtin-markup-command (tied-lyric layout props str) (string?) - - "Like simple-markup, but use tie characters for ~ tilde symbols." - + "Like simple-markup, but use tie characters for @q{~} tilde symbols." (if (string-contains str "~") (let* ((parts (string-split str #\~)) @@ -345,12 +350,10 @@ grestore (define-builtin-markup-command (fill-line layout props markups) (markup-list?) "Put @var{markups} in a horizontal line of width @var{line-width}. - The markups are spaced/flushed to fill the entire line. - If there are no arguments, return an empty stencil." +The markups are spaced or flushed to fill the entire line. +If there are no arguments, return an empty stencil." - (let* ((orig-stencils - (map (lambda (x) (interpret-markup layout props x)) - markups)) + (let* ((orig-stencils (interpret-markup-list layout props markups)) (stencils (map (lambda (stc) (if (ly:stencil-empty? stc) @@ -406,7 +409,7 @@ grestore "Put @var{args} in a horizontal line. The property @code{word-space} determines the space between each markup in @var{args}." (let* - ((stencils (map (lambda (m) (interpret-markup layout props m)) args)) + ((stencils (interpret-markup-list layout props args)) (space (chain-assoc-get 'word-space props)) (text-dir (chain-assoc-get 'text-direction props RIGHT)) ) @@ -440,7 +443,9 @@ equivalent to @code{\"fi\"}." (interpret-markup layout (prepend-alist-chain 'word-space 0 props) - (make-line-markup (concat-string-args args)))) + (make-line-markup (if (markup-command-list? args) + args + (concat-string-args args))))) (define (wordwrap-stencils stencils justify base-space line-width text-dir) @@ -522,33 +527,28 @@ equivalent to @code{\"fi\"}." (define (wordwrap-markups layout props args justify) (let* - ((baseline-skip (chain-assoc-get 'baseline-skip props)) - (prop-line-width (chain-assoc-get 'line-width props #f)) + ((prop-line-width (chain-assoc-get 'line-width props #f)) (line-width (if prop-line-width prop-line-width (ly:output-def-lookup layout 'line-width))) (word-space (chain-assoc-get 'word-space props)) - (text-dir (chain-assoc-get 'text-direction props RIGHT)) - (lines (wordwrap-stencils - (remove ly:stencil-empty? - (map (lambda (m) (interpret-markup layout props m)) args)) - justify word-space line-width - text-dir) - )) - - (stack-lines DOWN 0.0 baseline-skip lines))) + (text-dir (chain-assoc-get 'text-direction props RIGHT))) + (wordwrap-stencils (remove ly:stencil-empty? + (interpret-markup-list layout props args)) + justify word-space line-width + text-dir))) (define-builtin-markup-command (justify layout props args) (markup-list?) "Like wordwrap, but with lines stretched to justify the margins. -Use @code{\\override #'(line-width . X)} to set line-width, where X -is the number of staff spaces." - - (wordwrap-markups layout props args #t)) +Use @code{\\override #'(line-width . @var{X})} to set the line width; +@var{X}@tie{}is the number of staff spaces." + (stack-lines DOWN 0.0 (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #t))) (define-builtin-markup-command (wordwrap layout props args) (markup-list?) - "Simple wordwrap. Use @code{\\override #'(line-width . X)} to set -line-width, where X is the number of staff spaces." - - (wordwrap-markups layout props args #f)) + "Simple wordwrap. Use @code{\\override #'(line-width . @var{X})} to set +the line width, where @var{X} is the number of staff spaces." + (stack-lines DOWN 0.0 (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #f))) (define (wordwrap-string layout props justify arg) (let* @@ -586,27 +586,29 @@ line-width, where X is the number of staff spaces." (define-builtin-markup-command (wordwrap-string layout props arg) (string?) - "Wordwrap a string. Paragraphs may be separated with double newlines" + "Wordwrap a string. Paragraphs may be separated with double newlines." (wordwrap-string layout props #f arg)) (define-builtin-markup-command (justify-string layout props arg) (string?) - "Justify a string. Paragraphs may be separated with double newlines" + "Justify a string. Paragraphs may be separated with double newlines" (wordwrap-string layout props #t arg)) (define-builtin-markup-command (wordwrap-field layout props symbol) (symbol?) - (let* ((m (chain-assoc-get symbol props))) - (if (string? m) - (interpret-markup layout props - (list wordwrap-string-markup m)) - (ly:make-stencil '() '(1 . -1) '(1 . -1))))) + "Wordwrap the data which has been assigned to @var{symbol}." + (let* ((m (chain-assoc-get symbol props))) + (if (string? m) + (interpret-markup layout props + (list wordwrap-string-markup m)) + (ly:make-stencil '() '(1 . -1) '(1 . -1))))) (define-builtin-markup-command (justify-field layout props symbol) (symbol?) - (let* ((m (chain-assoc-get symbol props))) - (if (string? m) - (interpret-markup layout props - (list justify-string-markup m)) - (ly:make-stencil '() '(1 . -1) '(1 . -1))))) + "Justify the data which has been assigned to @var{symbol}." + (let* ((m (chain-assoc-get symbol props))) + (if (string? m) + (interpret-markup layout props + (list justify-string-markup m)) + (ly:make-stencil '() '(1 . -1) '(1 . -1))))) @@ -624,7 +626,7 @@ line-width, where X is the number of staff spaces." @code{baseline-skip} determines the space between each markup in @var{args}." (let* - ((arg-stencils (map (lambda (m) (interpret-markup layout props m)) args)) + ((arg-stencils (interpret-markup-list layout props args)) (skip (chain-assoc-get 'baseline-skip props))) @@ -641,32 +643,32 @@ of the @code{#'direction} layout property." (if (number? dir) dir -1) 0.0 (chain-assoc-get 'baseline-skip props) - (map (lambda (x) (interpret-markup layout props x)) args)))) + (interpret-markup-list layout props args)))) (define-builtin-markup-command (center-align layout props args) (markup-list?) - "Put @code{args} in a centered column. " - (let* ((mols (map (lambda (x) (interpret-markup layout props x)) args)) + "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 (chain-assoc-get 'baseline-skip props) cmols))) (define-builtin-markup-command (vcenter layout props arg) (markup?) - "Align @code{arg} to its Y center. " + "Align @code{arg} to its Y@tie{}center." (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol Y CENTER))) (define-builtin-markup-command (hcenter layout props arg) (markup?) - "Align @code{arg} to its X center. " + "Align @code{arg} to its X@tie{}center." (let* ((mol (interpret-markup layout props arg))) (ly:stencil-aligned-to mol X CENTER))) (define-builtin-markup-command (right-align layout props arg) (markup?) - "Align @var{arg} on its right edge. " + "Align @var{arg} on its right edge." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X RIGHT))) (define-builtin-markup-command (left-align layout props arg) (markup?) - "Align @var{arg} on its left edge. " + "Align @var{arg} on its left edge." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X LEFT))) @@ -676,8 +678,8 @@ of the @code{#'direction} layout property." (ly:stencil-aligned-to m axis dir))) (define-builtin-markup-command (halign layout props dir arg) (number? markup?) - "Set horizontal alignment. If @var{dir} is @code{-1}, then it is -left-aligned, while @code{+1} is right. Values in between interpolate + "Set horizontal alignment. If @var{dir} is @code{-1}, then it is +left-aligned, while @code{+1} is right. Values inbetween interpolate alignment accordingly." (let* ((m (interpret-markup layout props arg))) (ly:stencil-aligned-to m X dir))) @@ -685,15 +687,14 @@ alignment accordingly." (define-builtin-markup-command (with-dimensions layout props x y arg) (number-pair? number-pair? markup?) - "Set the dimensions of @var{arg} to @var{x} and @var{y}." + "Set the dimensions of @var{arg} to @var{x} and@tie{}@var{y}." (let* ((m (interpret-markup layout props arg))) (ly:make-stencil (ly:stencil-expr m) x y))) (define-builtin-markup-command (pad-around layout props amount arg) (number? markup?) - - "Add padding @var{amount} all around @var{arg}. " + "Add padding @var{amount} all around @var{arg}." (let* ((m (interpret-markup layout props arg)) @@ -708,8 +709,7 @@ alignment accordingly." (define-builtin-markup-command (pad-x layout props amount arg) (number? markup?) - - "Add padding @var{amount} around @var{arg} in the X-direction. " + "Add padding @var{amount} around @var{arg} in the X@tie{}direction." (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) @@ -723,9 +723,7 @@ alignment accordingly." (define-builtin-markup-command (put-adjacent layout props arg1 axis dir arg2) (markup? integer? ly:dir? markup?) - - "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}. " - + "Put @var{arg2} next to @var{arg1}, without moving @var{arg1}." (let* ((m1 (interpret-markup layout props arg1)) (m2 (interpret-markup layout props arg2))) @@ -733,7 +731,7 @@ alignment accordingly." )) (define-builtin-markup-command (transparent layout props arg) (markup?) - "Make the argument transparent" + "Make the argument transparent." (let* ((m (interpret-markup layout props arg)) (x (ly:stencil-extent m X)) @@ -747,7 +745,7 @@ alignment accordingly." (define-builtin-markup-command (pad-to-box layout props x-ext y-ext arg) (number-pair? number-pair? markup?) - "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." (let* ((m (interpret-markup layout props arg)) @@ -777,8 +775,8 @@ alignment accordingly." (define-builtin-markup-command (fromproperty layout props symbol) (symbol?) "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" +from the markup contained within. If @var{symbol} is not defined, it +returns an empty markup." (let* ((m (chain-assoc-get symbol props))) (if (markup? m) (interpret-markup layout props m) @@ -786,8 +784,8 @@ alignment accordingly." (define-builtin-markup-command (on-the-fly layout props procedure arg) (symbol? markup?) - "Apply the @var{procedure} markup command to -@var{arg}. @var{procedure} should take a single argument." + "Apply the @var{procedure} markup command to @var{arg}. +@var{procedure} should take a single argument." (let* ((anonymous-with-signature (lambda (layout props arg) (procedure layout props arg)))) (set-object-property! anonymous-with-signature 'markup-signature @@ -801,11 +799,9 @@ alignment accordingly." any sort of property supported by @internalsref{font-interface} and @internalsref{text-interface}, for example -@verbatim +@example \\override #'(font-family . married) \"bla\" -@end verbatim - -" +@end example" (interpret-markup layout (cons (list new-prop) props) arg)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -813,7 +809,7 @@ any sort of property supported by @internalsref{font-interface} and ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-builtin-markup-command (verbatim-file layout props name) (string?) - "Read the contents of a file, and include verbatimly" + "Read the contents of a file, and include it verbatim." (interpret-markup layout props @@ -833,12 +829,12 @@ any sort of property supported by @internalsref{font-interface} and (define-builtin-markup-command (bigger layout props arg) (markup?) - "Increase the font size relative to current setting" + "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?) - "Decrease the font size relative to current setting" + "Decrease the font size relative to current setting." (interpret-markup layout props `(,fontsize-markup -1 ,arg))) @@ -852,7 +848,7 @@ any sort of property supported by @internalsref{font-interface} and (define-builtin-markup-command (fontsize layout props increment arg) (number? markup?) - "Add @var{increment} to the font-size. Adjust baseline skip accordingly." + "Add @var{increment} to the font-size. Adjust baseline skip accordingly." (let* ((fs (chain-assoc-get 'font-size props 0)) (bs (chain-assoc-get 'baseline-skip props 2)) @@ -863,13 +859,14 @@ any sort of property supported by @internalsref{font-interface} and (interpret-markup layout (cons entries props) arg))) (define-builtin-markup-command (magnify layout props sz arg) (number? markup?) - "Set the font magnification for the its argument. In the following -example, the middle A will be 10% larger: + "Set the font magnification for its argument. In the following +example, the middle@tie{}A is 10% larger: + @example A \\magnify #1.1 @{ A @} A @end example -Note: magnification only works if a font-name is explicitly selected. +Note: Magnification only works if a font name is explicitly selected. Use @code{\\fontsize} otherwise." (interpret-markup layout @@ -877,17 +874,17 @@ Use @code{\\fontsize} otherwise." arg)) (define-builtin-markup-command (bold layout props arg) (markup?) - "Switch to bold font-series" + "Switch to bold font-series." (interpret-markup layout (prepend-alist-chain 'font-series 'bold props) arg)) (define-builtin-markup-command (sans layout props arg) (markup?) - "Switch to the sans serif family" + "Switch to the sans serif family." (interpret-markup layout (prepend-alist-chain 'font-family 'sans props) arg)) (define-builtin-markup-command (number layout props arg) (markup?) "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. " +some punctuation. It doesn't have any letters." (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) arg)) (define-builtin-markup-command (roman layout props arg) (markup?) @@ -927,8 +924,7 @@ some punctuation. It doesn't have any letters. " "Turn @code{text}, which should be a string, to small caps. @example \\markup \\smallCaps \"Text between double quotes\" -@end example -" +@end example" (define (make-small-caps-markup chars) (cond ((null? chars) (markup)) @@ -989,13 +985,14 @@ some punctuation. It doesn't have any letters. " #f))) (define-builtin-markup-command (caps layout props arg) (markup?) + "Emit @var{arg} as small caps." (interpret-markup layout props (make-smallCaps-markup arg))) (define-builtin-markup-command (dynamic layout props arg) (markup?) "Use the dynamic font. This font only contains @b{s}, @b{f}, @b{m}, -@b{z}, @b{p}, and @b{r}. When producing phrases, like ``pi@`{u} @b{f}'', the -normal words (like ``pi@`{u}'') should be done in a different font. The -recommend font for this is bold and italic" +@b{z}, @b{p}, and @b{r}. When producing phrases, like +@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." (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaDynamic props) arg)) @@ -1008,7 +1005,7 @@ recommend font for this is bold and italic" (define-builtin-markup-command (italic layout props arg) (markup?) - "Use italic @code{font-shape} for @var{arg}. " + "Use italic @code{font-shape} for @var{arg}." (interpret-markup layout (prepend-alist-chain 'font-shape 'italic props) arg)) (define-builtin-markup-command (typewriter layout props arg) (markup?) @@ -1022,12 +1019,13 @@ recommend font for this is bold and italic" layout (prepend-alist-chain 'font-shape 'upright props) arg)) (define-builtin-markup-command (medium layout props arg) (markup?) - "Switch to medium font-series (in contrast to bold)." + "Switch to medium font series (in contrast to bold)." (interpret-markup layout (prepend-alist-chain 'font-series 'medium props) arg)) (define-builtin-markup-command (normal-text layout props arg) (markup?) - "Set all font related properties (except the size) to get the default normal text font, no matter what font was used earlier." + "Set all font related properties (except the size) to get the default +normal text font, no matter what font was used earlier." ;; ugh - latin1 (interpret-markup layout (cons '((font-family . roman) (font-shape . upright) @@ -1078,7 +1076,7 @@ recommend font for this is bold and italic" (interpret-markup layout props (markup #:musicglyph (assoc-get -1 standard-alteration-glyph-name-alist "")))) (define-builtin-markup-command (with-color layout props color arg) (color? markup?) - "Draw @var{arg} in color specified by @var{color}" + "Draw @var{arg} in color specified by @var{color}." (let* ((stil (interpret-markup layout props arg))) @@ -1094,7 +1092,8 @@ recommend font for this is bold and italic" (define-builtin-markup-command (arrow-head layout props axis direction filled) (integer? ly:dir? boolean?) - "produce an arrow head in specified direction and axis. Use the filled head if @var{filled} is specified." + "Produce an arrow head in specified direction and axis. +Use the filled head if @var{filled} is specified." (let* ((name (format "arrowheads.~a.~a~a" (if filled @@ -1108,9 +1107,10 @@ recommend font for this is bold and italic" name))) (define-builtin-markup-command (musicglyph layout props glyph-name) (string?) - "This is converted to a musical symbol, e.g. @code{\\musicglyph -#\"accidentals.natural\"} will select the natural sign from the music font. -See @usermanref{The Feta font} for a complete listing of the possible glyphs." + "@var{glyph-name} is converted to a musical symbol; for example, +@code{\\musicglyph #\"accidentals.natural\"} selects the natural sign from +the music font. See @usermanref{The Feta font} for a complete listing of +the possible glyphs." (ly:font-get-glyph (ly:paper-get-font layout (cons '((font-encoding . fetaMusic)) props)) @@ -1122,8 +1122,8 @@ See @usermanref{The Feta font} for a complete listing of the possible glyphs." glyph-name)) (define-builtin-markup-command (char layout props num) (integer?) - "Produce a single character, e.g. @code{\\char #65} produces the -letter 'A'." + "Produce a single character. For example, @code{\\char #65} produces the +letter @q{A}." (ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num))) @@ -1150,27 +1150,28 @@ letter 'A'." (make-string 1 (vector-ref vec n))))) (define-builtin-markup-command (markletter layout props num) (integer?) - "Make a markup letter for @var{num}. The letters start with A to Z - (skipping I), and continues with double letters." + "Make a markup letter for @var{num}. The letters start with A to@tie{}Z +(skipping letter@tie{}I), and continue with double letters." (ly:text-interface::interpret-markup layout props (number->markletter-string number->mark-letter-vector num))) (define-builtin-markup-command (markalphabet layout props num) (integer?) - "Make a markup letter for @var{num}. The letters start with A to Z - and continues with double letters." + "Make a markup letter for @var{num}. The letters start with A to@tie{}Z +and continue with double letters." (ly:text-interface::interpret-markup layout props (number->markletter-string number->mark-alphabet-vector num))) (define-builtin-markup-command (slashed-digit layout props num) (integer?) - "A feta number, with slash. This is for use in the context of -figured bass notation" + "A feta number, with slash. This is for use in the context of +figured bass notation." (let* ((mag (magstep (chain-assoc-get 'font-size props 0))) (thickness (* mag - (chain-assoc-get 'thickness props 0.16))) + (ly:output-def-lookup layout 'line-thickness) + (chain-assoc-get 'thickness props 1.6))) (dy (* mag 0.15)) (number-stencil (interpret-markup layout (prepend-alist-chain 'font-encoding 'fetaNumber props) @@ -1319,7 +1320,7 @@ figured bass notation" (define-builtin-markup-command (note layout props duration dir) (string? number?) "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 +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." (let ((parsed (parse-simple-duration duration))) @@ -1331,17 +1332,15 @@ a shortened down stem." ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (define-builtin-markup-command (lower layout props amount arg) (number? markup?) - " -Lower @var{arg}, by the distance @var{amount}. -A negative @var{amount} indicates raising, see also @code{\\raise}. -" + "Lower @var{arg} by the distance @var{amount}. +A negative @var{amount} indicates raising; see also @code{\\raise}." (ly:stencil-translate-axis (interpret-markup layout props arg) (- amount) Y)) (define-builtin-markup-command (translate-scaled layout props offset arg) (number-pair? markup?) - "Translate @var{arg} by @var{offset}, scaling the offset by the @code{font-size}." - + "Translate @var{arg} by @var{offset}, scaling the offset by the +@code{font-size}." (let* ((factor (magstep (chain-assoc-get 'font-size props 0))) (scaled (cons (* factor (car offset)) @@ -1351,12 +1350,11 @@ A negative @var{amount} indicates raising, see also @code{\\raise}. scaled))) (define-builtin-markup-command (raise layout props amount arg) (number? markup?) - " -Raise @var{arg}, by the distance @var{amount}. + "Raise @var{arg} by the distance @var{amount}. A negative @var{amount} indicates lowering, see also @code{\\lower}. @c @lilypond[verbatim,fragment,relative=1] - c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" }} +c1^\\markup { C \\small \\raise #1.0 \\bold { \"9/7+\" } } @end lilypond The argument to @code{\\raise} is the vertical displacement amount, measured in (global) staff spaces. @code{\\raise} and @code{\\super} @@ -1365,8 +1363,8 @@ raise objects in relation to their surrounding markups. If the text object itself is positioned above or below the staff, then @code{\\raise} cannot be used to move it, since the mechanism that positions it next to the staff cancels any shift made with -@code{\\raise}. For vertical positioning, use the @code{padding} -and/or @code{extra-offset} properties. " +@code{\\raise}. For vertical positioning, use the @code{padding} +and/or @code{extra-offset} properties." (ly:stencil-translate-axis (interpret-markup layout props arg) amount Y)) (define-builtin-markup-command (fraction layout props arg1 arg2) (markup? markup?) @@ -1393,10 +1391,6 @@ and/or @code{extra-offset} properties. " ;; empirical anyway (ly:stencil-translate-axis stack offset Y)))) - - - - (define-builtin-markup-command (normal-size-super layout props arg) (markup?) "Set @var{arg} in superscript with a normal font size." (ly:stencil-translate-axis @@ -1412,15 +1406,12 @@ and/or @code{extra-offset} properties. " @cindex @code{\\super} - Raising and lowering texts can be done with @code{\\super} and @code{\\sub}: - +@c @lilypond[verbatim,fragment,relative=1] - c1^\\markup { E \"=\" mc \\super \"2\" } -@end lilypond - -" +c1^\\markup { E \"=\" \\concat { \"mc\" \\super \"2\" } } +@end lilypond" (ly:stencil-translate-axis (interpret-markup layout @@ -1430,16 +1421,16 @@ Raising and lowering texts can be done with @code{\\super} and Y)) (define-builtin-markup-command (translate layout props offset arg) (number-pair? markup?) - "This translates an object. Its first argument is a cons of numbers + "This translates an object. Its first argument is a cons of numbers. + @example A \\translate #(cons 2 -3) @{ B C @} D @end example -This moves `B C' 2 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. -" +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) offset)) @@ -1476,8 +1467,68 @@ that. (m (interpret-markup layout props arg))) (bracketify-stencil m Y th (* 2.5 th) th))) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;; Delayed markup evaluation +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +(define-builtin-markup-command (page-ref layout props label gauge default) + (symbol? markup? markup?) + "Reference to a page number. @var{label} is the label set on the referenced +page (using the @code{\\label} command), @var{gauge} a markup used to estimate +the maximum width of the page number, and @var{default} the value to display +when @var{label} is not found." + (let* ((gauge-stencil (interpret-markup layout props gauge)) + (x-ext (ly:stencil-extent gauge-stencil X)) + (y-ext (ly:stencil-extent gauge-stencil Y))) + (ly:make-stencil + `(delay-stencil-evaluation + ,(delay (ly:stencil-expr + (let* ((table (ly:output-def-lookup layout 'label-page-table)) + (label-page (and (list? table) (assoc label table))) + (page-number (and label-page (cdr label-page))) + (page-markup (if page-number (format "~a" page-number) default)) + (page-stencil (interpret-markup layout props page-markup)) + (gap (- (interval-length x-ext) + (interval-length (ly:stencil-extent page-stencil X))))) + (interpret-markup layout props + (markup #:concat (#:hspace gap page-markup))))))) + x-ext + y-ext))) + ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;; size indications arrow +;; Markup list commands ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +(define-public (space-lines baseline-skip lines) + (map (lambda (line) + (stack-lines DOWN 0.0 (/ baseline-skip 2.0) + (list (ly:make-stencil "" (cons 0 0) (cons 0 0)) + line + (ly:make-stencil "" (cons 0 0) (cons 0 0))))) + lines)) + +(define-builtin-markup-list-command (justified-lines layout props args) (markup-list?) + "Like @code{\\justify}, but return a list of lines instead of a single markup. +Use @code{\\override #'(line-width . @var{X})} to set the line width; +@var{X}@tie{}is the number of staff spaces." + (space-lines (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #t))) + +(define-builtin-markup-list-command (wordwrap-lines layout props args) (markup-list?) + "Like @code{\\wordwrap}, but return a list of lines instead of a single markup. +Use @code{\\override #'(line-width . @var{X})} to set the line width, +where @var{X} is the number of staff spaces." + (space-lines (chain-assoc-get 'baseline-skip props) + (wordwrap-markups layout props args #f))) + +(define-builtin-markup-list-command (column-lines layout props args) (markup-list?) + "Like @code{\\column}, but return a list of lines instead of a single markup. +@code{baseline-skip} determines the space between each markup in @var{args}." + (space-lines (chain-assoc-get 'baseline-skip props) + (interpret-markup-list layout props args))) + +(define-builtin-markup-list-command (override-lines layout props new-prop args) + (pair? markup-list?) + "Like @code{\\override}, for markup lists." + (interpret-markup-list layout (cons (list new-prop) props) args))