X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=65f0c23270a743ef7fdb62109393cc48ca32925a;hb=ce6631d3228ee491574ed841abc0ae06dc22f6e4;hp=8c96d894ca343036e9af0f2a07074d8da3a005e0;hpb=9193ac6225e2beafb8ea5da2610c70dd610e03be;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index 8c96d894ca..65f0c23270 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -10,7 +10,7 @@ (define (define-grob-property symbol type? description) (if (not (equal? (object-property symbol 'backend-doc) #f)) (begin - (ly:warn (string-append "Redefining " (symbol->string symbol) "\n")) + (ly:warn-append "Redefining ~S" symbol) (exit 2) )) @@ -42,8 +42,7 @@ called first. The functions take a grob and axis argument. ") (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.") (accidentals ,list? "List of alteration numbers.") - - + (align-dir ,ly:dir? "Which side to align? @code{-1}: left side, @code{0}: around center of width, @code{1}: right side.") (arch-angle ,number? "Turning angle of the hook of a system brace" ) @@ -63,7 +62,7 @@ the attachments to prevent ugly slurs. [fixme: we need more documentation here].") - (auto-knee-gap ,ly:dimension? "If a gap is found between noteheads + (auto-knee-gap ,ly:dimension? "If a gap is found between note heads where a horizontal beam fits that is larger than this number, make a kneed beam.") (axes ,list? "list of axis numbers. In the case of alignment grobs, this should contain only one number.") @@ -80,6 +79,8 @@ original stencil drawer to draw the balloon around.") (bar-size ,ly:dimension? "size of a bar line.") (bar-size-procedure ,procedure? "Procedure that computes the size of a bar line.") + (barre-type ,symbol? "Type of barre indication used in a fret diagram. +Choices include @code{curved} and @code{straight}.") (base-shortest-duration ,ly:moment? "Spacing is based on the shortest notes in a piece. Normally, pieces are spaced as if notes at least as short as this are present.") (baseline-skip ,ly:dimension? "Distance between base lines of @@ -105,16 +106,34 @@ beaming patterns from stem to stem inside a beam.") called before line breaking, but after splitting breakable items at potential line breaks.") (between-cols ,pair? "Where to attach a loose column to") - (between-system-string ,string? "string - to dump between two systems. Useful for forcing pagebreaks.") + (bracket-flare ,number-pair? "A pair of numbers specifying how +much edges of brackets should slant outward. Value 0.0 means straight +edges") (bracket-thick ,number? "width of a system start bracket.") (break-align-symbol ,symbol? "This key is used for aligning and spacing breakable items.") + (break-align-orders ,vector? " Defines the order in which +prefatory matter (clefs, key signatures) appears. The format is a +vector of length 3, where each element is one order for end-of-line, +middle of line, and start-of-line respectively. An order is a list of +symbols. + +For example, clefs are put after key signatures by setting + +@example + \\override Score.BreakAlignment #'break-align-orders = #(make-vector 3 + '(span-bar + breathing-sign + staff-bar + key + clef + time-signature)) +@end example") (break-glyph-function ,procedure? "This function determines the -appearance of a barline at the line break. It takes a glyph and +appearance of a bar line at the line break. It takes a glyph and break-direction and returns the glyph at a line break.") (breakable ,boolean? "Can this object appear at a line break, -like clefs and barlines?") +like clefs and bar lines?") (c0-position ,integer? "An integer indicating the position of middle C.") (cautionary-style ,symbol? "How to print cautionary @@ -123,14 +142,14 @@ accidentals. Choices are @code{smaller} or (cautionary ,boolean? "Is this a cautionary accidental?") (concaveness-gap ,ly:dimension? "A beam is printed horizontally if its concaveness-gap is larger than this value. The concaveness-gap -is the distance of an inner notehead to the line between two outer -noteheads. ") +is the distance of an inner note head to the line between two outer +note heads. ") (concaveness-threshold ,number? "A beam is printed horizontally if its concaveness is bigger than this threshold. Concaveness is calculated as the sum of the vertical distances of -inner noteheads that fall outside the interval of the two outer -noteheads, to the vertically nearest outer notehead, divided by the +inner note heads that fall outside the interval of the two outer +note heads, to the vertically nearest outer note head, divided by the square of the inner notes involved.") (collapse-height ,ly:dimension? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.") @@ -138,7 +157,7 @@ square of the inner notes involved.") (control-points ,list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.") - (damping ,integer? "Amount of beam slope damping. 0: no, 1: yes, + (damping ,number? "Amount of beam slope damping. 0: no, 1: yes, 100000: horizontal beams.") (dash-period ,number? "the length of one dash + white space. If negative, no line is drawn at all.") @@ -149,11 +168,6 @@ line).") ;; [FIXME: use dash-period/dash length; see text-spanner] (dashed ,number? " number representing the length of the dashes.") - (neutral-direction ,ly:dir? "Which direction to take in the -center of the staff.") - (neutral-position ,number? "Position (in half staff spaces) where -to flip the direction of custos stem.") - ;; todo: why is this tunable? (dir-function ,procedure? "The function to determine the @@ -171,14 +185,13 @@ mean center distance weighted per note ") (direction ,ly:dir? "Up or down, left or right?") + (dot-color ,symbol? "Color of dots. Options include +@code{black} and @code{white}.") + (dot-radius ,number? "Radius of dots.") (dot-count ,integer? "The number of dots.") - (duration-log ,integer? "The 2-log of the notehead duration, i.e. 0=whole note, 1 = half note, etc.") + (duration-log ,integer? "The 2-log of the note head duration, i.e. 0=whole note, 1 = half note, etc.") (edge-height ,pair? "A pair of number specifying the heights of the vertical edges '(@var{left-height} . @var{right-height}).") - (bracket-flare ,number-pair? "A pair of numbers specifying how -much edges of brackets should slant outward. Value 0.0 means straight -edges") - (edge-text ,pair? "A pair specifying the texts to be set at the edges '(@var{left-text} . @var{right-text}).") (expand-limit ,integer? "maximum number of measures expanded in church rests.") @@ -197,14 +210,16 @@ engine is completely oblivious to it.") ;; docme. (extremity-offset-alist ,list? "The offset adds to the centre of -the notehead, or stem. +the note head, or stem. Format: alist (attachment stem-dir*dir slur-dir*dir) -> offset. ") ;; (extremity-function ,procedure? "A function that calculates the -attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.") +attachment of a slur-end. The function takes a slur and direction argument and returns a symbol.") + (finger-code ,symbol? "Code for the type of fingering indication in a +fret diagram. Options include @code{none}, @code{in-dot}, and @code{below-string}.") (flag-style ,symbol? "a string determining what style of flag-glyph is typeset on a Stem. Valid options include @code{()} and @@ -212,7 +227,11 @@ typeset on a Stem. Valid options include @code{()} and flag.") (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.") (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).") - (font-family ,symbol? "The font family is the broadest category for selecting a font. Options include: @code{music}, @code{roman}, etc... ") + (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ") + (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}, @code{fetaBraces}, +@code{fetaDynamic}") (font-name ,string? "Specifies a file name (without extension) of the font to load. This setting override selection using @code{font-family}, @code{font-series} and @code{font-shape}.") @@ -237,6 +256,7 @@ note. This is used by @internalsref{note-collision-interface}.") signature object.") (french-beaming ,boolean? "Use French beaming style for this stem. The stem will stop at the innermost beams.") + (fret-count ,integer? "The number of frets in a fret diagram.") ;; ugh: double, change. (full-size-change ,boolean? "Don't make a change clef smaller.") @@ -256,7 +276,7 @@ within font, to use for printing a symbol.") of the @code{spacing-increment}.") (grow-direction ,ly:dir? "Crescendo or decrescendo?") - (hair-thickness ,number? "Thickness of the thin line in a barline.") + (hair-thickness ,number? "Thickness of the thin line in a bar line.") (height ,ly:dimension? "Height of an object in staffspace.") (height-limit ,ly:dimension? "Maximum slur height: the longer the slur, the closer it is to this height.") @@ -264,8 +284,11 @@ slur, the closer it is to this height.") (horizontal-shift ,integer? "An integer that identifies ranking of note-column for horizontal shifting. This is used by @internalsref{note-collision-interface}.") + (inspect-quants ,number-pair? "If debugging is set, +set beam quant to this position, and print the respective scores.") + (kern ,ly:dimension? "Amount of extra white space to add. For -barline, this is the amount of space after a thick line.") +bar line, this is the amount of space after a thick line.") (knee ,boolean? "Is this beam kneed?") (knee-spacing-correction ,number? "Factor for the optical correction amount for kneed beams. Set between 0 for no correction and @@ -275,7 +298,7 @@ of printing objects. Objects in lower layers are overprinted by objects in higher layers.") (ledger-line-thickness ,number-pair? "The thickness of ledger lines: it is the -sum of 2 numbers. The first is the factor for linethickness, and the +sum of 2 numbers. The first is the factor for line thickness, and the second for staff space. Both contributions are added.") (left-position ,number? "Vertical position of left part of spanner.") (left-padding ,ly:dimension? "The amount of space that is put @@ -291,12 +314,12 @@ measure. Used in some spacing situations.") (measure-count ,integer? "The number of measures for a multimeasure rest.") (merge-differently-headed ,boolean? "Merge -noteheads in collisions, even if they have different note heads. The +note heads in collisions, even if they have different note heads. The smaller of the two heads will be rendered invisible. This used polyphonic guitar notation. The value of this setting is used by @internalsref{note-collision-interface} .") - (merge-differently-dotted ,boolean? "Merge noteheads in + (merge-differently-dotted ,boolean? "Merge note heads in collisions, even if they have a different number of dots. This normal notation for some types of polyphonic music. ") @@ -312,8 +335,15 @@ this long. This requires an appropriate routine for the should move (after padding).") (print-function ,procedure? "Function taking grob as argument, returning a @code{Stencil} object.") + (neutral-direction ,ly:dir? "Which direction to take in the +center of the staff.") + (neutral-position ,number? "Position (in half staff spaces) where +to flip the direction of custos stem.") + (new-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})} pairs.") + (note-names ,vector? "Vector of strings containing names for +easy-notation note heads.") (no-spacing-rods ,boolean? "Items with this property do not cause spacing constraints.") (no-stem-extend ,boolean? "If set, notes with ledger lines do not @@ -328,11 +358,15 @@ pairs.}") (padding ,ly:dimension? "Add this much extra space between objects that are next to each other.") - (penalty ,number? "Penalty for breaking at -this column. 10000 or more means forbid linebreak, -10000 or less -means force linebreak. Other values influence linebreaking decisions + (page-penalty ,number? "Penalty for page break at +this column. 10000 or more means forbid linebreak, -10000 or less +means force page break. Other values influence page breaking decisions as a real penalty.") - + (penalty ,number? "Penalty for line break at +this column. 10000 or more means forbid line break, -10000 or less +means force line break. Other values influence line breaking decisions +as a real penalty.") + (pitch-max ,ly:pitch? "Top pitch for ambitus.") (pitch-min ,ly:pitch? "Bottom pitch for ambitus.") @@ -362,7 +396,7 @@ text-spanner on both sides, for example a pedal bracket") "The most common shortest note length. This is used in spacing. Enlarging this will set the score tighter.") (shortest-duration-space ,ly:dimension? "Start with this much -space for the shortest duration. This is explessed in +space for the shortest duration. This is expressed in @code{spacing-increment} as unit. See also @internalsref{spacing-spanner-interface}.") (shortest-playing-duration ,ly:moment? "The duration of the shortest playing here.") @@ -372,12 +406,13 @@ note that starts here.") "Multiply direction of @code{direction-source} with this to get the direction of this object.") + (size ,number? "Size of object, relative to standard size.") (slope ,number? "The slope of this object.") (slope-limit ,number? "Set slope to zero if slope is running away steeper than this.") (space-alist ,list? "A table that specifies distances between -prefatory itmes, like clef and time-signature. The format is an alist +prefatory items, like clef and time-signature. The format is an alist of spacing tuples: @code{(@var{break-align-symbol} @var{type} . @var{distance})}, where @var{type} can be the symbols @code{minimum-space} or @code{extra-space}.") @@ -401,7 +436,7 @@ staff spaces, counted from the middle line.") staff lines.") (stem-attachment-function ,procedure? "A function that calculates -where a stem attaches to the notehead? This is a fallback when this +where a stem attaches to the note head? This is a fallback when this information is not specified in the font. The function takes a grob and axis argument, and returns a (@var{x} . @var{y}) pair, specifying location in terms of note head bounding box.") @@ -417,10 +452,12 @@ of flags/beams.") stems that are placed in tight configurations. For opposite directions, this amount is the correction for two normal sized stems that overlap completely.") + (string-count ,integer? "The number of strings in a fret diagram.") (style ,symbol? "This setting determines in what style a grob is typeset. Valid choices depend on the @code{print-function} that is reading this property.") (text ,markup? "Text markup. See @usermanref{Text markup}.") +;;FIXME -- Should both be the same? (thick-thickness ,number? "Bar line thickness, measured in @code{linethickness}.") (thickness ,number? "Bar line thickness, measured in @@ -456,9 +493,9 @@ happen?") (word-space ,ly:dimension? "space to insert between lyrics or words in texts.") (width ,ly:dimension? "The width of a grob measured in staff space.") - (x-gap ,ly:dimension? "The horizontal gap between notehead and tie.") + (x-gap ,ly:dimension? "The horizontal gap between note head and tie.") (y-free ,ly:dimension? "The minimal vertical gap between slur and -noteheads or stems.") +note heads or stems.") (y-offset ,ly:dimension? "Extra vertical offset for ties away from the center line.") (zigzag-length ,ly:dimension? "The length of the lines of a @@ -499,6 +536,7 @@ sizes (like the dynamic @b{p} and @b{f}) on their baselines.") (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.") (all-elements ,grob-list? "list of all grobs in this line. Its function is to protect objects from being garbage collected.") + (ambituses ,grob-list? "list of Ambitus objects") (arpeggio ,ly:grob? "pointer to arpeggio object.") (beam ,ly:grob? "pointer to the beam, if applicable.") (center-element ,ly:grob? "grob which will be at the center of @@ -515,13 +553,15 @@ set, which grob to get the direction from .") (rest ,ly:grob? "the staff symbol grob that we're in.") (rest-collision ,ly:grob? "rest collision that a rest is in.") (accidental-grob ,ly:grob? "Accidental for this note.") - (bars ,grob-list? "list of barline pointers.") + (bars ,grob-list? "list of bar line pointers.") (bounded-by-me ,grob-list? "list of spanners that have this column as start/begin point. Only columns that have grobs or act as bounds are spaced.") (columns ,grob-list? "list of grobs, typically containing paper-columns or note-column objects.") (conditional-elements ,grob-list? "Internal use only") (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.") + (encompass-objects ,grob-list? "Objects that a slur should avoid +in addition to notes and stems.") (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.") (heads ,grob-list? "List of note heads.") (items-worth-living ,grob-list? "A list of interesting items. If @@ -561,7 +601,7 @@ entries @code{name} and @code{interfaces}.") (chord-tremolo ,boolean? "if set, this beam is a tremolo. ") (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.") (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.") - (quant-score ,number? "Beam quanting score -- can be stored for + (quant-score ,string? "Beam quanting score -- can be stored for debugging") (least-squares-dy ,number? "ideal beam slope, without damping.") @@ -613,7 +653,7 @@ than a whole rest.") (deminutum ,boolean? "is this neume deminished?") (flexa-height ,ly:dimension? "height of a flexa shape in a ligature grob in staff_space.") (flexa-width ,ly:dimension? "width of a flexa shape in a ligature grob in staff_space.") - (join-heads ,boolean? "Whether to join the noteheads of an ambitus grob with a vertical line.") + (join-heads ,boolean? "Whether to join the note heads of an ambitus grob with a vertical line.") (linea ,boolean? "attach vertical lines to this neume?")