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
56 '(align-dir barre-type dot-color dot-radius finger-code fret-count
57 label-dir number-type size string-count xo-font-magnification
58 mute-string open-string orientation string-fret-finger-combinations
62 'grace-spacing-interface
63 "Keep track of durations in a run of grace notes."
64 '(columns common-shortest-duration))
67 'key-cancellation-interface
77 'key-cancellation-interface
82 'ligature-bracket-interface
83 "A bracket indicating a ligature in the original edition"
84 '(width thickness height))
88 'lyric-syllable-interface
89 "A single piece of lyrics"
94 "Any object that is related to lyrics."
103 'metronome-mark-interface
108 'multi-measure-interface
109 "Multi measure rest, and the text or number that is printed over it."
118 'only-prebreak-interface
119 "Kill this grob after the line breaking process."
123 'parentheses-interface
124 "Parentheses for other objects"
128 'piano-pedal-interface
133 'piano-pedal-script-interface
134 "A piano pedal sign, fixed size"
138 'pitched-trill-interface
139 "A note head to indicate trill pitches"
143 'trill-pitch-accidental-interface
144 "An accidental for trill pitch"
149 'trill-spanner-interface
150 "An accidental for trill pitch"
154 'rhythmic-grob-interface
155 "Any object with a duration. Used to determine which grobs are
156 interesting enough to maintain a hara-kiri staff."
161 'spacing-options-interface
162 "Supports setting of spacing variables"
163 '(spacing-increment shortest-duration-space))
166 'stanza-number-interface
167 "A stanza number, to be put in from of a lyrics line"
171 'string-number-interface
172 "A string number instruction"
176 'stroke-finger-interface
177 "A right hand finger instruction"
181 'system-start-text-interface
182 "A text at the beginning of a system."
183 '(text long-text collapse-height style))
185 ;;; todo: this is not typesetting info. Move to interpretation.
188 "An interface for any notes set in a tablature staff"
192 'unbreakable-spanner-interface
193 "A spanner that should not be broken across line breaks. Override
194 with @code{breakable=##t}. "
199 'vertically-spaceable-interface
200 "Objects that should be kept at constant vertical distances. Typically:
201 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."