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.")
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-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
(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.")
(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?
- (neutral-position ,number? "Position (in half staff spaces) where
-to flip the direction of stems: by default, custodes above this
-position get their stems downwards; custodes below this position get
-their stems upwards. A value of 0 designates the center of the staff.
-Use property neutral-direction to control the behaviour of stems on
-the neutral position itself. (Note: currently, neutral-position is
-supported only for custodes; for stems of note heads, neutral-position
-is currently fixed to 0, i.e. the middle of the staff.)")
(dir-function ,procedure? "The function to determine the
direction of a beam. Choices include:
(direction ,ly:dir? "Up or down, left or right?")
(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
;; 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.
")
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{music}, @code{number}, @code{text},
+@code{math}, @code{braces}, @code{dynamic}")
(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}.")
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.")
of note-column for horizontal shifting. This is used by
@internalsref{note-collision-interface}.")
(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
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
(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. ")
returning a @code{Stencil} object.")
(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
means force linebreak. Other values influence linebreaking decisions
as a real penalty.")
- (pitch-max ,ly:pitch? "FIXME, JUNKME")
- (pitch-min ,ly:pitch? "FIXME, JUNKME")
+ (pitch-max ,ly:pitch? "Top pitch for ambitus.")
+ (pitch-min ,ly:pitch? "Bottom pitch for ambitus.")
(positions ,pair?
"Pair of staff coordinates @code{(@var{left}
"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.")
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}.")
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.")
(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
zigzags.")
(zigzag-width ,ly:dimension? "The width of one
zigzag-squiggle. This number will be adjusted slightly so that the
-line can be constructed from a whole number of squiggles.")
+glissando line can be constructed from a whole number of squiggles.")
(avoid-note-head ,boolean? "If set, the stem of a chord does not
pass through all note heads, but starts at the last note head. ")
(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
(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?")
;; end ancient notation
+ ; ugh.
+ (accidentals-style ,symbol? "style for ambitus.")
)))