(stencil->string): Rewrite.

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

diff --git a/scm/define-grob-interfaces.scm b/scm/define-grob-interfaces.scm
index fbf6f2a2eb008ccff892e2bafcedfc57170d2a08..7bd3be3f46c0ac3ba7ba95c4b15779242e2de1ae 100644 (file)
--- a/scm/define-grob-interfaces.scm
+++ b/scm/define-grob-interfaces.scm
@@ -2,7 +2,7 @@
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  1998--2003  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c)  1998--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 
 
@@ -47,6 +47,11 @@ extents of a cluster spanner at this X position.
  "a single piece of lyrics"
  '())
 
+(ly:add-interface
+ 'lyric-interface
+ "Any object that is related to lyrics."
+ '())
+
 (ly:add-interface
  'mark-interface
  "a rehearsal mark"
@@ -61,7 +66,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."
  '())
 
 
@@ -90,47 +95,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
-"