1 ;;;; interface-description.scm -- part of generated backend documentation
3 ;;;; source file of the GNU LilyPond music typesetter
5 ;;;; (c) 1998--2007 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
19 'bass-figure-interface
24 'bass-figure-alignment-interface
25 "Align a bass figure."
31 '(thickness delta-position))
35 "Any kind of loudness sign."
39 'dynamic-line-spanner-interface
40 "Dynamic line spanner."
44 'dynamic-text-spanner-interface
45 "Dynamic text spanner."
50 "A fingering instruction."
54 'fret-diagram-interface
56 '(align-dir fret-diagram-details size string-fret-finger-combinations
60 'grace-spacing-interface
61 "Keep track of durations in a run of grace notes."
62 '(columns common-shortest-duration))
65 'key-cancellation-interface
70 'ligature-bracket-interface
71 "A bracket indicating a ligature in the original edition."
72 '(width thickness height))
81 "Any object that is related to lyrics."
85 'lyric-syllable-interface
86 "A single piece of lyrics."
95 'metronome-mark-interface
100 'multi-measure-interface
101 "Multi measure rest, and the text or number that is printed over it."
110 'only-prebreak-interface
111 "Kill this grob after the line breaking process."
115 'parentheses-interface
116 "Parentheses for other objects."
120 'percent-repeat-interface
121 "Beat, Double and single measure repeats."
125 'piano-pedal-interface
126 "A piano pedal sign."
130 'piano-pedal-script-interface
131 "A piano pedal sign, fixed size."
135 'pitched-trill-interface
136 "A note head to indicate trill pitches."
140 'rhythmic-grob-interface
141 "Any object with a duration. Used to determine which grobs are
142 interesting enough to maintain a hara-kiri staff."
146 'spacing-options-interface
147 "Supports setting of spacing variables."
148 '(spacing-increment shortest-duration-space))
151 'stanza-number-interface
152 "A stanza number, to be put in from of a lyrics line."
156 'string-number-interface
157 "A string number instruction."
161 'stroke-finger-interface
162 "A right hand finger instruction."
165 ;;; todo: this is not typesetting info. Move to interpretation.
168 "An interface for any notes set in a tablature staff."
172 'trill-spanner-interface
177 'trill-pitch-accidental-interface
178 "An accidental for trill pitch."
182 'unbreakable-spanner-interface
183 "A spanner that should not be broken across line breaks. Override
184 with @code{breakable=##t}."
188 'vertically-spaceable-interface
189 "Objects that should be kept at constant vertical distances. Typically:
190 @rinternals{VerticalAxisGroup} objects of @rinternals{Staff} contexts."