;; put this in an alist?
-(grob-property-description 'X-extent-callback procedure? "procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob.")
-(grob-property-description 'X-offset-callbacks list? "list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first.")
+(grob-property-description 'X-extent-callback procedure? "procedure taking an grob and axis argument, returning a number-pair. The return value is the extent of the grob.
+
+The size of a grob are determined through callbacks, settable with
+grob properties @code{X-extent-callback} and @code{Y-extent-callback}.
+There can be only one extent-callback for each axis. No callback
+(Scheme value @code{#f}) means: `empty in this direction'. If you fill
+in a pair of numbers, that pair hard-codes the extent in that
+coordinate.
+")
+(grob-property-description 'X-offset-callbacks list? "list of functions, each taking an grob and axis argument. The function determine the position relative to this grob's parent. The last one in the list is called first.
+
+Offsets of grobs are relative to a parent reference point. Most
+positions are not known when an object is created, so these are
+calculated as needed. This is done by adding a callback for a specific
+direction.
+
+Offset callbacks can be stacked, i.e.
+
+@example
+ \property .... \override #'Y-offset-callbacks = #(list
+ callback1 callback2 callback3)
+
+@end example
+
+The callbacks will be executed in the order @code{callback3 callback2
+callback1}. This is used for quantized positioning: the staccato dot is
+above or below a note head, and it must not be on a staff-line. To
+achieve this, the staccato dot has two callbacks: one that positions the
+grob above or below the note head, and one that rounds the Y-position of
+the grob to the nearest open space.
+
+
+")
(grob-property-description 'Y-extent-callback procedure? "see @code{X-extent-callback}.")
(grob-property-description 'Y-offset-callbacks list? "see @code{X-offset-callbacks}.")
-(grob-property-description 'accidentals list? "Alist with (PITCH
-. OPTION-LIST) entries. OPTION-LIST can contain 'cautionary, 'natural
-and 'tie-break-reminder
-FIXME: outdated.
-")
+(grob-property-description 'accidental-grobs list? "Alis with (NOTENAME . GROBLIST) entries")
+(grob-property-description 'accidentals list? "List of alteration numbers.")
(grob-property-description 'add-stem boolean? "Add stem to porrectus?.")
(grob-property-description 'adjust-if-on-staffline boolean? "If this grob is on a staff line, adjust its appearance, so that it better fits into the staff. E.g., if set true on stem grobs, flares of mensural flags will always be aligned with the staff lines, regardless if the associated note head is printed on a staff line or inbetween.")
(grob-property-description 'after-line-breaking-callback procedure? "Procedure taking a grob as argument.
attachments to prevent ugly slurs. [fixme: we need more documentation here].
.")
(grob-property-description 'auto-properties boolean? "if true, as many properties of this grob as possible will be determined automatically from the musical context.")
-(grob-property-description 'auto-knee-gap number-or-boolean? "the minimal smallest gap between two adjacent beamed chords for which beam will create auto-knees. Set to false for no auto knees." )
+(grob-property-description 'auto-knee-gap number? "If a gap is found between noteheads
+where a horizontal beam fits that is larger than this number, make a kneed beam.")
(grob-property-description 'axes list? "list of axis numbers.
In the case of alignment grobs, this should contain only one number.")
(grob-property-description 'bar-size number? "size of a bar line.")
(grob-property-description 'beam-thickness number? "thickness, measured in staffspace.")
(grob-property-description 'beam-width number? "width of the tremolo sign.")
(grob-property-description 'beamed-lengths list? "list of stem lengths given beam multiplicity .")
-(grob-property-description 'beamed-minimum-lengths list? "list of minimum stem lengths given beam multiplicity.")
+(grob-property-description 'beamed-minimum-free-lengths list? "list of normal minimum free stem lengths (chord to beams) given beam multiplicity.")
+(grob-property-description 'beamed-extreme-minimum-free-lengths list? "list of extreme minimum free stem lengths (chord to beams) given beam multiplicity.")
(grob-property-description 'beamed-stem-shorten list? "shorten beamed stems in forced direction.")
-(grob-property-description 'beaming number-pair? "number of beams extending to left and right.")
+(grob-property-description 'beaming pair?
+ "Pair of number lists. Each number list
+specifies which beams to make. 0 is the central beam, 1 is the next
+beam toward the note etc. This information is used to determine how to
+connect the beaming patterns from stem to stem inside a beam.")
+
+
(grob-property-description 'beautiful number? "number that dictates when a slur should be de-uglyfied. It correlates with the enclosed area between noteheads and slurs. A value of 0.1 yields only undisturbed slurs, a value of 5 will tolerate quite high blown slurs.")
(grob-property-description 'before-line-breaking-callback procedure? "Procedure taking grob as argument.
This procedure is called (using dependency resolution) before line breaking, but after generating discretionary items. Return value is ignored.")
(grob-property-description 'breakable boolean? "boolean indicating if this is a breakable item (clef, barline, key sig, etc.).")
(grob-property-description 'c0-position integer? "integer indicating the position of central C.")
(grob-property-description 'cautionary-style symbol? "style of cautionary accidentals. Choices are 'smaller (one size smaller) or 'parentheses.")
+(grob-property-description 'cautionary boolean? "is this a cautionary accidentals.?")
+
(grob-property-description 'center-element ly-grob? "grob which will
be at the center of the group after aligning (when using
Align_interface::center_on_element). .")
(grob-property-description 'collapse-height number? "Minimum height of system start delimiter. If equal or smaller, the bracket is removed.")
(grob-property-description 'columns grob-list? "list of grobs, typically containing paper-columns.")
+(grob-property-description 'conditional-elements grob-list? "Internal use only")
(grob-property-description 'control-points list? "List of 4 offsets (number-pairs) that form control points for the tie/slur shape.")
(grob-property-description 'damping integer? "amount of beam slope damping should beam slope be damped? 0: no, 1: yes, 100000: horizontal beams .")
(grob-property-description 'dash-length number? "the length of a dash.")
(grob-property-description '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.)")
(grob-property-description 'dependencies grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
(grob-property-description 'details list? "alist of parameters for detailed grob behavior.")
-(grob-property-description 'dir-forced boolean? "set if direction has been forced; read by Beam.")
(grob-property-description 'dir-function procedure? "function of type (count total)->direction. Default value: beam-dir-majority, also available: beam-dir-mean, beam-dir-median.
The ways to calculate the direction of a beam work as follows:
(grob-property-description 'edge-text pair? "a cons that specifies the texts to be set at the edges '(LEFT-text . RIGHT-text).")
(grob-property-description 'elements grob-list? "list of grobs, type depending on the Grob where this is set in.")
(grob-property-description 'expand-limit integer? "maximum number of measures expanded in church rests.")
-(grob-property-description 'extra-extent-X number-pair? "enlarge in X dimension by this much, measured in staff space.")
-(grob-property-description 'extra-extent-Y number-pair? "see @code{extra-extent-Y}.")
+(grob-property-description 'extra-X-extent number-pair? "enlarge in X dimension by this much, measured in staff space.")
+(grob-property-description 'extra-Y-extent number-pair? "see @code{extra-Y-extent}.")
+(grob-property-description 'X-extent number-pair? "Store extent. internal use only. ")
+(grob-property-description 'Y-extent number-pair? "Store extent. internal use only. ")
(grob-property-description 'extra-offset number-pair? "pair of reals
(a cons) forcing an extra offset before outputting.
@code{extra-offset} is added just before `printing' the grob, so the
typesetting engine is completely oblivious to it.
")
-(grob-property-description 'extra-space number-pair? "pair of distances (cons LEFT RIGHT).")
(grob-property-description 'extremity-offset-alist list? "an alist (attachment stem-dir*dir slur-dir*dir) -> offset. The offset adds to the centre of the notehead, or stem.")
(grob-property-description 'extremity-rules list? "an alist (procedure
slur dir) -> attachment to determine the attachment (see above). If
procedure returns #t, attachment is used. Otherwise, the next
procedure is tried.")
-(grob-property-description 'flag-style string? "turn stroke through stem on/off.")
+(grob-property-description 'flag-style string? "set to \"grace\" to turn stroke through stem on.")
(grob-property-description 'flag-width-function procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
(grob-property-description 'flexa-width number? "width of a flexa shape in a ligature grob.")
(grob-property-description 'font-family symbol? "partial font
is used by @ref{note-collision-interface}.")
(grob-property-description 'fraction number-pair? "fraction of a time signature.")
+(grob-property-description 'french-beaming boolean? "Use French
+beaming style: stems stop at innermost beams.")
(grob-property-description 'full-size-change boolean? "if set, don't make a change clef smaller.")
(grob-property-description 'glyph string? "a string determining what (style) of glyph is typeset. Valid choices depend on the function that is reading this property. .")
(grob-property-description 'hair-thickness number? "thickness, measured in stafflinethickness.")
(grob-property-description 'heads pair? "Pair of grob pointers, pointing to the two heads of the tie.")
(grob-property-description 'height number? "in staffspace.")
+(grob-property-description 'height-limit number? "Maximum slur height,
+ long slurs approach this height.
+
+ For small width w, the height should be proportional to w, for w ->
+ infinity, the height should rise to limit h_infinity asymptotically.
+
+ Hence we take F (x) such that
+@quotation
+@example
+ F (0) = 0 , F' (0) = 1, and F (infinity) = 1
+@end example
+@end quotation
+ where
+@quotation
+@example
+ h = height-limit * F (x * ratio / height-limit)
+@end example
+@end quotation
+ Currently, for F we use
+@quotation
+@example
+ F (x) = 2/pi * atan (pi * x/2)
+@end example
+@end quotation
+")
(grob-property-description 'horizontal-shift integer? "integer that identifies ranking of note-column for horizontal shifting. This is used by @ref{note-collision-interface}.")
(grob-property-description 'ideal-distances list? "(OBJ . (DIST . STRENGTH)) pairs.")
(grob-property-description 'interfaces list? "list of symbols indicating the interfaces supported by this object. Is initialized from the @code{meta} field.")
For text, this is `relative'(?) to the current alignment.
For barline, space after a thick line.")
+(grob-property-description 'knee boolean? "Is this beam a knee?")
+(grob-property-description 'knee-spacing-correction number? "optical correction amount for knees. 0: no correction; 1: full correction.")
(grob-property-description 'layer number? "The output layer [0..2]. The default is 1.")
(grob-property-description 'left-position number? "position of left part of spanner.")
(grob-property-description 'left-widen boolean? "Whether the left edge of a piano pedal bracket should be widened by the first element of edge-widen.")
(grob-property-description 'length number? "Stem length for unbeamed stems, only for user override.")
-(grob-property-description 'lengths list? "Stem length given multiplicity of flag.")
+(grob-property-description 'lengths list? "Stem length given
+multiplicity of flag. The Nth element of the list gives the stem
+length of a note with N flags.
+")
(grob-property-description 'line-count integer? "Number of staff
lines. If you want to override this for staffs individually, you must
use @code{\outputproperty}. @code{\property .. \override} will not
dots. This normal notation for some types of polyphonic music. The
value of this setting is used by @ref{note-collision-interface} .")
-(grob-property-description 'meta list? "Alist of meta information of this grob.")
+(grob-property-description 'meta list? "Alist of meta information of this grob.
+
+The alist contains the following entries: name, interfaces.
+
+
+
+")
(grob-property-description 'minimum-distance number? "minimum distance between notes and rests.")
(grob-property-description 'minimum-distances list? "list of rods (ie. (OBJ . DIST) pairs).")
-(grob-property-description 'minimum-extent-X number-pair? "minimum size in X dimension, measured in staff space.")
-(grob-property-description 'minimum-extent-Y number-pair? "see @code{minimum-extent-Y}.")
+
+(grob-property-description 'minimum-X-extent number-pair? "minimum size in X dimension, measured in staff space.")
+(grob-property-description 'minimum-Y-extent number-pair? "see @code{minimum-Y-extent}.")
(grob-property-description 'minimum-length number? "try to make the
Grob at least this long.
FIXME: also pair? (cons LEFT RIGHT)
")
-(grob-property-description 'minimum-space-pair number-pair? "
-
-? (cons LEFT RIGHT)
-
+(grob-property-description 'molecule-callback procedure? "Function
+taking grob as argument, returning a smobbed Molecule.
+
+All visible, i.e. non-transparent, grobs have a callback to create a
+Molecule. The callback should be a Scheme function taking one argument
+(the grob) and returning a Molecule. Most molecule callbacks are
+written in C++, but you can also write them in Scheme. An example is
+provided in @code{input/regression/molecule-hacking.ly}.
")
-(grob-property-description 'molecule-callback procedure? "Function taking grob as argument, returning a Scheme encoded Molecule.")
(grob-property-description 'molecule molecule? "Cached output of the molecule-callback.")
(grob-property-description 'pitches list? "list of musical-pitch.")
(grob-property-description 'positions pair? "cons of staff positions (LEFT . RIGHT")
-(grob-property-description 'ragged-right boolean? "In ragged alignment mode (i.e. if paper variable @code{raggedright} is set), rag staff symbols only if this staff symbol grob property is also set.")
(grob-property-description 'raise number? "height for text to be raised (a negative value lowers the text.")
+(grob-property-description 'ratio number? "Slur parameter. See height-limit.")
(grob-property-description 'right-padding number? "space right of accs.")
(grob-property-description 'right-trim-amount number? "shortening of the lyric extender on the right.")
(grob-property-description 'right-widen boolean? "Whether the right edge of a piano pedal bracket should be widened by the second element of edge-widen")
(grob-property-description 'self-alignment-Y number? "like self-alignment-X but for Y axis.")
(grob-property-description 'shorten number? "the amount of space that a stem should be shortened (DOCME!)")
(grob-property-description 'shorten-pair number-pair? "the length on each side to shorten a text-spanner, for example a pedal bracket")
+(grob-property-description 'common-shortest-duration moment?
+ "The most common shortest note length.
+This is used in spacing. Making this larger will make the score tighter.")
(grob-property-description 'shortest-duration-space number? "Start
with this much space for the shortest duration. This is explessed in @code{spacing-increment} as unit. See also
@ref{spacing-spanner-interface}.")
(grob-property-description 'space-function procedure? "return interbeam space given Beam grob and multiplicity.")
(grob-property-description 'spacing-increment number? "Add this much space for a doubled duration. Typically, the width of a note head. See also @ref{spacing-spanner-interface}.")
+(grob-property-description 'spacing-wishes grob-list? "List of note spacing or staff spacing objects.")
(grob-property-description 'spacing-procedure procedure? "procedure
taking grob as argument. This is called after
before-line-breaking-callback, but before the actual line breaking
terms of note head bounding box.")
(grob-property-description 'stem-end-position number? "Where does the stem end (the end is opposite to the support-head.")
-(grob-property-description 'stem-shorten list? "shorten stems in forced directions given flag multiplicity.")
+(grob-property-description 'stem-shorten list? "shorten stems in forced directions given flag multiplicity:
+the Nth element of the list gives the amount stem shortening of a note with N flags.
+")
(grob-property-description 'stem-spacing-correction number? "optical correction amount. [TODO: doco] ")
(grob-property-description 'stems grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
(grob-property-description 'style symbol? "a string determining what style of glyph is typeset. Valid choices depend on the function that is reading this property. .")
[FIXME: type is too generic for this doc, move doco to intefrace]
")
-(grob-property-description 'break-visibility procedure? "a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY).")
+
+(grob-property-description 'break-visibility procedure? "a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY).
+
+
+Some items need special treatment for line breaking. For example, a
+clef is normally only printed at the start of a line (i.e. after a line
+break). To model this, `breakable' items (clef, key signature, bar lines,
+etc.) are copied twice. Then we have three versions of each breakable
+item: one version if there is no line break, one version that is printed
+before the line break (at the end of a system), one version that is
+printed after the line break.
+
+Whether these versions are visible and take up space, is determined by
+the outcome of the @code{break-visibility}. This grob property is a
+function taking a direction (-1, 0 or 1) as argument. It returns a cons
+of booleans, signifying whether this grob should be transparent and have
+no extent.
+
+")
(grob-property-description 'when moment? "when does this column happen?.")
(grob-property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics).")
(grob-property-description 'alignment number? "alignment of lyrics on notehead, -1 is LEFT, 0 is CENTRE, 1 is RIGHT .")
(grob-property-description 'y-free number? "minimal vertical gap between slur and noteheads or stems.")
(grob-property-description 'y-offset number? "extra vertical offset for ties away from the center line.")
-;;;;;;;;;;;;;;;;;;;;
-;;;;;;;;;;;;;;;; INTERNAL
+;;; INTERNAL
(grob-property-description 'left-neighbors grob-list? " List of
spacing-wish grobs that are close to the current column.
projects / lilypond.git / blobdiff