;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 2000--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; (c) 2000--2009 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
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]
\\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?)
@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 {
(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)
@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 {
(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,relative=2]
c4^\\markup {
@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
()
}
\\hspace #2
\\box {
- \\pad-around #1 {
+ \\pad-markup #1 {
padded
}
}
(ly:make-stencil
(ly:stencil-expr stil)
- (interval-widen xext padding)
- (interval-widen yext padding))))
+ (interval-widen xext amount)
+ (interval-widen yext amount))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; space
"
@cindex creating horizontal spaces in text
-This produces an invisible object taking horizontal space. For example,
-
-@example
-\\markup @{ A \\hspace #2.0 B @}
-@end example
-
-@noindent
-puts extra space between A and@tie{}B, on top of the space that is
-normally inserted before elements on a line.
+Create an invisible object taking up horizontal space @var{amount}.
@lilypond[verbatim,quote]
\\markup {
()
"
@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 = #\"
(/ (+ (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)
}
}
@end lilypond"
- (let* ((orig-stencils (interpret-markup-list layout props markups))
+ (let* ((orig-stencils (interpret-markup-list layout props args))
(stencils
(map (lambda (stc)
(if (ly:stencil-empty? stc)
((word-space)
(text-direction RIGHT))
"Put @var{args} in a horizontal line. The property @code{word-space}
-determines the space between each markup in @var{args}.
+determines the space between markups in @var{args}.
@lilypond[verbatim,quote]
\\markup {
\\line {
- A simple line of text
+ one two three
}
}
@end lilypond"
@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\"}.
@lilypond[verbatim,quote]
\\markup {
- \\bold {
- au
- \\concat {
- Mouv
- \\super
- t
- }
+ \\concat {
+ one
+ two
+ three
}
}
@end lilypond"
"
@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.
\\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\"
+ 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
\\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\"
+ 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
@lilypond[verbatim,quote]
\\header {
title = \"My title\"
- descr = \"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.\"
+ 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 {
@lilypond[verbatim,quote]
\\header {
title = \"My title\"
- descr = \"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.\"
+ 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 {
\\column {
\\fill-line { \\fromproperty #'header:title }
\\null
- \\justify-field #'header:descr
+ \\justify-field #'header:description
}
}
}
(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
()
\\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)))
;;
@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 {
"
@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 . 1) {
+ \\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)
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))
@lilypond[verbatim,quote]
\\markup {
- \\center-align {
+ \\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"
- (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)))
+ (general-column RIGHT baseline-skip (interpret-markup-list layout props args)))
(define-builtin-markup-command (vcenter layout props arg)
(markup?)
@lilypond[verbatim,quote]
\\markup {
- \\arrow-head #X #RIGHT ##f
+ one
\\vcenter
- Centered
- \\arrow-head #X #LEFT ##f
+ 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
()
@lilypond[verbatim,quote]
\\markup {
\\column {
- ↓
- \\hcenter
- centered
+ one
+ \\center-align
+ two
+ three
}
}
@end lilypond"
@lilypond[verbatim,quote]
\\markup {
\\column {
- ↓
+ one
\\right-align
- right-aligned
+ two
+ three
}
}
@end lilypond"
@lilypond[verbatim,quote]
\\markup {
\\column {
- ↓
+ one
\\left-align
- left-aligned
+ two
+ three
}
}
@end lilypond"
@lilypond[verbatim,quote]
\\markup {
\\column {
- ↓
+ one
\\general-align #X #LEFT
- \\line { X, Left }
- ↓
+ two
+ three
+ \\null
+ one
\\general-align #X #CENTER
- \\line { X, Center }
+ two
+ three
\\null
\\line {
- \\arrow-head #X #RIGHT ##f
- \\general-align #Y #DOWN
- \\line { Y, Down }
- \\arrow-head #X #LEFT ##f
+ one
+ \\general-align #Y #UP
+ two
+ three
}
+ \\null
\\line {
- \\arrow-head #X #RIGHT ##f
+ one
\\general-align #Y #3.2
- \\line {
- \\line { Y, Arbitrary alignment }
- }
- \\arrow-head #X #LEFT ##f
+ two
+ three
}
}
}
@lilypond[verbatim,quote]
\\markup {
\\column {
- ↓
+ one
\\halign #LEFT
- Left
- ↓
+ two
+ three
+ \\null
+ one
\\halign #CENTER
- Center
- ↓
+ two
+ three
+ \\null
+ one
\\halign #RIGHT
- Right
- ↓
- \\halign #1.2
- \\line {
- Arbitrary alignment
- }
+ two
+ three
+ \\null
+ one
+ \\halign #-5
+ two
+ three
}
}
@end lilypond"
(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
()
- "
-@ignore
-This is broken, since there's no parser tag for the signature
-markup_scm_scm_markup. Only works using Scheme markup. -np
-@end ignore
-
-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)))
(ly:stencil-combine-at-edge m1 axis dir m2 0.0)))
(markup?)
other
()
- "Make the argument transparent.
+ "Make @var{arg} transparent.
@lilypond[verbatim,quote]
\\markup {
(make-pad-to-box-markup
(cons (/ length -2) (/ length 2))
'(0 . 0)
- (make-hcenter-markup arg))))
+ (make-center-align-markup arg))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; property
"
@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
-
-@example
-\\override #'(font-family . married) \"bla\"
-@end 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}.
@lilypond[verbatim,quote]
\\markup {
(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 {
;; fonts.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-(define-builtin-markup-command (bigger layout props arg)
- (markup?)
- font
- ()
- "Increase the font size relative to current setting.
-
-@lilypond[verbatim,quote]
-\\markup {
- \\huge {
- huge
- \\hspace #2
- \\bigger {
- bigger
- }
- \\hspace #2
- huge
- }
-}
-@end lilypond"
- (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 {
(markup?)
font
()
- "Copy of the @code{\\bigger} command.
+ "Increase the font size relative to the current setting.
@lilypond[verbatim,quote]
\\markup {
larger
}
@end lilypond"
- (interpret-markup layout props (make-bigger-markup arg)))
+ (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 {
font
()
"Use @var{size} as the absolute font size to display @var{arg}.
-Adjust baseline skip and word space accordingly.
+Adjusts @code{baseline-skip} and @code{word-space} accordingly.
+
@lilypond[verbatim,quote]
\\markup {
default text font size
((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
(markup?)
font
()
- "Switch to the sans serif family.
+ "Switch to the sans serif font family.
@lilypond[verbatim,quote]
\\markup {
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 {
(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
()
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?)
(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 {
(markup?)
font
()
- "Switch to medium font series (in contrast to bold).
+ "Switch to medium font-series (in contrast to bold).
@lilypond[verbatim,quote]
\\markup {
()
music
()
- "Draw a semi sharp symbol.
+ "Draw a semisharp symbol.
@lilypond[verbatim,quote]
\\markup {
;; 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
()
"close"
"open")
axis
- direction)))
+ dir)))
(ly:font-get-glyph
(ly:paper-get-font layout (cons '((font-encoding . fetaMusic))
props))
(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 #65 \\char ##x00a9
}
@end lilypond"
(ly:text-interface::interpret-markup layout props (ly:wide-char->utf-8 num)))
(number->markletter-string number->mark-alphabet-vector num)))
(define-public (horizontal-slash-interval num forward number-interval mag)
- (ly:message "Mag step: ~a" mag)
(if forward
(cond ;((= num 6) (interval-widen number-interval (* mag 0.5)))
;((= num 5) (interval-widen number-interval (* mag 0.5)))
(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
- (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)
+ (make-line-stencil thickness
+ (car num-x) (- (interval-center num-y) dy)
+ (cdr num-x) (+ (interval-center num-y) dy))
#f)))
-(ly:message "Num: ~a, X-interval: ~a" num num-x)
(if (ly:stencil? slash-stencil)
(begin
; for some numbers we need to shift the slash/backslash up or down to make
@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 {
@lilypond[verbatim,quote]
\\markup {
- default
- \\lower #3 {
- three spaces lower
- }
+ one
+ \\lower #3
+ two
+ three
}
@end lilypond"
(ly:stencil-translate-axis (interpret-markup layout props arg)
"
@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 {
"
@cindex translating text
-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 @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.
+Translate @var{arg} relative to its surroundings. @var{offset}
+is a pair of numbers representing the displacement in the X and Y axis.
@lilypond[verbatim,quote]
\\markup {
"
@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 {