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@xs4all.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)"
18 'bass-figure-interface
25 '(thickness delta-position))
28 'bass-figure-alignment-interface
34 "Any kind of loudness sign"
38 'dynamic-line-spanner-interface
39 "Dynamic line spanner"
44 "A fingering instruction"
48 'fret-diagram-interface
50 '(align-dir barre-type dot-color dot-radius finger-code fret-count
51 label-dir number-type size string-count
52 string-fret-finger-combinations thickness))
55 'grace-spacing-interface
56 "Keep track of durations in a run of grace notes."
57 '(columns common-shortest-duration))
60 'key-cancellation-interface
70 'key-cancellation-interface
75 'ligature-bracket-interface
76 "A bracket indicating a ligature in the original edition"
77 '(width thickness height))
81 'lyric-syllable-interface
82 "A single piece of lyrics"
87 "Any object that is related to lyrics."
96 'metronome-mark-interface
101 'multi-measure-interface
102 "Multi measure rest, and the text or number that is printed over it."
111 'only-prebreak-interface
112 "Kill this grob after the line breaking process."
116 'parentheses-interface
117 "Parentheses for other objects"
121 'piano-pedal-interface
126 'piano-pedal-script-interface
127 "A piano pedal sign, fixed size"
131 'pitched-trill-interface
132 "A note head to indicate trill pitches"
136 'trill-pitch-accidental-interface
137 "An accidental for trill pitch"
142 'rhythmic-grob-interface
143 "Any object with a duration. Used to determine which grobs are
144 interesting enough to maintain a hara-kiri staff."
149 'spacing-options-interface
150 "Supports setting of spacing variables"
151 '(spacing-increment shortest-duration-space))
154 'stanza-number-interface
155 "A stanza number, to be put in from of a lyrics line"
159 'string-number-interface
160 "A string number instruction"
164 'stroke-finger-interface
165 "A right hand finger instruction"
169 'system-start-text-interface
170 "A text at the beginning of a system."
171 '(text long-text collapse-height style))
173 ;;; todo: this is not typesetting info. Move to interpretation.
176 "An interface for any notes set in a tablature staff"
180 'vertically-spaceable-interface
181 "Objects that should be kept at constant vertical distances. Typically:
182 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."