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"
43 'dynamic-text-spanner-interface
44 "Dynamic text spanner"
49 "A fingering instruction"
53 'fret-diagram-interface
55 '(align-dir barre-type dot-color dot-radius finger-code fret-count
56 label-dir number-type size string-count
57 string-fret-finger-combinations thickness))
60 'grace-spacing-interface
61 "Keep track of durations in a run of grace notes."
62 '(columns common-shortest-duration))
65 'key-cancellation-interface
75 'key-cancellation-interface
80 'ligature-bracket-interface
81 "A bracket indicating a ligature in the original edition"
82 '(width thickness height))
86 'lyric-syllable-interface
87 "A single piece of lyrics"
92 "Any object that is related to lyrics."
101 'metronome-mark-interface
106 'multi-measure-interface
107 "Multi measure rest, and the text or number that is printed over it."
116 'only-prebreak-interface
117 "Kill this grob after the line breaking process."
121 'parentheses-interface
122 "Parentheses for other objects"
126 'piano-pedal-interface
131 'piano-pedal-script-interface
132 "A piano pedal sign, fixed size"
136 'pitched-trill-interface
137 "A note head to indicate trill pitches"
141 'trill-pitch-accidental-interface
142 "An accidental for trill pitch"
147 'trill-spanner-interface
148 "An accidental for trill pitch"
152 'rhythmic-grob-interface
153 "Any object with a duration. Used to determine which grobs are
154 interesting enough to maintain a hara-kiri staff."
159 'spacing-options-interface
160 "Supports setting of spacing variables"
161 '(spacing-increment shortest-duration-space))
164 'stanza-number-interface
165 "A stanza number, to be put in from of a lyrics line"
169 'string-number-interface
170 "A string number instruction"
174 'stroke-finger-interface
175 "A right hand finger instruction"
179 'system-start-text-interface
180 "A text at the beginning of a system."
181 '(text long-text collapse-height style))
183 ;;; todo: this is not typesetting info. Move to interpretation.
186 "An interface for any notes set in a tablature staff"
190 'unbreakable-spanner-interface
191 "A spanner that should not be broken across line breaks. Override
192 with @code{breakable=##t}. "
197 'vertically-spaceable-interface
198 "Objects that should be kept at constant vertical distances. Typically:
199 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."