1 ;;;; interface-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org>
9 ;; should include default value?
13 'accidental-suggestion-interface
14 "An accidental, printed as a suggestion (typically: vertically over a note)"
19 'bass-figure-interface
26 "Any kind of loudness sign"
30 'dynamic-line-spanner-interface
31 "Dynamic line spanner"
36 "A fingering instruction"
40 'string-number-interface
41 "A string number instruction"
45 'fret-diagram-interface
47 '(align-dir barre-type dot-color dot-radius finger-code fret-count
48 label-dir number-type size string-count thickness))
56 'ligature-bracket-interface
57 "A bracket indicating a ligature in the original edition"
58 '(width thickness height))
62 'lyric-syllable-interface
63 "a single piece of lyrics"
68 "Any object that is related to lyrics."
77 'metronome-mark-interface
82 'multi-measure-interface
83 "Multi measure rest, and the text or number that is printed over it."
92 'only-prebreak-interface
93 "Kill this grob after the line breaking process."
97 'piano-pedal-interface
102 'pitched-trill-interface
103 "A note head to indicate trill pitches"
107 'rhythmic-grob-interface
108 "Any object with a rhythmic basis. Used to determine which grobs
109 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 'system-start-text-interface
119 "A text at the beginning of a system."
120 '(text long-text collapse-height style))
122 ;;; todo: this is not typesetting info. Move to interpretation.
125 "An interface for any notes set in a tablature staff"
129 'vertically-spaceable-interface
130 "Objects that should be kept at constant vertical distances. Typically:
131 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."