X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fgrob-property-description.scm;h=d8d36e5467530fae7b6a3289ed114cda35cc9889;hb=ae939e9a972d20f0c16d136a992f92c0daebb276;hp=22fc2fc0d2e9175b63b863e756d38c83d473184c;hpb=21d5a9c520f4bfcd19ab99243706f006f96aabef;p=lilypond.git diff --git a/scm/grob-property-description.scm b/scm/grob-property-description.scm index 22fc2fc0d2..d8d36e5467 100644 --- a/scm/grob-property-description.scm +++ b/scm/grob-property-description.scm @@ -45,9 +45,6 @@ This procedure is called (using dependency resolution) after line breaking. Retu (grob-property-description 'arch-height number? "height of the hook of a system brace.") (grob-property-description 'arch-thick number? "thickness of the hook of system brace.") (grob-property-description 'arch-width number? "width of the hook of a system brace.") -(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 'arpeggio ly-grob? "pointer to arpeggio object.") (grob-property-description 'arpeggio-direction dir? "If set, put an arrow on the arpeggio squiggly line.") @@ -65,6 +62,8 @@ 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 'bars list? "list of barline pointers.") (grob-property-description 'bar-size-procedure procedure? "Procedure that computes the size of a bar line.") +(grob-property-description 'base-shortest-duration 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.") (grob-property-description 'baseline-skip number? "Baseline skip to use for multiple lines of text.") (grob-property-description 'bass list? " musical-pitch, optional.") (grob-property-description 'beam ly-grob? "pointer to the beam, if applicable.") @@ -87,7 +86,7 @@ column as start/begin point. Only columns that have grobs or act as bounds are s (grob-property-description 'break-glyph-function procedure? "function taking glyph and break-direction, returning the glyph at a line break.") (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-size integer? "size of cautionary accidentals (relative to size of accidentals)") +(grob-property-description 'cautionary-style symbol? "style of cautionary accidentals. Choices are 'smaller (one size smaller) or 'parentheses.") (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). .") @@ -133,9 +132,8 @@ mean centre distance weighted per note (grob-property-description 'dot ly-grob? "reference to Dots object.") (grob-property-description 'dot-count integer? "number of dots.") (grob-property-description 'duration-log integer? "2-log of the notehead duration, i.e. 0=whole note, 1 = half note, etc.") - (grob-property-description 'edge-height pair? "a cons that specifies the heights of the vertical edges '(LEFT-height . RIGHT-height).") -(grob-property-description 'edge-width pair? "a cons that specifies the widths of the slanted edges '(LEFT-width . RIGHT-width).") +(grob-property-description 'edge-widen pair? "a cons that specifies the widths of the slanted edges '(LEFT-width . RIGHT-width).") (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 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.") @@ -206,7 +204,7 @@ For barline, space after a thick line.") (grob-property-description 'right-head ly-grob? "") (grob-property-description 'left-head ly-grob? "") -(grob-property-description 'left-widen boolean? "Whether the left edge of a piano pedal bracket should be widened by the first element of edge-width.") +(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.") @@ -223,7 +221,17 @@ and will have no effect. (grob-property-description 'measure-length moment? "Length of a measure. Used in some spacing situations.") (grob-property-description 'measure-count integer? "number of measures for a multimeasure rest.") -(grob-property-description 'merge-differently-dotted boolean? " Merge noteheads in collisions, even if they have a different number of 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 'merge-differently-headed boolean? "Merge +noteheads 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 +@ref{note-collision-interface} .") + +(grob-property-description 'merge-differently-dotted boolean? " Merge +noteheads in collisions, even if they have a different number of +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 'minimum-distance number? "minimum distance between notes and rests.") @@ -254,13 +262,10 @@ FIXME: also pair? (cons LEFT RIGHT) (grob-property-description 'no-spacing-rods boolean? "read from grobs: boolean that makes Separation_item ignore this item (MOVE ME TO ITEM).") (grob-property-description 'no-stem-extend boolean? "should stem not be extended to middle staff line?.") (grob-property-description 'non-default boolean? "not set because of existence of a bar?.") -(grob-property-description 'note-width number? "unit for horizontal translation, measured in staff-space.") (grob-property-description 'note-heads list? "List of note head grobs") (grob-property-description 'number-threshold number? "only put numbers bigger than this threshold over multi measuer rest.") (grob-property-description 'old-accidentals list? "list of (pitch, accidental) pairs.") (grob-property-description 'padding number? "add this much extra space between objects that are next to each other.") -(grob-property-description 'paren-cautionaries boolean? "Whether to add parenthesis around cautionary accidentals.") - (grob-property-description 'pedal-type symbol? "Style of piano pedal: text, bracket or mixed.") (grob-property-description 'penalty number? "Penalty for breaking at this column. 10000 or more means forbid linebreak, -10000 or less @@ -273,7 +278,7 @@ as a real penalty.") (grob-property-description 'raise number? "height for text to be raised (a negative value lowers the text.") (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-width") +(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 'script-priority number? "A sorting key that determines in what order a script is within a stack of scripts.") (grob-property-description 'self-alignment-X number-or-grob? "real number: -1 = left aligned, 0 = center, 1 right-aligned in X direction. @@ -286,7 +291,9 @@ TODO: revise typing.") (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 '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 'shortest-playing-duration moment? "duration of the shortest playing in that column.") (grob-property-description 'shortest-starter-duration moment? "duration of the shortest notes that starts exactly in this column.") (grob-property-description 'side-relative-direction dir? "if set: get the direction from a different object, and multiply by this.") @@ -399,7 +406,12 @@ print only if there is no beam associated with this tuplet bracket.") (grob-property-description 'number-visibility boolean-or-symbol? " Like @code{bracket-visibility}, but for the number.") (grob-property-description 'tie ly-grob? "") -(grob-property-description 'type symbol? "one of: line, dashed-line or dotted-line.") +(grob-property-description 'type symbol? " + +one of: line, dashed-line, trill or dotted-line. + +[FIXME: type is too generic for this doc, move doco to intefrace] +") (grob-property-description 'visibility-lambda procedure? "a function that takes the break direction and returns a cons of booleans containing (TRANSPARENT . EMPTY).") (grob-property-description 'when moment? "when does this column happen?.") (grob-property-description 'word-space number? "elongate left by this much (FIXME: cumbersome semantics).") @@ -458,3 +470,6 @@ functions set spanner positions.") (grob-property-description 'chord-name-function procedure? "DOCME") (grob-property-description 'minimum-beam-collision-distance number? "Minimum distance to beam for a rest collision.") + +(grob-property-description 'avoid-note-head boolean? "if set, the stem of a chord does not pass through all note head, but start at the last note head. Used by tablature.") +(grob-property-description 'up-to-staff boolean? "if set, stems' lengths are set so as stems end out of the staff. Used by tablature.")