Automatic LyricExtenders

scm/define-grob-properties.scm

 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
 ;;;; Copyright (C) 1998--2015  Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
 ;;;; it under the terms of the GNU General Public License as published by
 ;;;; the Free Software Foundation, either version 3 of the License, or
 ;;;; (at your option) any later version.
 ;;;;
@@ skipping 167 matching lines @@
 on each chord to the height of the chord plus
 @code{chord-dots-limit} staff-positions.")
      (circled-tip ,boolean? "Put a circle at start/@/end of
 hairpins (al/@/del niente).")
      (clef-alignments ,list? "An alist of parent-alignments
 that should be used for clef modifiers with various clefs")
      (clip-edges ,boolean? "Allow outward pointing beamlets at the
 edges of beams?")
      (collapse-height ,ly:dimension? "Minimum height of system start
 delimiter.  If equal or smaller, the bracket/@/brace/@/line is removed.")
      (collapse-length ,ly:dimension? "An automatically generated

[dak, 2017/02/06 19:08:18]

collapse-width maybe?  Length is more like a list length?

 lyric extender is suppressed if it would be shorter than
 this length.")
      (collision-interfaces ,list? "A list of interfaces for which
 automatic beam-collision resolution is run.")
      (collision-voice-only ,boolean? "Does automatic beam collsion apply
 only to the voice in which the beam was created?")
      (color ,color? "The color of this grob.")
      (common-shortest-duration ,ly:moment? "The most common shortest
 note length.  This is used in spacing.  Enlarging this sets the score
 tighter.")
@@ skipping 131 matching lines @@
 larger.  If the context property @code{fontSize} is set, its value is
 added to this before the glyph is printed.  Fractional values are
 allowed.")
      (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.")
      (force-extender ,boolean? "Force a lyric extender to be generated
 if none would be generated otherwise and/or force it to be at least as
 wide as indicated by property @code{length-limit-or-forced-length} unless
 it would collide with the next syllable. Overrides property
-@code{no-extender}.")
+@code{no-extender} and property @code{no-auto-extenders}.")
      (force-hshift ,number? "This specifies a manual shift for notes
 in collisions.  The unit is the note head width of the first voice
 note.  This is used by @rinternals{note-collision-interface}.")
      (force-length ,ly:dimension? "A forced lyric extender
 is given this length if possible.")
      (forced-spacing ,number? "Spacing forced between grobs, used in
 various ligature engravers.")
      (fraction ,fraction? "Numerator and denominator of a time
 signature object.")
      (french-beaming ,boolean? "Use French beaming style for this
@@ skipping 323 matching lines @@
 ;;;
      (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.")
      (next ,ly:grob? "Object that is next relation (e.g., the lyric
 syllable following an extender).")
      (no-alignment ,boolean? "If set, don't place this grob in a
 @code{VerticalAlignment}; rather, place it using its own
 @code{Y-offset} callback.")
+     (no-auto-extenders ,boolean? "Inhibits automatic generation of lyric

[dak, 2017/02/06 19:08:18]

Why do we need this also?

There are just too many properties.

+extenders. Can be overridden by property @code{force-extender}.")
      (no-extender ,boolean? "Inhibits generation of lyric extenders.
 Can be overridden by property @code{force-extender}.")
      (no-ledgers ,boolean? "If set, don't draw ledger lines on this
 object.")
      (no-stem-extend ,boolean? "If set, notes with ledger lines do not
 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 and keys.")
      (non-musical ,boolean? "True if the grob belongs to a
@@ skipping 194 matching lines @@
 has.  Valid choices depend on the @code{stencil} callback reading
 this property.")
      (sharp-positions ,list? "Sharps in key signatures are placed
 within the specified ranges of staff-positions.  The general form
 is a list of pairs, with one pair for each type of clef, in order
 of the staff-position at which each clef places C:
 @code{(alto treble tenor soprano baritone mezzosoprano bass)}.
 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}.")
      (shortest-playing-duration ,ly:moment? "The duration of the
 shortest note 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{0}), the object is placed horizontally next to
 the other object.  If the value is @code{Y} or@tie{}@code{1}, it is
@@ skipping 603 matching lines @@
      (virga ,boolean? "Is this neume a virga?")
 
      (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.")
 
      )))
 
 (define-public all-backend-properties
   (append
    all-internal-grob-properties
    all-user-grob-properties))