1 ;;;; interface-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ; should include default value?
14 'pitched-trill-interface
15 "A note head to indicate trill pitches"
20 'accidental-suggestion-interface
21 "An accidental, printed as a suggestion (typically: vertically over a note)"
27 "Any kind of loudness sign"
33 "A fingering instruction"
38 'string-number-interface
39 "A string number instruction"
44 'fret-diagram-interface
46 '(align-dir barre-type dot-color dot-radius finger-code fret-count
47 label-dir number-type size string-count thickness)
57 'ligature-bracket-interface
58 "A bracket indicating a ligature in the original edition"
59 '(width thickness height ligature-primitive-callback))
62 'lyric-syllable-interface
63 "a single piece of lyrics"
68 "Any object that is related to lyrics."
77 'metronome-mark-interface
84 'multi-measure-interface
85 "Multi measure rest, and the text or number that is printed over it."
95 'only-prebreak-interface
96 "Kill this grob after the line breaking process."
100 'piano-pedal-interface
106 'rhythmic-grob-interface
107 "Any object with a rhythmic basis. Used to determine which grobs
108 are interesting enough to maintain a hara-kiri staff."
113 'stanza-number-interface
114 "A stanza number, to be put in from of a lyrics line"
118 ;;; todo: this is not typesetting info. Move to interpretation.
121 "An interface for any notes set in a tablature staff"
126 'vertically-spaceable-interface
127 "Objects that should be kept at constant vertical distances. Typically:
128 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."