Clarify 'avoid-slur docstring.

[lilypond.git] / scm / define-grob-properties.scm

diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm
index 973ffdd178b5a9f2465771853eaa79c5ca57dc48..ce9ceaab4f23309d10f2b6ad2d884991dbe58a50 100644 (file)
--- a/scm/define-grob-properties.scm
+++ b/scm/define-grob-properties.scm
@@ -51,10 +51,14 @@ averaged over staves.")
      (avoid-note-head ,boolean? "If set, the stem of a chord does not
 pass through all note heads, but starts at the last note head.")
      (avoid-slur ,symbol? "Method of handling slur collisions.
      (avoid-note-head ,boolean? "If set, the stem of a chord does not
 pass through all note heads, but starts at the last note head.")
      (avoid-slur ,symbol? "Method of handling slur collisions.

-Choices are @code{around}, @code{inside}, @code{outside}.  If unset,
-scripts and slurs ignore each other.  @code{around} only moves the
-script if there is a collision; @code{outside} always moves the
-script.")
+Choices are @code{inside}, @code{outside}, @code{around}, and
+@code{ignore}. @code{inside} adjusts the slur if needed to keep the
+grob inside the slur. @code{outside} moves the grob vertically to the
+outside of the slur. @code{around} moves the grob vertically to the
+outside of the slur only if there is a collision. @code{ignore} does
+not move either. In grobs whose notational significance depends on
+vertical position (such as accidentals, clefs, etc.), @code{outside}
+and @code{around} behave like @code{ignore}.")

      (axes ,list? "List of axis numbers.  In the case of alignment
 grobs, this should contain only one number.")
 
      (axes ,list? "List of axis numbers.  In the case of alignment
 grobs, this should contain only one number.")
 


@@ -171,6 +175,9 @@ this should list the control points of a third-order B@'ezier curve.")
 ;; d
 ;;
      (damping ,number? "Amount of beam slope damping.")
 ;; 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,
+an ending t-value, a @code{dash-fraction}, and a @code{dash-period}.")

      (dash-fraction ,number? "Size of the dashes, relative to
 @code{dash-period}.  Should be between @code{0.0} (no line) and
 @code{1.0} (continuous line).")
      (dash-fraction ,number? "Size of the dashes, relative to
 @code{dash-period}.  Should be between @code{0.0} (no line) and
 @code{1.0} (continuous line).")


@@ -178,6 +185,10 @@ this should list the control points of a third-order B@'ezier curve.")
 whitespace.  If negative, no line is drawn at all.")
      (default-direction ,ly:dir? "Direction determined by note head
 positions.")
 whitespace.  If negative, no line is drawn at all.")
      (default-direction ,ly:dir? "Direction determined by note head
 positions.")

+     (details ,list? "Alist of parameters for detailed grob behavior.
+More information on the allowed parameters for a grob can be found by 
+looking at the top of the Internals Reference page for each interface
+having a @code{details} property.")

      (digit-names ,vector "Names for string finger digits.")
      (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
 @code{#X}), then this property determines whether the object is placed
      (digit-names ,vector "Names for string finger digits.")
      (direction ,ly:dir? "If @code{side-axis} is @code{0} (or
 @code{#X}), then this property determines whether the object is placed


@@ -389,27 +400,27 @@ be included in harp-pedal-details include the following:
 @itemize @bullet
 @item
 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal
 @itemize @bullet
 @item
 @code{box-offset} -- Vertical shift of the center of flat/sharp pedal

-boxes above/below the horizontal line.  Default value 0.8.
+boxes above/below the horizontal line.  Default value@tie{}0.8.

 @item
 @item

-@code{box-width} -- Width of each pedal box.  Default value 0.4.
+@code{box-width} -- Width of each pedal box.  Default value@tie{}0.4.

 @item
 @item

-@code{box-height} -- Height of each pedal box.  Default value 1.0.
+@code{box-height} -- Height of each pedal box.  Default value@tie{}1.0.

 @item
 @code{space-before-divider} -- Space between boxes before the first
 @item
 @code{space-before-divider} -- Space between boxes before the first

-divider (so that the diagram can be made symmetric).  Default value
-0.8.
+divider (so that the diagram can be made symmetric).  Default
+value@tie{}0.8.

 @item
 @code{space-after-divider} -- Space between boxes after the first
 @item
 @code{space-after-divider} -- Space between boxes after the first

-divider.  Default value 0.8.
+divider.  Default value@tie{}0.8.

 @item
 @code{circle-thickness} -- Thickness (in unit of the line-thickness)
 @item
 @code{circle-thickness} -- Thickness (in unit of the line-thickness)

-of the ellipse around circled pedals.  Default value 0.5.
+of the ellipse around circled pedals.  Default value@tie{}0.5.

 @item
 @code{circle-x-padding} -- Padding in X direction of the ellipse
 around circled pedals.  Default value 0.15.
 @item
 @code{circle-y-padding} -- Padding in Y direction of the ellipse
 @item
 @code{circle-x-padding} -- Padding in X direction of the ellipse
 around circled pedals.  Default value 0.15.
 @item
 @code{circle-y-padding} -- Padding in Y direction of the ellipse

-around circled pedals.  Default value 0.2.
+around circled pedals.  Default value@tie{}0.2.

 @end itemize")
      (head-direction ,ly:dir? "Are the note heads left or right in a
 semitie?")
 @end itemize")
      (head-direction ,ly:dir? "Are the note heads left or right in a
 semitie?")


@@ -834,7 +845,7 @@ constructed from a whole number of squiggles.")
      (accidental-grob ,ly:grob? "The accidental for this note.")
      (accidental-grobs ,list? "An alist with @code{(@var{notename} .
 @var{groblist})} entries.")
      (accidental-grob ,ly:grob? "The accidental for this note.")
      (accidental-grobs ,list? "An alist with @code{(@var{notename} .
 @var{groblist})} entries.")

-     (adjacent-pure-heights ,vector? "Used by a @code{VerticalAxisGroup} to
+     (adjacent-pure-heights ,pair? "A pair of vectors. Used by a @code{VerticalAxisGroup} to

 cache the @code{Y-extent}s of different column ranges.")
      (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
 hairpins.")
 cache the @code{Y-extent}s of different column ranges.")
      (adjacent-hairpins ,ly:grob-array? "A list of directly neighboring
 hairpins.")


@@ -932,19 +943,14 @@ notes that the arpeggio has to be before.")
 
      ;;;;;;;;;;;;;;;;
      ;; other
 
      ;;;;;;;;;;;;;;;;
      ;; other

-     (begin-of-line-visible ,boolean? "Used for marking @code{ChordNames}
-that should only show changes.")
+     (begin-of-line-visible ,boolean? "Set to make @code{ChordName} or 
+@code{FretBoard} be visible only at beginning of line or at 
+chord changes.")

 
      (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
 translator) that was the cause for this grob.")
 
      (cause ,scheme? "Any kind of causation objects (i.e., music, or perhaps
 translator) that was the cause for this grob.")

-     (delta-position ,number? "The vertical position difference.")
-     (details ,list? "Alist of parameters for detailed grob behavior.

 
 

-More information on the allowed parameters can be found by inspecting
-@file{lily/slur-scoring.cc}, @file{lily/beam-quanting.cc}, and
-@file{lily/tie-formatting-problem.cc}.  Setting @code{debug-tie-scoring},
-@code{debug-beam-scoring} or @code{debug-slur-scoring} also provides
-useful clues.")
+     (delta-position ,number? "The vertical position difference.")

 
      (font ,ly:font-metric? "A cached font metric object.")
 
 
      (font ,ly:font-metric? "A cached font metric object.")