(grob-cause): escape spaces in URLs.

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

diff --git a/scm/define-grob-properties.scm b/scm/define-grob-properties.scm
index 311d40fb9e7e7695edf06984f365980d9035d4c3..a3c637534ab8387eb06c12fdcba5190b3ff0d542 100644 (file)
--- a/scm/define-grob-properties.scm
+++ b/scm/define-grob-properties.scm
@@ -5,13 +5,9 @@
 ;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 
 ;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 

-
-

 (define (define-grob-property symbol type? description)
   (if (not (equal? (object-property symbol 'backend-doc) #f))
 (define (define-grob-property symbol type? description)
   (if (not (equal? (object-property symbol 'backend-doc) #f))

-      (begin
-       (ly:warn-append "Redefining ~S" symbol)
-       (exit 2)))
+      (ly:error (_ "symbol ~S redefined") symbol))

   
   (set-object-property! symbol 'backend-type? type?)
   (set-object-property! symbol 'backend-doc description)
   
   (set-object-property! symbol 'backend-type? type?)
   (set-object-property! symbol 'backend-doc description)


@@ -39,15 +35,13 @@ called first.  The functions take a grob and axis argument. ")
      (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
      (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
 
      (Y-extent-callback ,procedure? "see @code{X-extent-callback}.")
      (Y-offset-callbacks ,list? "see @code{X-offset-callbacks}.")
 

-     (accidentals ,list? "List of alteration numbers.")
+     (accidentals ,list? "List of alteration numbers")
+     (alteration-alist ,list? "List of @code{(@var{pitch}
+. @var{accidental})} pairs for key signature.")

      (add-stem-support ,boolean? "If set, the Stem object is included in this script's support") 
     
      (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
 @code{0}: around center of width, @code{1}: right side.")
      (add-stem-support ,boolean? "If set, the Stem object is included in this script's support") 
     
      (align-dir ,ly:dir? "Which side to align? @code{-1}: left side,
 @code{0}: around center of width, @code{1}: right side.")

-     (arch-angle ,number? "Turning angle of the hook of a system brace" )
-     (arch-height ,ly:dimension? "Height of the hook of a system brace.")
-     (arch-thick ,number? "Thickness of the hook of system brace.")
-     (arch-width ,ly:dimension? "Width of the hook of a system brace.")

      (arpeggio-direction ,ly:dir? "If set, put an
 arrow on the arpeggio squiggly line.")
   
      (arpeggio-direction ,ly:dir? "If set, put an
 arrow on the arpeggio squiggly line.")
   


@@ -98,7 +92,6 @@ potential line breaks.")
      (bracket-flare ,number-pair? "A pair of numbers specifying how
 much edges of brackets should slant outward.  Value 0.0 means straight
 edges")
      (bracket-flare ,number-pair? "A pair of numbers specifying how
 much edges of brackets should slant outward.  Value 0.0 means straight
 edges")

-     (bracket-thick ,number? "width of a system start bracket.")

      (break-align-symbol ,symbol? "This key is used for aligning and
 spacing breakable items.")
      (break-align-orders ,vector? " Defines the order in which
      (break-align-symbol ,symbol? "This key is used for aligning and
 spacing breakable items.")
      (break-align-orders ,vector? " Defines the order in which


@@ -121,6 +114,16 @@ For example, clefs are put after key signatures by setting
      (break-glyph-function ,procedure? "This function determines the
 appearance of a bar line at the line break.  It takes a glyph and
 break-direction and returns the glyph at a line break.")
      (break-glyph-function ,procedure? "This function determines the
 appearance of a bar line at the line break.  It takes a glyph and
 break-direction and returns the glyph at a line break.")

+     (break-overshoot ,number-pair? "How much does a broken spanner
+stick out of its bounds?")
+     (bracket-visibility ,boolean-or-symbol? "This controls the
+visibility of the tuplet bracket.  Setting it to false will prevent
+printing of the bracket. Setting the property to @code{'if-no-beam}
+will make it print only if there is no beam associated with this
+tuplet bracket.")
+     (break-visibility ,vector? "A vector of 3 booleans, #(end-of-line unbroken begin-of-line).
+#t means visible, #f means killed.")
+

      (breakable ,boolean? "Can this object appear at a line break,
 like clefs and bar lines?")
      (c0-position ,integer? "An integer indicating the position of
      (breakable ,boolean? "Can this object appear at a line break,
 like clefs and bar lines?")
      (c0-position ,integer? "An integer indicating the position of


@@ -135,6 +138,8 @@ measure of the closeness of the inner stems. It is used for damping
 the slope of the beam.")
      (collapse-height ,ly:dimension? "Minimum height of system start delimiter.  If equal or smaller, the bracket is removed.")
 
 the slope of the beam.")
      (collapse-height ,ly:dimension? "Minimum height of system start delimiter.  If equal or smaller, the bracket is removed.")
 

+     (color ,color? "The color of this grob.")
+

      (context ,ly:context? "Originating context of the grob")
      
      ;;DOCME
      (context ,ly:context? "Originating context of the grob")
      
      ;;DOCME


@@ -149,6 +154,10 @@ negative, no line is drawn at all.")
 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
 line).")
 
 dash-period. Should be between 0.0 (no line) and 1.0 (continuous
 line).")
 

+     (arrow ,boolean? "Add an arrow to the line.")
+     (arrow-length ,number? "Arrow length.")
+     (arrow-width ,number? "Arrow width.")
+

      ;; todo: why is this tunable?
      (dir-function ,procedure? "The function to determine the
 direction of a beam. Choices include: 
      ;; todo: why is this tunable?
      (dir-function ,procedure? "The function to determine the
 direction of a beam. Choices include: 


@@ -174,8 +183,12 @@ mean center distance weighted per note
 the vertical edges '(@var{left-height} . @var{right-height}).")
      (edge-text ,pair? "A pair specifying the texts to be set at the
 edges '(@var{left-text} . @var{right-text}).")
 the vertical edges '(@var{left-height} . @var{right-height}).")
      (edge-text ,pair? "A pair specifying the texts to be set at the
 edges '(@var{left-text} . @var{right-text}).")

-     (excentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")
+     (eccentricity ,number? "How asymmetrical to make a slur. Positive means move the center to the right.")

      
      

+     (enclose-bounds ,number?
+                    "How much of the bound a spanner should enclose:
++1 = completely, 0 = center, -1 not at all.")
+

      (expand-limit ,integer? "maximum number of measures expanded in church rests.")
 
      ;; remove me? 
      (expand-limit ,integer? "maximum number of measures expanded in church rests.")
 
      ;; remove me? 


@@ -192,12 +205,17 @@ engine is completely oblivious to it.")
 
      (finger-code ,symbol? "Code for the type of fingering indication in a
 fret diagram.  Options include @code{none}, @code{in-dot}, and @code{below-string}.")
 
      (finger-code ,symbol? "Code for the type of fingering indication in a
 fret diagram.  Options include @code{none}, @code{in-dot}, and @code{below-string}.")

+     (flag-count ,number? "The number of tremolo beams.")

      (flag-style ,symbol?
                 "a string determining what style of flag-glyph is
 typeset on a Stem. Valid options include @code{()} and
 @code{mensural}.  Additionally, @code{\"no-flag\"} switches off the
 flag.")
      (flag-style ,symbol?
                 "a string determining what style of flag-glyph is
 typeset on a Stem. Valid options include @code{()} and
 @code{mensural}.  Additionally, @code{\"no-flag\"} switches off the
 flag.")

+     

      (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")
      (flag-width-function ,procedure? "Procedure that computes the width of a half-beam (a non-connecting beam.).")

+     (strict-note-spacing ,boolean? "If set, unbroken columns
+with non-musical material (clefs, barlines, etc.) are not spaced
+separately, but put before musical columns.")

      (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
      (font-encoding ,symbol? "The font encoding is the broadest
 category for selecting a font. Options include: @code{fetaMusic},
      (font-family ,symbol? "The font family is the broadest category for selecting text fonts. Options include: @code{sans}, @code{roman} ")
      (font-encoding ,symbol? "The font encoding is the broadest
 category for selecting a font. Options include: @code{fetaMusic},


@@ -258,13 +276,13 @@ 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
 @internalsref{note-collision-interface}.")
      (horizontal-shift ,integer? "An integer that identifies ranking
 of note-column for horizontal shifting. This is used by
 @internalsref{note-collision-interface}.")

-     (inside-slur ,boolean? "If set, this script should be inside the
-slur. If set to false, the script places itself around the slur. If
-unset, script and slur ignore each other ")
+     (avoid-slur ,symbol? "Method of handling slur collisions.
+Choices are @code{around}, @code{inside}, @code{outside}.  If unset, script
+and slur ignore eachother.")

      (inspect-quants ,number-pair? "If debugging is set,
 set beam quant to this position, and print the respective scores.")
 
      (inspect-quants ,number-pair? "If debugging is set,
 set beam quant to this position, and print the respective scores.")
 

-     (allow-outside-line ,boolean? "If set, allow this column to
+     (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.")
 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.")


@@ -285,6 +303,7 @@ second for staff space. Both contributions are added.")
 left to a group of accidentals.")
      (length ,ly:dimension? "User override for the stem length of
 unbeamed stems.")
 left to a group of accidentals.")
      (length ,ly:dimension? "User override for the stem length of
 unbeamed stems.")

+     (length-fraction ,number? "Length of ledger line as fraction of note head size.")

      (lengths ,list? "Default stem lengths. The list gives a length
 for each flag-count.")
      (line-count ,integer? "The number of staff lines.")
      (lengths ,list? "Default stem lengths. The list gives a length
 for each flag-count.")
      (line-count ,integer? "The number of staff lines.")


@@ -303,6 +322,7 @@ polyphonic guitar notation. The value of this setting is used by
 collisions, even if they have a different number of dots. This normal
 notation for some types of polyphonic music. ")
 
 collisions, even if they have a different number of dots. This normal
 notation for some types of polyphonic music. ")
 

+     (minimum-length-fraction ,number? "Minimum length of ledger line as fraction of note head size.")

      (minimum-distance ,ly:dimension? "Minimum distance between rest
 and notes or beam.")
      (minimum-X-extent ,number-pair? "Minimum size of an object in X
      (minimum-distance ,ly:dimension? "Minimum distance between rest
 and notes or beam.")
      (minimum-X-extent ,number-pair? "Minimum size of an object in X


@@ -313,15 +333,11 @@ this long. This requires an appropriate routine for the
 @code{spacing-procedure} property.")
      (minimum-space ,ly:dimension? "Minimum distance that the victim
 should move (after padding).")
 @code{spacing-procedure} property.")
      (minimum-space ,ly:dimension? "Minimum distance that the victim
 should move (after padding).")

-     (print-function ,procedure? "Function taking grob as argument,
-returning a @code{Stencil} object.")

      (neutral-direction ,ly:dir? "Which direction to take in the
 center of the staff.")
      (neutral-position ,number? "Position (in half staff spaces) where
 to flip the direction of custos stem.")
 
      (neutral-direction ,ly:dir? "Which direction to take in the
 center of the staff.")
      (neutral-position ,number? "Position (in half staff spaces) where
 to flip the direction of custos stem.")
 

-     (new-accidentals ,list? "List of @code{(@var{pitch}
-. @var{accidental})} pairs.")

      (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
      (note-names ,vector? "Vector of strings containing names for
 easy-notation note heads.")
      (next ,ly:grob? "Object that is next relation (eg. the lyric syllable following an extender.")
      (note-names ,vector? "Vector of strings containing names for
 easy-notation note heads.")


@@ -332,14 +348,13 @@ spacing constraints.")
 get stems extending to the middle staff line.")
      (number-type ,symbol? "Type of numbers to use in label.  Choices
 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")
 get stems extending to the middle staff line.")
      (number-type ,symbol? "Type of numbers to use in label.  Choices
 include @code{roman-lower}, @code{roman-upper}, and @code{arabic}.")

-     
-     (old-accidentals ,list? "List of @code{(@var{pitch} . @var{accidental})
-pairs.}")
+     (number-visibility ,boolean-or-symbol? "Like
+@code{bracket-visibility}, but for the number.")
+

 
 

-     (enclose-bounds ,number?
-                    "How much of the bound a spanner should enclose:
-+1 = completely, 0 = center, -1 not at all.")

 
 

+     (packed-spacing ,boolean? "If set, the notes are spaced as
+tightly as possible.")

      (padding ,ly:dimension? "Add this much extra space between
 objects that are next to each other.")
      (page-penalty ,number? "Penalty for page break at
      (padding ,ly:dimension? "Add this much extra space between
 objects that are next to each other.")
      (page-penalty ,number? "Penalty for page break at


@@ -355,7 +370,9 @@ as a real penalty.")
                "Pair of staff coordinates @code{(@var{left}
 . @var{right})}, where both @var{left} and @var{right} are in the
 staff-space unit of the current staff.")
                "Pair of staff coordinates @code{(@var{left}
 . @var{right})}, where both @var{left} and @var{right} are in the
 staff-space unit of the current staff.")

-
+     (print-function ,procedure? "Function taking grob as argument,
+returning a @code{Stencil} object.")
+     

      (ratio ,number? "Parameter for slur shape. The higher this number, the
 quicker the slur attains it @code{height-limit}.")
      (remove-first ,boolean? "Remove the first staff of a orchestral score?")
      (ratio ,number? "Parameter for slur shape. The higher this number, the
 quicker the slur attains it @code{height-limit}.")
      (remove-first ,boolean? "Remove the first staff of a orchestral score?")


@@ -413,8 +430,7 @@ parameters.  The routine is called after
 expressed in global staffspace.")
      (staff-position ,number? "Vertical position, measured in half
 staff spaces, counted from the middle line.")
 expressed in global staffspace.")
      (staff-position ,number? "Vertical position, measured in half
 staff spaces, counted from the middle line.")

-     (staffline-clearance ,ly:dimension? "How far away ties keep from
-staff lines.")
+     

      (stemlet-length ,number? "How long should a stem over a rest be?")
      (stem-attachment-function ,procedure? "A function that calculates
 where a stem attaches to the note head? This is a fallback when this
      (stemlet-length ,number? "How long should a stem over a rest be?")
      (stem-attachment-function ,procedure? "A function that calculates
 where a stem attaches to the note head? This is a fallback when this


@@ -434,7 +450,9 @@ stems that are placed in tight configurations. For opposite
 directions, this amount is the correction for two normal sized stems
 that overlap completely.")
 
 directions, this amount is the correction for two normal sized stems
 that overlap completely.")
 

-     
+     (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 stem distance.")

      (string-count ,integer? "The number of strings in a fret diagram.")
      (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
      
      (string-count ,integer? "The number of strings in a fret diagram.")
      (stroke-style ,string? "set to \"grace\" to turn stroke through flag on.")
      


@@ -451,34 +469,20 @@ reading this property.")
 
      (threshold ,number-pair? "(@var{min} . @var{max}), where
 @var{min} and @var{max} are dimensions in staff space.")
 
      (threshold ,number-pair? "(@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.")

      (transparent ,boolean? "This is almost the same as setting
 @code{print-function} to @code{#f}, but this retains the dimensions of
 this grob, which means that grobs can be erased individually.")
      (transparent ,boolean? "This is almost the same as setting
 @code{print-function} to @code{#f}, but this retains the dimensions of
 this grob, which means that grobs can be erased individually.")

-     (bracket-visibility ,boolean-or-symbol? "This controls the
-visibility of the tuplet bracket.  Setting it to false will prevent
-printing of the bracket. Setting the property to @code{'if-no-beam}
-will make it print only if there is no beam associated with this
-tuplet bracket.")
-     (number-visibility ,boolean-or-symbol? "Like
-@code{bracket-visibility}, but for the number.")
-
-     ;; FIXME.
-     (break-visibility ,procedure? "A function that takes the break
-direction and returns a cons of booleans containing (@var{transparent}
-. @var{empty}).  The following variables are predefined:
-@code{all-visible}, @code{begin-of-line-visible},
-@code{end-of-line-visible}, @code{begin-of-line-invisible},
-@code{end-of-line-invisible}, @code{all-invisible}.")
-     (flag-count ,number? "The number of tremolo beams.")
-
+     (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")

      (when ,ly:moment? "Global time step associated with this column
 happen?")
      (word-space ,ly:dimension? "space to insert between lyrics or
 words in texts.")
      (width ,ly:dimension? "The width of a grob measured in staff space.")
      (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")
      (when ,ly:moment? "Global time step associated with this column
 happen?")
      (word-space ,ly:dimension? "space to insert between lyrics or
 words in texts.")
      (width ,ly:dimension? "The width of a grob measured in staff space.")
      (x-gap ,ly:dimension? "The horizontal gap between note head and tie.")

-     (y-offset ,ly:dimension? "Extra vertical offset for ties away
-from the center line.")

      (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-length ,ly:dimension? "The length of the lines of a
 zigzag, relative to @code{zigzag-width}. A value of 1 gives 60-degree
 zigzags.")


@@ -516,17 +520,12 @@ sizes (like the dynamic @b{p} and @b{f}) on their baselines.")
      (axis-group-parent-X ,ly:grob? "Containing X axis group")
      (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
      (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")
      (axis-group-parent-X ,ly:grob? "Containing X axis group")
      (axis-group-parent-Y ,ly:grob? "Containing Y axis group")
      (accidental-grobs ,list? "Alist with (NOTENAME . GROBLIST) entries")

-     (adjacent-hairpins ,grob-list? "List of directly neighboring hairpins")
+     (adjacent-hairpins ,ly:grob-array? "List of directly neighboring hairpins")

      (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")     
      (after-line-breaking-callback ,procedure? "This procedure is called after line breaking. Its return value is ignored.")     

-     (all-elements ,grob-list? "list of all grobs in this line. Its
+     (all-elements ,ly:grob-array? "list of all grobs in this line. Its

 function is to protect objects from being garbage collected.")
      (arpeggio ,ly:grob? "pointer to arpeggio object.")
      (beam ,ly:grob? "pointer to the beam, if applicable.")
 function is to protect objects from being garbage collected.")
      (arpeggio ,ly:grob? "pointer to arpeggio object.")
      (beam ,ly:grob? "pointer to the beam, if applicable.")

-     (center-element ,ly:grob? "grob which will be at the center of
-the group after aligning (when using
-Align_interface::center_on_element).")
-     (tweak-count ,number? "Number of otherwise unique Grobs.")
-     (tweak-rank ,number? "Identify otherwise unique Grobs.")

      (direction-source ,ly:grob? "in case side-relative-direction is
 set, which grob to get the direction from .")
      (dot ,ly:grob? "reference to Dots object.")
      (direction-source ,ly:grob? "in case side-relative-direction is
 set, which grob to get the direction from .")
      (dot ,ly:grob? "reference to Dots object.")


@@ -536,38 +535,38 @@ set, which grob to get the direction from .")
      (tie ,ly:grob? "")
      (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
      (rest ,ly:grob? "the staff symbol grob that we're in.")
      (tie ,ly:grob? "")
      (staff-symbol ,ly:grob? "the staff symbol grob that we're in.")
      (rest ,ly:grob? "the staff symbol grob that we're in.")

-     (rests ,grob-list? "A list of rest objects.")
+     (rests ,ly:grob-array? "A list of rest objects.")

      (rest-collision ,ly:grob? "rest collision that a rest is in.")
      (accidental-grob ,ly:grob? "Accidental for this note.")
      (rest-collision ,ly:grob? "rest collision that a rest is in.")
      (accidental-grob ,ly:grob? "Accidental for this note.")

-     (bars ,grob-list? "list of bar line pointers.")
-     (bounded-by-me ,grob-list? "list of spanners that have this
+     (bars ,ly:grob-array? "list of bar line pointers.")
+     (bounded-by-me ,ly:grob-array? "list of spanners that have this

 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")
 column as start/begin point. Only columns that have grobs or act as bounds are spaced.")

-     (columns ,grob-list? "list of grobs, typically containing
+     (columns ,ly:grob-array? "list of grobs, typically containing

 paper-columns or note-column objects.")
 paper-columns or note-column objects.")

-     (conditional-elements ,grob-list? "Internal use only")
-     (dependencies ,grob-list? "list of score-grob pointers that indicate who to compute first for certain global passes.")
-     (encompass-objects ,grob-list? "Objects that a slur should avoid
+     (conditional-elements ,ly:grob-array? "Internal use only")
+     (dependencies ,ly:grob-array? "list of score-grob pointers that indicate who to compute first for certain global passes.")
+     (encompass-objects ,ly:grob-array? "Objects that a slur should avoid

 in addition to notes and stems.")
 in addition to notes and stems.")

-     (elements ,grob-list? "list of grobs, type depending on the Grob where this is set in.")
-     (heads ,grob-list? "List of note heads.")
-     (items-worth-living ,grob-list? "A list of interesting items. If
+     (elements ,ly:grob-array? "list of grobs, type depending on the Grob where this is set in.")
+     (heads ,ly:grob-array? "List of note heads.")
+     (items-worth-living ,ly:grob-array? "A list of interesting items. If

 empty in a particular staff, then that staff is erased.")
      (details ,list? "alist of parameters for detailed grob behavior.")
 empty in a particular staff, then that staff is erased.")
      (details ,list? "alist of parameters for detailed grob behavior.")

-     (note-heads ,grob-list? "List of note head grobs")
-     (side-support-elements ,grob-list? "the support, a list of grobs.")
-     (spacing-wishes ,grob-list? "List of note spacing or staff spacing objects.")
-     (stems ,grob-list? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
-
+     (note-heads ,ly:grob-array? "List of note head grobs")
+     (side-support-elements ,ly:grob-array? "the support, a list of grobs.")
+     (spacing-wishes ,ly:grob-array? "List of note spacing or staff spacing objects.")
+     (stems ,ly:grob-array? "list of stem objects, corresponding to the notes that the arpeggio has to be before.")
+     (tuplets ,ly:grob-array? "list of smaller tuplet brackets")

 
 

-     (left-neighbors ,grob-list? " List of
+     (left-neighbors ,ly:grob-array? " List of

 spacing-wish grobs that are close to the current column.
 
 The closest spacing-wishes determine the actual distances between the
 columns.
 ")
 spacing-wish grobs that are close to the current column.
 
 The closest spacing-wishes determine the actual distances between the
 columns.
 ")

-     (right-neighbors ,grob-list? "see left-neighbors")
-     (left-items ,grob-list? "")
-     (right-items ,grob-list? "")
+     (right-neighbors ,ly:grob-array? "see left-neighbors")
+     (left-items ,ly:grob-array? "")
+     (right-items ,ly:grob-array? "")

      (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob.  ")
      (font ,ly:font-metric? "Cached font metric object")
 
      (cause ,scheme? "Any kind of causation objects (i.e. music, or perhaps translator) that was the cause for this grob.  ")
      (font ,ly:font-metric? "Cached font metric object")
 


@@ -586,9 +585,10 @@ entries @code{name} and @code{interfaces}.")
      ;; TODO: use interface for this!
      (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
      (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")
      ;; TODO: use interface for this!
      (chord-tremolo ,boolean? "if set, this beam is a tremolo. ")
      (begin-of-line-visible ,boolean? "Used for marking ChordNames that should only show changes.")

-     (head-pair ,pair? "Pair of grob pointers, pointing to the two heads of the tie.")
+

      (quant-score ,string? "Beam quanting score -- can be stored for
 debugging")
      (quant-score ,string? "Beam quanting score -- can be stored for
 debugging")

+     

      (least-squares-dy ,number? 
                       "ideal beam slope, without damping.")
      (ligature-primitive-callback ,procedure? "callback that brews ligature head.")
      (least-squares-dy ,number? 
                       "ideal beam slope, without damping.")
      (ligature-primitive-callback ,procedure? "callback that brews ligature head.")


@@ -598,8 +598,9 @@ debugging")
      (position-callbacks ,list? "list of
 functions set spanner positions.")
 
      (position-callbacks ,list? "list of
 functions set spanner positions.")
 

-;;; Junk me, replace it by add-join.
-     (join-left-amount ,number? "")
+;;; add-join would be enough if in Mensural_ligature::brew_ligature_primitive
+;;; the next note could be seen
+     (join-right-amount ,number? "")

 
      (delta-pitch ,number? "the interval between this and the next note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
      (head-width ,ly:dimension? "width of this ligature head")
 
      (delta-pitch ,number? "the interval between this and the next note, or, more precisely, their vertical distance; this is used in ligatures for calculation of the height of vertical joins flexa shapes")
      (head-width ,ly:dimension? "width of this ligature head")


@@ -618,7 +619,7 @@ stem. Internally used to distribute beam shortening over stems. ")
 than a whole rest.")
      
 
 than a whole rest.")
      
 

-     (spaceable-staves ,grob-list? "Objects to be spaced during page layout.")
+     (spaceable-staves ,ly:grob-array? "Objects to be spaced during page layout.")

 
      ;; ancient notation
 
 
      ;; ancient notation
 


@@ -640,7 +641,6 @@ than a whole rest.")
   
  
      (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")
   
  
      (add-stem ,boolean? "is this ligature head a virga and therefore needs an additional stem on the right side?")

-     (join-left ,boolean? "is this ligature head joined with the previous one by a vertical line?")

      (context-info ,integer? "DOCME")
      (inclinatum ,boolean? "is this neume an inclinatum?")
      (oriscus ,boolean? "is this neume an oriscus?")
      (context-info ,integer? "DOCME")
      (inclinatum ,boolean? "is this neume an inclinatum?")
      (oriscus ,boolean? "is this neume an oriscus?")