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)"
19 'bass-figure-interface
26 '(thickness delta-position))
29 'bass-figure-alignment-interface
35 "Any kind of loudness sign"
39 'dynamic-line-spanner-interface
40 "Dynamic line spanner"
45 "A fingering instruction"
49 'fret-diagram-interface
51 '(align-dir barre-type dot-color dot-radius finger-code fret-count
52 label-dir number-type size string-count
53 string-fret-finger-combinations thickness))
56 'grace-spacing-interface
57 "Keep track of durations in a run of grace notes."
58 '(columns common-shortest-duration))
66 'ligature-bracket-interface
67 "A bracket indicating a ligature in the original edition"
68 '(width thickness height))
72 'lyric-syllable-interface
73 "a single piece of lyrics"
78 "Any object that is related to lyrics."
87 'metronome-mark-interface
92 'multi-measure-interface
93 "Multi measure rest, and the text or number that is printed over it."
102 'only-prebreak-interface
103 "Kill this grob after the line breaking process."
107 'parentheses-interface
108 "Parentheses for other objects"
112 'piano-pedal-interface
117 'piano-pedal-script-interface
118 "A piano pedal sign, fixed size"
122 'pitched-trill-interface
123 "A note head to indicate trill pitches"
127 'trill-pitch-accidental-interface
128 "An accidental for trill pitch"
132 'rhythmic-grob-interface
133 "Any object with a rhythmic basis. Used to determine which grobs
134 are interesting enough to maintain a hara-kiri staff."
139 'spacing-options-interface
140 "Supports setting of spacing variables"
141 '(spacing-increment shortest-duration-space))
144 'stanza-number-interface
145 "A stanza number, to be put in from of a lyrics line"
149 'string-number-interface
150 "A string number instruction"
154 'stroke-finger-interface
155 "A right hand finger instruction"
159 'system-start-text-interface
160 "A text at the beginning of a system."
161 '(text long-text collapse-height style))
163 ;;; todo: this is not typesetting info. Move to interpretation.
166 "An interface for any notes set in a tablature staff"
170 'vertically-spaceable-interface
171 "Objects that should be kept at constant vertical distances. Typically:
172 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."