1 ;;;; interface-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ; should include default value?
18 "Any kind of loudness sign"
24 "A fingering instruction"
29 'rhythmic-grob-interface
30 "Any object with a rhythmic basis. Used to determine which grobs
31 are interesting enough to maintain a hara-kiri staff."
42 'ligature-bracket-interface
43 "A bracket indicating a ligature in the original edition"
44 '(width thickness height ligature-primitive-callback))
53 'metronome-mark-interface
58 ;;; todo: this is not typesetting info. Move to interpretation.
66 ;; todo: figure out where to put this doco:
69 Grob properties form a name space where you can set variables per
70 object. Each object however, may have multiple functions. For
71 example, consider a dynamic symbol, such @code{\ff} (fortissimo). It
72 is printed above or below the staff, it is a dynamic sign, and it is a
75 To reflect this different functions of a grob, procedures and variables
76 are grouped into so-called interfaces. The dynamic text for example
77 supports the following interfaces:
80 The glyph is built from characters from a font, hence the
81 @code{font-interface}. For objects supporting @code{font-interface}, you
82 can select alternate fonts by setting @code{font-style},
83 @code{font-point-size}, etc.
85 @item dynamic-interface
86 Dynamic interface is not associated with any variable or function in
87 particular, but this makes it possible to distinguish this grob from
88 other similar grobs (like @code{TextScript}), that have no meaning of
92 This interface is for texts that are to be set using special routines
93 to stack text into lines, using kerning, etc.
95 @item general-grob-interface
96 This interface is supported by all grob types.