-;;;; grob-property-description.scm -- part of generated backend documentation
+;;;; define-grob-properties.scm -- part of generated backend documentation
;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; (c) 1998--2008 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(define (define-grob-property symbol type? description)
be used: @code{#UP}=@code{1}, @code{#DOWN}=@code{-1},
@code{#LEFT}=@code{-1}, @code{#RIGHT}=@code{1}, @code{#CENTER}=@code{0}.")
(dot-count ,integer? "The number of dots.")
+ (dot-negative-kern ,number? "The space to remove between a dot
+a and slash in percent repeat glyphs. Larger values bring the two
+elements closer together.")
+ (dot-placement-list ,list? "List
+consisting of @code{(@var{description} @var{string-number}
+@var{fret-number} @var{finger-number})}
+entries used to define fret diagrams.")
(duration-log ,integer? "The 2-log of the note head duration,
i.e., @code{0} = whole note, @code{1} = half note, etc.")
left side of the item and adding the @q{cdr} on the right side of the
item). In order to make a grob take up no horizontal space at all,
set this to @code{(+inf.0 . -inf.0)}.")
+ (flag ,ly:stencil? "A function returning the full flag stencil for
+the @code{Stem}, which is passed to the function as the only argument.
+The default ly:stem::calc-stencil function uses the @code{flag-style}
+property to determine the correct glyph for the
+flag. By providing your own function, you can create arbitrary flags.")
(flag-count ,number? "The number of tremolo beams.")
- (flag-style ,symbol? "A string determining what style of flag
-glyph is typeset on a @code{Stem}. Valid options include @code{()}
-and @code{mensural}. Additionally, @code{no-flag} switches off the
-flag.")
+ (flag-style ,symbol? "A symbol determining what style of flag
+glyph is typeset on a @code{Stem}. Valid options include @code{'()} for
+standard flags, @code{'mensural} and @code{'no-flag}, which switches off
+the flag.")
(font-encoding ,symbol? "The font encoding is the broadest
category for selecting a font. Options include: @code{fetaMusic},
@code{fetaNumber}, @code{TeX-text}, @code{TeX-math},
(force-hshift ,number? "This specifies a manual shift for notes
in collisions. The unit is the note head width of the first voice
note. This is used by @rinternals{note-collision-interface}.")
- (forced ,boolean? "Manually forced accidental.")
(fraction ,number-pair? "Numerator and denominator of a time
signature object.")
(french-beaming ,boolean? "Use French beaming style for this
@itemize @bullet
@item
@code{barre-type} -- Type of barre indication used.
-Choices include @code{curved} and @code{straight}.
+Choices include @code{curved}, @code{straight}, and
+@code{none}. Default @code{curved}.
@item
@code{dot-color} -- Color of dots. Options include
-@code{black} and @code{white}.
+@code{black} and @code{white}. Default @code{black}.
@item
@code{dot-label-font-mag} -- Magnification for font used to
label fret dots. Default value 1.
@item
-@code{dot-radius} -- Radius of dots.
+@code{dot-radius} -- Radius of dots, in terms of fret spaces.
+Default value 0.425 for labeled dots, 0.25 for unlabeled dots.
@item
@code{finger-code} -- Code for the type of fingering indication used.
Options include @code{none}, @code{in-dot}, and
-@code{below-string}.
+@code{below-string}. Default @code{none} for markup fret diagrams,
+@code{below-string} for @code{FretBoards} fret diagrams.
@item
-@code{fret-count} -- The number of frets.
+@code{fret-count} -- The number of frets. Default 4.
@item
@code{fret-label-font-mag} -- The magnification of the font used to label
the lowest fret number. Default 0.5
@code{label-dir} -- Side to which the fret label is attached.
@code{-1}, @code{#LEFT}, or @code{#DOWN} for left or down;
@code{1}, @code{#RIGHT}, or @code{#UP} for right or up.
+Default @code{#RIGHT}.
@item
-@code{mute-string} -- Character string to be used to indicate muted string.
+@code{mute-string} -- Character string to be used to indicate muted
+string. Default \"x\".
@item
@code{number-type} -- Type of numbers to use in fret label. Choices
-include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.
+include @code{roman-lower}, @code{roman-upper}, and @code{arabic}. Default
+@code{roman-lower}.
@item
-@code{open-string} -- Character string to be used to indicate open string.
+@code{open-string} -- Character string to be used to indicate open
+string. Default \"o\".
@item
@code{orientation} -- Orientation of fret-diagram. Options include
-@code{normal} and @code{landscape}
+@code{normal} and @code{landscape}. Default @code{normal}.
@item
-@code{string-count} -- The number of strings.
+@code{string-count} -- The number of strings. Default 6.
@item
-@code{string-label-font-mag} -- The magnification of the font used to label fingerings
-at the string, rather than in the dot. Default value 0.6.
+@code{string-label-font-mag} -- The magnification of the font used to label
+fingerings at the string, rather than in the dot. Default value 0.6.
@item
@code{top-fret-thickness} -- The thickness of the top fret line, as a multiple
of the standard thickness. Default value 3.
@code{xo-font-magnification} -- Magnification used for mute and
open string indicators. Default value 0.5.
@item
-@code{xo-padding} -- Padding for open and mute indicators from top fret. Default
-value 0.25.
-@end itemize")
+@code{xo-padding} -- Padding for open and mute indicators from top fret.
+Default value 0.25.
+@end itemize") ;"
;; ugh: double, change.
+ (full-length-padding ,number? "How much padding to use at the right side of a full-length tuplet bracket.")
+ (full-length-to-extent ,boolean? "Run to the extent of the column for a full-length tuplet bracket.")
+
(full-size-change ,boolean? "Don't make a change clef smaller.")
(gap ,ly:dimension? "Size of a gap in a variable symbol.")
(hair-thickness ,number? "Thickness of the thin line in a bar
line.")
+ (harp-pedal-details ,list? "An alist of detailed grob properties
+for harp pedal diagrams. Each alist entry consists of a
+(@code{property} . @code{value}) pair.
+The properties which can be included in harp-pedal-details
+include the following:
+@itemize @bullet
+@item
+@code{box-offset} -- Vertical shift of the center of flat / sharp pedal
+boxes above / below the horizontal line. Default value 0.8.
+@item
+@code{box-width} -- Width of each pedal box. Default value 0.4.
+@item
+@code{box-height} -- Height of each pedal box. Default value 1.0.
+@item
+@code{space-before-divider} -- Space between boxes before the first divider
+(so that the diagram can be made symmetric). Default value 0.8.
+@item
+@code{space-after-divider} -- Space between boxes after the first divider.
+Default value 0.8.
+@item
+@code{circle-thickness} -- Thickness (in unit of the line-thickness) of the
+ellipse around circled pedals. Default value 0.5.
+@item
+@code{circle-x-padding} -- Padding in X direction of the ellipse around
+circled pedals. Default value 0.15.
+@item
+@code{circle-y-padding} -- Padding in Y direction of the ellipse around
+circled pedals. Default value 0.2.
+@end itemize")
+
(head-direction ,ly:dir? "Are the note heads left or right in a
semitie?")
(height ,ly:dimension? "Height of an object in
correction and @code{1} for full correction.")
(labels ,list? "List of labels (symbols) placed on a column")
- (layer ,number? "The output layer (a value between 0 and@tie{}2:
+ (layer ,integer? "The output layer (a value between 0 and@tie{}2:
Layers define the order of printing objects. Objects in lower layers
are overprinted by objects in higher layers.")
(ledger-line-thickness ,number-pair? "The thickness of ledger
@code{direction-source} with this to get the direction of this
object.")
(size ,number? "Size of object, relative to standard size.")
+ (slash-negative-kern ,number? "The space to remove between
+slashes in percent repeat glyphs. Larger values bring the two
+elements closer together.")
(slope ,number? "The slope of this object.")
(slur-padding ,number? "Extra distance between slur and script.")
(space-alist ,list? "A table that specifies distances between
(stencil ,ly:stencil? "The symbol to print.")
(stencils ,list? "Multiple stencils, used as intermediate
value.")
- (strict-grace-spacing ,boolean? "If set, grace notes
-are not spaced separately, but put before musical columns.")
+ (strict-grace-spacing ,boolean? "If set, main notes are spaced
+normally, then grace notes are put left of the musical columns fot the main notes.")
(strict-note-spacing ,boolean? "If set, unbroken columns
with non-musical material (clefs, bar lines, etc.) are not spaced
separately, but put before musical columns.")
- (string-fret-finger-combinations ,list? "List consisting of
-@code{(@var{string-number} @var{fret-number} @var{finger-number})}
-entries.")
(stroke-style ,string? "Set to @code{\"grace\"} to turn stroke
through flag on.")
(style ,symbol? "This setting determines in what style a grob is
in addition to notes and stems.")
(figures ,ly:grob-array? "Figured bass objects for continuation line.")
+ (forced ,boolean? "Manually forced accidental.")
(glyph-name ,string? "The glyph name within the font.")
(grace-spacing ,ly:grob? "A run of grace notes.")
;; However, such a list would consist of a couple of dozens of
;; entries, since head prefixes may be combined in many ways. If
- ;; the macros in `gregorian-init.ly' would directly set prefix-set,
+ ;; the macros in `gregorian.ly' would directly set prefix-set,
;; all the head prefixes could be junked; however, such macros
;; would be quite numerous, I guess. --jr
projects / lilypond.git / blobdiff