]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-grob-interfaces.scm
* lily/kpath.cc (kpathsea_gulp_file_to_string):
[lilypond.git] / scm / define-grob-interfaces.scm
index 4cb87db2b3eab9160ab847646812a194e0ecd0c4..2cb09558a8f2e3862c3813dd716407c6dc0cfdd0 100644 (file)
@@ -9,15 +9,6 @@
 ; should include default value?
 
 
-(ly:add-interface
- 'cluster-beacon-interface
-
- "A place holder for the cluster spanner to determine the vertical
-extents of a cluster spanner at this X position.
-
- "
- '(positions)
- )
 
 (ly:add-interface
  'dynamic-interface
@@ -66,7 +57,7 @@ extents of a cluster spanner at this X position.
 
 (ly:add-interface
  'multi-measure-interface
- "Multi measure rest, and friends (mmrest number, mmrest text)."
+ "Multi measure rest, and the text or number that is printed over it."
  '())
 
 
@@ -95,47 +86,13 @@ are interesting enough to maintain a hara-kiri staff."
 
 (ly:add-interface
  'stanza-number-interface
- ""
+ "A stanza number, to be put in from of a lyrics line"
  '()
  )
 
 ;;; todo: this is not typesetting info. Move to interpretation.
 (ly:add-interface
  'tablature-interface
- "tablature notes"
+ "An interface for any notes set in a tablature staff"
  '())
 
-
-;; todo: figure out where  to put this doco:
-
-"
-Grob properties form a name space where you can set variables per
-object.  Each object however, may have multiple functions. For
-example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
-is printed above or below the staff, it is a dynamic sign, and it is a
-kind of text.
-
-To reflect this different functions of a grob, procedures and variables
-are grouped into so-called interfaces.  The dynamic text for example
-supports the  following interfaces:
-@table @code 
-@item font-interface
-  The glyph is built from characters from a font, hence the
-@code{font-interface}. For objects supporting @code{font-interface}, you
-can select alternate fonts by setting @code{font-style},
-@code{font-point-size}, etc.
-
-@item dynamic-interface
-  Dynamic interface is not associated with any variable or function in
-particular, but this makes it possible to distinguish this grob from
-other similar grobs (like @code{TextScript}), that have no meaning of
-dynamics.
-
-@item text-interface
-  This interface is for texts that are to be set using special routines
-to stack text into lines, using kerning, etc.
-
-@item general-grob-interface
-  This interface is supported by all grob types.
-@end table
-"