From: Werner Lemberg Date: Sat, 24 Feb 2007 11:42:02 +0000 (+0100) Subject: Merge branch 'master' of ssh+git://git.sv.gnu.org/srv/git/lilypond X-Git-Tag: release/2.11.20-1~2^2^2 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=0b47325d0eece89753b3cbf63b23c4fa614cb8b4;p=lilypond.git Merge branch 'master' of ssh+git://git.sv.gnu.org/srv/git/lilypond Conflicts: scm/define-grob-properties.scm --- 0b47325d0eece89753b3cbf63b23c4fa614cb8b4 diff --cc scm/define-grob-properties.scm index 68f76ea870,4c8cc6ef40..7434de317f --- a/scm/define-grob-properties.scm +++ b/scm/define-grob-properties.scm @@@ -223,123 -176,98 +223,125 @@@ stem. The stem stops at the innermost (fret-count ,integer? "The number of frets in a fret diagram.") ;; ugh: double, change. (full-size-change ,boolean? "Don't make a change clef smaller.") - (non-default ,boolean? "Set for manually specified clefs.") - (glyph ,string? "a string determining what (style) of glyph is -typeset. Valid choices depend on the function that is reading this -property.") + (gap ,ly:dimension? "Size of a gap in a variable symbol.") (gap-count ,integer? "Number of gapped beams for tremolo.") - (glyph-name-alist ,list? "Alist of key-string pairs.") + (glyph ,string? "A string determining what @q{style} of glyph is +typeset. Valid choices depend on the function that is reading this +property.") + (glyph-name-alist ,list? "An alist of key-string pairs.") (grow-direction ,ly:dir? "Crescendo or decrescendo?") - (hair-thickness ,number? "Thickness of the thin line in a bar line.") - (head-direction ,ly:dir? "Are the note heads left or right in a semitie?") - (height ,ly:dimension? "Height of an object in staff-space.") - (height-limit ,ly:dimension? "Maximum slur height: the longer the + + (hair-thickness ,number? "Thickness of the thin line in a bar +line.") + (head-direction ,ly:dir? "Are the note heads left or right in a +semitie?") + (height ,ly:dimension? "Height of an object in +@code{staff-space} units.") + (height-limit ,ly:dimension? "Maximum slur height: The longer the slur, the closer it is to this height.") (horizontal-shift ,integer? "An integer that identifies ranking -of note-column for horizontal shifting. This is used by +of @code{NoteColumn}s for horizontal shifting. This is used by @internalsref{note-collision-interface}.") - (avoid-slur ,symbol? "Method of handling slur collisions. -Choices are @code{around}, @code{inside}, @code{outside}. If unset, script -and slur ignore each other. @code{around} will only move the script if -there is a collision; @code{outside} will always move the script.") - (ignore-collision ,boolean? "If set, don't do note collision resolution on this NoteColumn.") - (infinite-spacing-height ,boolean? "If true, then for the purposes of -horizontal spacing, treat this item as though it were infinitely tall. That -is, no object from another column will be allowed to stick above or below this item.") - (inspect-quants ,number-pair? "If debugging is set, -set beam/slur quant to this position, and print the respective scores.") - (inspect-index ,integer? "If debugging is set, -set beam/slur configuration to this index, and print the respective scores.") ++ (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the ++left and one to the right of this grob.") + + (ignore-collision ,boolean? "If set, don't do note collision +resolution on this @code{NoteColumn}.") (implicit ,boolean? "Is this an implicit bass figure?") - (keep-fixed-while-stretching ,boolean? "A grob with this property set to true will be fixed relative to the staff above it when systems are stretched.") + (infinite-spacing-height ,boolean? "If true, then for the +purposes of horizontal spacing, treat this item as though it were +infinitely tall. That is, no object from another column is allowed to +stick above or below this item.") + (inspect-index ,integer? "If debugging is set, set beam and slur +configuration to this index, and print the respective scores.") + (inspect-quants ,number-pair? "If debugging is set, +set beam and slur quants to this position, and print the respective +scores.") + + (keep-fixed-while-stretching ,boolean? "A grob with this property +set to true is fixed relative to the staff above it when systems are +stretched.") (keep-inside-line ,boolean? "If set, this column cannot have things sticking into the margin.") - (kern ,ly:dimension? "Amount of extra white space to add. For -bar line, this is the amount of space after a thick line.") + (kern ,ly:dimension? "Amount of extra white space to add. For +bar lines, 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 -1 for full correction.") - (label-dir ,ly:dir? "Side to which label is attached. @code{-1} for left, @code{1} for right.") - (layer ,number? "The output layer [0..2]: layers define the order -of printing objects. Objects in lower layers are overprinted by -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 line thickness, and the -second for staff space. Both contributions are added.") - (left-bound-info ,list? "alist of properties for determining attachments of spanners to edges.") +correction amount for kneed beams. Set between @code{0} for no +correction and @code{1} for full correction.") + + (label-dir ,ly:dir? "Side to which a label is attached. +@code{-1} for left, @code{1}@tie{}for right.") + (layer ,number? "The output layer (a value between 0 and@tie{}2: +Layers define the order of printing objects. Objects in lower layers +are overprinted by objects in higher layers.") + (ledger-line-thickness ,number-pair? "The thickness of ledger +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.") + (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 -left to an object (eg. a group of accidentals).") +left to an object (e.g., a group of accidentals).") (length ,ly:dimension? "User override for the stem length of unbeamed stems.") - (length-fraction ,number? "Multiplier for lengths. Used for + (length-fraction ,number? "Multiplier for lengths. Used for determining ledger lines and stem lengths.") - (line-break-system-details ,list? - "Alist of properties to use when this -column is the start of a system.") + (line-break-penalty ,number? "Penalty for a line break at this +column. This affects the choices of the line breaker; it avoids a +line break at a column with a positive penalty and prefer a line break +at a column with a negative penalty.") + (line-break-permission ,symbol? "Instructs the line breaker on +whether to put a line break at this column. Can be @code{force} or +@code{allow}.") + (line-break-system-details ,list? "An alist of properties to use +if this column is the start of a system.") (line-count ,integer? "The number of staff lines.") (line-positions ,list? "Vertical positions of staff lines.") - (line-thickness ,number? "The thickness of the tie/slur contour.") - (long-text ,markup? "Text markup. See @usermanref{Text markup}.") + (line-thickness ,number? "The thickness of the tie or slur +contour.") + (long-text ,markup? "Text markup. See @usermanref{Text +markup}.") + (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 vertical-axis-group -can be vertically stretched (for example, in order to better fill a page).") - (measure-length ,ly:moment? "Length of a -measure. Used in some spacing situations.") +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).") (measure-count ,integer? "The number of measures for a -multimeasure rest.") - (merge-differently-headed ,boolean? "Merge -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-headed only applies to opposing stem dirs -(ie. Voice 1 & 2).") +multi-measure rest.") + (measure-length ,ly:moment? "Length of a measure. Used in some +spacing situations.") (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. -merge-differently-dotted only applies to opposing stem dirs -(ie. Voice 1 & 2).") - (minimum-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.") +collisions, even if they have a different number of dots. This is +normal notation for some types of polyphonic music. + +@code{merge-differently-dotted} only applies to opposing stem +directions (i.e. voice 1 &@tie{}2).") + (merge-differently-headed ,boolean? "Merge note heads in +collisions, even if they have different note heads. The +smaller of the two heads is rendered invisible. This is used in +polyphonic guitar notation. The value of this setting is used by +@internalsref{note-collision-interface}. + +@code{merge-differently-headed} only applies to opposing stem +directions (i.e. voice 1 &@tie{}2).") + (minimum-X-extent ,number-pair? "Minimum size of an object in +X@tie{}dimension, measured in @code{staff-space} units.") + (minimum-Y-extent ,number-pair? "See @code{minimum-X-extent}.") (minimum-distance ,ly:dimension? "Minimum distance between rest and notes or beam.") - (minimum-X-extent ,number-pair? "Minimum size of an object in X -dimension, measured in staff space.") - (minimum-Y-extent ,number-pair? "See @code{minimum-X-extent}.") (minimum-length ,ly:dimension? "Try to make a spanner at least -this long. This requires an appropriate callback for the -@code{springs-and-rods} property. If added to a Tie, this sets the -minimum distance between noteheads.") +this long, normally in the horizontal direction. This requires an +appropriate callback for the @code{springs-and-rods} property. If +added to a @code{Tie}, this sets the minimum distance between +noteheads.") + (minimum-length-fraction ,number? "Minimum length of ledger line +as fraction of note head size.") (minimum-space ,ly:dimension? "Minimum distance that the victim should move (after padding).") + (neutral-direction ,ly:dir? "Which direction to take in the center of the staff.") (neutral-position ,number? "Position (in half staff spaces) where @@@ -418,32 -333,32 +420,30 @@@ stem distance." (script-priority ,number? "A sorting key that determines in what order a script is within a stack of scripts.") (self-alignment-X ,number? "Specify alignment of an object. The -value -1 means left aligned, 0 centered, and 1 right-aligned in X -direction. Values in between may also be specified.") - (self-alignment-Y ,number? "like @code{self-alignment-X} but for -Y axis.") +value @code{-1} means left aligned, @code{0}@tie{}centered, and +@code{1}@tie{}right-aligned in X@tie{}direction. Values in-between +may also be specified.") + (self-alignment-Y ,number? "Like @code{self-alignment-X} but for +the Y@tie{}axis.") (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.") - (clip-edges ,boolean? "Allow outward pointing beamlets at the edges of beams?") - (common-shortest-duration ,ly:moment? - "The most common shortest note length. -This is used in spacing. Enlarging this will set the score tighter.") +text-spanner on both sides, for example a pedal bracket. Positive +values shorten the text-spanner, while negative values lengthen it.") (shortest-duration-space ,ly:dimension? "Start with this much -space for the shortest duration. This is expressed in -@code{spacing-increment} as unit. See also +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.") - (shortest-starter-duration ,ly:moment? "The duration of the shortest -note that starts here.") - (side-relative-direction ,ly:dir? - "Multiply direction of + (shortest-playing-duration ,ly:moment? "The duration of the +shortest playing here.") + (shortest-starter-duration ,ly:moment? "The duration of the +shortest note that starts here.") + (side-axis ,number? "If the value is @code{#X} (or +equivalently@tie{}@code{1}), the object is placed horizontally next +to the other object. If the value is @code{#Y} or@tie{}@code{0}, it +is placed vertically.") + (side-relative-direction ,ly:dir? "Multiply direction of @code{direction-source} with this to get the direction of this object.") - (side-axis ,number? "If the value is #X (or equivalently 1), the object is placed horizontally next to the other object. If the value is #Y or 0, it is placed vertically.") (size ,number? "Size of object, relative to standard size.") - (skylines ,ly:skyline-pair? "Two skylines, one above and one - below this grob (or, for some grobs, to the left and to the right).") - (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and one below this grob.") - (horizontal-skylines ,ly:skyline-pair? "Two skylines, one to the left and one to the right of this grob.") (slope ,number? "The slope of this object.") (slur-padding ,number? "Extra distance between slur and script.") (space-alist ,list? "A table that specifies distances between @@@ -505,36 -410,28 +505,39 @@@ should use @code{LEFT}." (thickness ,number? "Line thickness, generally measured in @code{line-thickness}.") (thin-kern ,number? "The space after a hair-line in a bar line.") - (threshold ,number-pair? "(@var{min} . @var{max}), where + (threshold ,number-pair? "@code{(@var{min} . @var{max})}, where @var{min} and @var{max} are dimensions in staff space.") - (tie-configuration ,list? "List of (@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 -(1=>up, -1=>down, 0=>center). A non-pair entry in the list will cause -the corresponding tie to be formatted automatically.") + (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, @code{-1}=>down, @code{0}=>center). A non-pair entry +in the list causes the corresponding tie to be formatted +automatically.") (transparent ,boolean? "This makes the grob invisible.") - (uniform-stretching ,boolean? "If set, items stretch proportional -to their durations. This looks better in complex polyphonic patterns") - (used ,boolean? "If set, this spacing column is kept in the spacing problem") + + (uniform-stretching ,boolean? "If set, items stretch +proportionally to their durations. This looks better in complex +polyphonic patterns.") + (used ,boolean? "If set, this spacing column is kept in the +spacing problem") + ++ (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and ++one below this grob.") ++ (when ,ly:moment? "Global time step associated with this column happen?") - (word-space ,ly:dimension? "space to insert between words in texts.") - (width ,ly:dimension? "The width of a grob measured in staff space.") + (width ,ly:dimension? "The width of a grob measured in staff +space.") + (word-space ,ly:dimension? "Space to insert between words in +texts.") + (zigzag-length ,ly:dimension? "The length of the lines of a -zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree -zigzags.") - (zigzag-width ,ly:dimension? "The width of one -zigzag-squiggle. This number will be adjusted slightly so that the -glissando line can be constructed from a whole number of squiggles.") +zigzag, relative to @code{zigzag-width}. A value of@tie{}@code{1} +gives 60-degree zigzags.") + (zigzag-width ,ly:dimension? "The width of one zigzag squiggle. +This number is adjusted slightly so that the glissando line can +be constructed from a whole number of squiggles.") )))