X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=f42f0e8edbe3dfc7e9742c0563e6b4b58b128275;hb=10218a6a784ad4d48a64a9bee1e391d64621d8fc;hp=6434c15c4687cf5f0710d999200985112d1d2f2e;hpb=94345c6367d9e6a7dac6711cbb81845e8e889db5;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index 6434c15c46..f42f0e8edb 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -31,9 +31,9 @@ (apply define-grob-property x)) `( -;; -;; a -;; +;;; +;;; a +;;; (add-stem-support ,boolean? "If set, the @code{Stem} object is included in this script's support.") (after-line-breaking ,boolean? "Dummy property, used to trigger @@ -79,9 +79,9 @@ and @code{around} behave like @code{ignore}.") grobs, this should contain only one number.") -;; -;; b -;; +;;; +;;; b +;;; (bar-extent ,number-pair? "The Y-extent of the actual bar line. This may differ from @code{Y-extent} because it does not include the dots in a repeat bar line.") @@ -168,11 +168,9 @@ stick out of its bounds?") (broken-bound-padding ,number? "The amount of padding to insert when a spanner is broken at a line break.") -;; -;; c -;; - (c0-position ,integer? "An integer indicating the position of -middle@tie{}C.") +;;; +;;; c +;;; (circled-tip ,boolean? "Put a circle at start/@/end of hairpins (al/@/del niente).") (clip-edges ,boolean? "Allow outward pointing beamlets at the @@ -205,9 +203,9 @@ this should list the control points of a third-order B@'ezier curve.") receives this number. The following measures are numbered in increments from this initial value.") -;; -;; d -;; +;;; +;;; d +;;; (damping ,number? "Amount of beam slope damping.") (dash-definition ,pair? "List of @code{dash-elements} defining the dash structure. Each @code{dash-element} has a starting t value, @@ -248,9 +246,9 @@ elements closer together.") i.e., @code{0} = whole note, @code{1} = half note, etc.") -;; -;; e -;; +;;; +;;; e +;;; (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.") (edge-height ,pair? "A pair of numbers specifying the heights of @@ -282,9 +280,9 @@ item). In order to make a grob take up no horizontal space at all, set this to @code{(+inf.0 . -inf.0)}.") -;; -;; f -;; +;;; +;;; f +;;; (flag-count ,number? "The number of tremolo beams.") (flat-positions ,list? "Flats in key signatures are placed within the specified ranges of staff-positions. The general form @@ -423,9 +421,9 @@ read from the NonMusicalPaperColumn that begins the measure.") (full-size-change ,boolean? "Don't make a change clef smaller.") -;; -;; g -;; +;;; +;;; g +;;; (gap ,ly:dimension? "Size of a gap in a variable symbol.") (gap-count ,integer? "Number of gapped beams for tremolo.") (glissando-skip ,boolean? "Should this @code{NoteHead} be skipped @@ -446,9 +444,9 @@ etc. are already taken.") (grow-direction ,ly:dir? "Crescendo or decrescendo?") -;; -;; h -;; +;;; +;;; h +;;; (hair-thickness ,number? "Thickness of the thin line in a bar line.") (harp-pedal-details ,list? "An alist of detailed grob properties @@ -499,9 +497,9 @@ of @code{NoteColumn}s for horizontal shifting. This is used by left and one to the right of this grob.") -;; -;; i -;; +;;; +;;; i +;;; (id ,string? "An id string for the grob. Depending on the typestting backend being used, this id will be assigned to a group containing all of the stencils that comprise a given grob. For example, in the svg backend, @@ -518,9 +516,9 @@ configuration to this index, and print the respective scores.") slur quants to this position, and print the respective scores.") -;; -;; k -;; +;;; +;;; k +;;; (keep-inside-line ,boolean? "If set, this column cannot have objects sticking into the margin.") (kern ,ly:dimension? "Amount of extra white space to add. For @@ -531,9 +529,9 @@ correction amount for kneed beams. Set between @code{0} for no correction and @code{1} for full correction.") -;; -;; l -;; +;;; +;;; l +;;; (labels ,list? "List of labels (symbols) placed on a column.") (layer ,integer? "An integer which determines the order of printing objects. Objects with the lowest value of layer are drawn first, then @@ -572,9 +570,9 @@ contour.") (long-text ,markup? "Text markup. See @ruser{Formatting text}.") -;; -;; m -;; +;;; +;;; m +;;; (max-beam-connect ,integer? "Maximum number of beams to connect to beams from this stem. Further beams are typeset as beamlets.") (max-stretch ,number? "The maximum amount that this @@ -615,9 +613,9 @@ X@tie{}dimension, measured in @code{staff-space} units.") Y@tie{}dimension, measured in @code{staff-space} units.") -;; -;; n -;; +;;; +;;; n +;;; (neutral-direction ,ly:dir? "Which direction to take in the center of the staff.") (neutral-position ,number? "Position (in half staff spaces) where @@ -668,9 +666,9 @@ between 0 and 1.") easy-notation note heads.") -;; -;; o -;; +;;; +;;; o +;;; (outside-staff-horizontal-padding ,number? "By default, an outside-staff-object can be placed so that is it very close to another grob horizontally. If this property is set, the outside-staff-object @@ -702,9 +700,9 @@ of a potential collision, the grob with the smaller @code{outside-staff-priority} is closer to the staff.") -;; -;; p -;; +;;; +;;; p +;;; (packed-spacing ,boolean? "If set, the notes are spaced as tightly as possible.") (padding ,ly:dimension? "Add this much extra space between @@ -737,9 +735,9 @@ dot.") (protrusion ,number? "In an arpeggio bracket, the length of the horizontal edges.") -;; -;; r -;; +;;; +;;; r +;;; (ratio ,number? "Parameter for slur shape. The higher this number, the quicker the slur attains its @code{height-limit}.") (remove-empty ,boolean? "If set, remove group if it contains no @@ -767,9 +765,9 @@ rest when the length of a measure is between two values of in a 3/2 measure.") -;; -;; s -;; +;;; +;;; s +;;; (same-direction-correction ,number? "Optical correction amount for stems that are placed in tight configurations. This amount is used for stems with the same direction to compensate for note head to @@ -945,11 +943,11 @@ typeset. Valid choices depend on the @code{stencil} callback reading this property.") -;; -;; t -;; +;;; +;;; t +;;; (text ,markup? "Text markup. See @ruser{Formatting text}.") -;;FIXME -- Should both be the same? + ;;FIXME -- Should both be the same? (text-direction ,ly:dir? "This controls the ordering of the words. The default @code{RIGHT} is for roman text. Arabic or Hebrew should use @code{LEFT}.") @@ -961,8 +959,8 @@ should use @code{LEFT}.") (tie-configuration ,list? "List of @code{(@var{position} . @var{dir})} pairs, indicating the desired tie configuration, where @var{position} is the offset from the center of the staff in staff -space and @var{dir} indicates the direction of the tie -(@code{1}=>up, @w{@code{-1}}=>down, @code{0}=>center). A non-pair entry +space and @var{dir} indicates the direction of the tie (@code{1}=>up, +@w{@code{-1}}=>down, @code{0}=>center). A non-pair entry in the list causes the corresponding tie to be formatted automatically.") (to-barline ,boolean? "If true, the spanner will stop at the bar @@ -975,9 +973,9 @@ possible.") (transparent ,boolean? "This makes the grob invisible.") -;; -;; u -;; +;;; +;;; u +;;; (uniform-stretching ,boolean? "If set, items stretch proportionally to their durations. This looks better in complex polyphonic patterns.") @@ -988,15 +986,15 @@ can be used in typesetting the grob.") (use-skylines ,boolean? "Should skylines be used for side positioning?") -;; -;; v -;; +;;; +;;; v +;;; (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and one below this grob.") -;; -;; w -;; +;;; +;;; w +;;; (when ,ly:moment? "Global time step associated with this column happen?") (whiteout ,boolean? "If true, the grob is printed over a white @@ -1008,9 +1006,9 @@ space.") texts.") -;; -;; x -;; +;;; +;;; x +;;; (X-extent ,number-pair? "Hard coded extent in X@tie{}direction.") (X-offset ,number? "The horizontal amount that this object is moved relative to its X-parent.") @@ -1019,16 +1017,16 @@ in the form @code{(@var{left} . @var{right})}, where both @var{left} and @var{right} are in @code{staff-space} units of the current staff.") -;; -;; y -;; +;;; +;;; y +;;; (Y-extent ,number-pair? "Hard coded extent in Y@tie{}direction.") (Y-offset ,number? "The vertical amount that this object is moved relative to its Y-parent.") -;; -;; z -;; +;;; +;;; z +;;; (zigzag-length ,ly:dimension? "The length of the lines of a zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1} gives 60-degree zigzags.") @@ -1077,6 +1075,8 @@ column as start/@/begin point. Only columns that have grobs or act as bounds are spaced.") (bracket ,ly:grob? "The bracket for a number.") + (c0-position ,integer? "An integer indicating the position of +middle@tie{}C.") (columns ,ly:grob-array? "An array of grobs, typically containing @code{PaperColumn} or @code{NoteColumn} objects.") (concurrent-hairpins ,ly:grob-array? "All concurrent hairpins.")