* lily/break-substitution.cc (fast_fubstitute_grob_list): use

[lilypond.git] / scm / interface-description.scm

diff --git a/scm/interface-description.scm b/scm/interface-description.scm
index 767de6a6efc8065de19e9cd46dbc2439ecc88c6e..60532b53130fce7d7c397daef80d0aa0abf69deb 100644 (file)
--- a/scm/interface-description.scm
+++ b/scm/interface-description.scm
@@ -41,4 +41,40 @@
 (ly-add-interface
  'tablature-interface
  "tablature notes"
- '(string-tunings tab-string))
+ '())
+
+
+
+;; 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
+"