X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-grob-properties.scm;h=0acc741f1cb93ad13ffa151b8fafc745df9037f0;hb=8cf69a467ad7650f5ca9da6fe2dfd4c7c088b239;hp=fc8c86c5a3241095e2eaf408abccd3130442561a;hpb=a3fc862086a720201e4a4764c7beb952fab5f106;p=lilypond.git diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm index fc8c86c5a3..0acc741f1c 100644 --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@ -327,6 +327,7 @@ approximately 12% larger; 6@tie{}steps are exactly a factor@tie{}2 larger. If the context property @code{fontSize} is set, its value is added to this before the glyph is printed. Fractional values are allowed.") + (font-features ,list? "Opentype features.") (footnote ,boolean? "Should this be a footnote or in-note?") (footnote-music ,ly:music? "Music creating a footnote.") (footnote-text ,markup? "A footnote for the grob.") @@ -372,6 +373,9 @@ Default @code{none} for markup fret diagrams, @code{below-string} for @item @code{fret-count} -- The number of frets. Default@tie{}4. @item +@code{fret-distance} -- Multiplier to adjust the distance between frets. +Default@tie{}1.0. +@item @code{fret-label-custom-format} -- The format string to be used label the lowest fret number, when @code{number-type} equals to @code{custom}. Default@tie{}\"~a\". @@ -412,6 +416,9 @@ Default @code{normal}. @item @code{string-count} -- The number of strings. Default@tie{}6. @item +@code{string-distance} -- Multiplier to adjust the distance between strings. +Default@tie{}1.0. +@item @code{string-label-font-mag} -- The magnification of the font used to label fingerings at the string, rather than in the dot. Default value 0.6 for @code{normal} orientation, 0.5 for @code{landscape} and @@ -524,13 +531,7 @@ left and one to the right of this grob.") ;;; ;;; 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, -the string will be assigned to the @code{id} attribute of a group () -that encloses the stencils that comprise the grob. In the Postscript -backend, as there is no way to group items, the setting of the id property -will have no effect.") + (id ,string? "An id string for the grob.") (ignore-ambitus ,boolean? "If set, don't consider this notehead for ambitus calculation.") (ignore-collision ,boolean? "If set, don't do note collision @@ -575,8 +576,13 @@ lines for.") lines. It is the sum of 2@tie{}numbers: The first is the factor for line thickness, and the second for staff space. Both contributions are added.") - (ledger-positions ,list? "Repeating pattern for the vertical positions -of ledger lines. Bracketed groups are always shown together.") + (ledger-positions ,list? "Vertical positions of ledger lines. +When set on a @code{StaffSymbol} grob it defines a repeating +pattern of ledger lines and any parenthesized groups will always be +shown together.") + (ledger-positions-function ,scheme? "A quoted Scheme procedure that +takes a @code{StaffSymbol} grob and the vertical position of a note head +as arguments and returns a list of ledger line positions.") (left-bound-info ,list? "An alist of properties for determining attachments of spanners to edges.") (left-padding ,ly:dimension? "The amount of space that is put @@ -610,11 +616,10 @@ visual output is influenced by changes to ;;; (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 -@code{VerticalAxisGroup} can be vertically stretched (for example, in -order to better fill a page).") (maximum-gap ,number? "Maximum value allowed for @code{gap} property.") + (max-symbol-separation ,number? "The maximum distance between +symbols making up a church rest.") (measure-count ,integer? "The number of measures for a multi-measure rest.") (measure-length ,ly:moment? "Length of a measure. Used in some @@ -673,7 +678,7 @@ object.") get stems extending to the middle staff line.") (non-break-align-symbols ,list? "A list of symbols that determine which NON-break-aligned interfaces to align this to.") - (non-default ,boolean? "Set for manually specified clefs.") + (non-default ,boolean? "Set for manually specified clefs and keys.") (non-musical ,boolean? "True if the grob belongs to a @code{NonMusicalPaperColumn}.") (nonstaff-nonstaff-spacing ,list? "The spacing alist @@ -706,6 +711,11 @@ over the total spanner, where the width of the spanner is normalized between 0 and 1.") (note-names ,vector? "Vector of strings containing names for easy-notation note heads.") + (note-collision-threshold ,ly:dimension? "Simultaneous notes that +are this close or closer in units of @code{staff-space} will be +identified as vertically colliding. Used by @code{Stem} grobs for notes +in the same voice, and @code{NoteCollision} grobs for notes in +different voices. Default value@tie{}1.") (number-type ,symbol? "Numbering style. Choices include @code{roman-lower}, @code{roman-upper} and @code{arabic}.") @@ -713,6 +723,14 @@ easy-notation note heads.") ;;; ;;; o ;;; + (output-attributes ,list? "An alist of attributes for the grob, to +be included in output files. When the SVG typesetting backend is used, +the attributes are assigned to a group () containing all of the +stencils that comprise a given grob. For example, +@code{'((id . 123) (class . foo) (data-whatever . @qq{bar}))} will produce +@code{ @dots{} }. +In the Postscript backend, where there is no way to group items, the +setting of the output-attributes property will have no effect.") (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 @@ -802,12 +820,16 @@ number, the quicker the slur attains its @code{height-limit}.") interesting items.") (remove-first ,boolean? "Remove the first staff of an orchestral score?") - (remove-layer ,integer? "The @code{Keep_alive_together_engraver} -removes all @code{VerticalAxisGroup} grobs with a @code{remove-layer} -larger than the smallest retained @code{remove-layer}. Set to -@code{#f} to make a layer invisible to the -@code{Keep_alive_together_engraver}, set to @code{'()} to have it not -participate in the layering decisions.") + (remove-layer ,key? "When set as a positive integer, the +@code{Keep_alive_together_engraver} removes all +@code{VerticalAxisGroup} grobs with a @code{remove-layer} larger than +the smallest retained @code{remove-layer}. Set to @code{#f} to make a +layer independent of the @code{Keep_alive_together_engraver}. Set to +@code{'()}, the layer does not participate in the layering decisions. +The property can also be set as a symbol for common behaviors: +@code{#'any} to keep the layer alive with any other layer in the +group; @code{#'above} or @code{#'below} to keep the layer alive with +the context immediately before or after it, respectively.") (replacement-alist ,list? "Alist of strings. The key is a string of the pattern to be replaced. The value is a string of what should be displayed. Useful for ligatures.") @@ -862,9 +884,10 @@ of the staff-position at which each clef places C: If the list contains a single element it applies for all clefs. A single number in place of a pair sets accidentals within the octave ending at that staff-position.") - (shorten-pair ,number-pair? "The lengths to shorten a -text-spanner on both sides, for example a pedal bracket. Positive -values shorten the text-spanner, while negative values lengthen it.") + (shorten-pair ,number-pair? "The lengths to shorten on both sides +a hairpin or text-spanner such as a pedal bracket. Positive values +shorten the hairpin or text-spanner, while negative values lengthen +it.") (shortest-duration-space ,number? "Start with this multiple of @code{spacing-increment} space for the shortest duration. See also @rinternals{spacing-spanner-interface}.") @@ -881,7 +904,8 @@ placed vertically.") object.") (simple-Y ,boolean? "Should the Y placement of a spanner disregard changes in system heights?") - (size ,number? "Size of object, relative to standard size.") + (size ,number? "The ratio of the size of the object to its default +size.") (skip-quanting ,boolean? "Should beam quanting be skipped?") (skyline-horizontal-padding ,number? "For determining the vertical distance between two staves, it is possible to have a @@ -984,7 +1008,7 @@ override: \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar) @end example") - (spanner-id ,string? "An identifier to distinguish concurrent spanners.") + (spanner-id ,key? "An identifier to distinguish concurrent spanners.") (springs-and-rods ,boolean? "Dummy variable for triggering spacing routines.") (stacking-dir ,ly:dir? "Stack objects in which direction?") @@ -1141,16 +1165,18 @@ one below this grob.") ;;; (when ,ly:moment? "Global time step associated with this column.") (whiteout ,boolean-or-number? "If a number or true, the grob is -printed over a white background that follows the outline of the stencil, -if the grob is visible. A number sets the thickness of the outline as a -multiple of the staff-line thickness. For compatibility with former -behavior (now available with @code{whiteout-box}) the value @code{#t} is -treated as @code{3.0}. Usually @code{#f} by default.") - (whiteout-box ,boolean-or-number? "If a number or true, the grob -is printed over a rectangular white background to white-out underlying -material, if the grob is visible. A number indicates how far the -outline extends beyond the bounding box of the grob as a multiple of -the staff-line thickness. Usually @code{#f} by default.") +printed over a white background to white-out underlying material, if +the grob is visible. A number indicates how far the white background +extends beyond the bounding box of the grob as a multiple of the +staff-line thickness. The @code{LyricHyphen} grob uses a special +implementation of whiteout: A positive number indicates how far the +white background extends beyond the bounding box in multiples of +@code{line-thickness}. The shape of the background is determined by +@code{whiteout-style}. Usually @code{#f} by default. ") + (whiteout-style ,symbol? "Determines the shape of the +@code{whiteout} background. Available are @code{'outline}, +@code{'rounded-box}, and the default @code{'box}. There is one +exception: Use @code{'special} for @code{LyricHyphen}.") (width ,ly:dimension? "The width of a grob measured in staff space.") (word-space ,ly:dimension? "Space to insert between words in @@ -1229,6 +1255,7 @@ for positioning elements that align with a column.") column as start/@/begin point. Only columns that have grobs or act as bounds are spaced.") (bracket ,ly:grob? "The bracket for a number.") + (bracket-text ,ly:grob? "The text for an analysis bracket.") (c0-position ,integer? "An integer indicating the position of middle@tie{}C.")