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@cs.uu.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
24 'bass-figure-alignment-interface
30 "Any kind of loudness sign"
34 'dynamic-line-spanner-interface
35 "Dynamic line spanner"
40 "A fingering instruction"
44 'string-number-interface
45 "A string number 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 thickness))
60 'ligature-bracket-interface
61 "A bracket indicating a ligature in the original edition"
62 '(width thickness height))
66 'lyric-syllable-interface
67 "a single piece of lyrics"
72 "Any object that is related to lyrics."
81 'metronome-mark-interface
86 'multi-measure-interface
87 "Multi measure rest, and the text or number that is printed over it."
96 'only-prebreak-interface
97 "Kill this grob after the line breaking process."
101 'parentheses-interface
102 "Parentheses for other objects"
106 'piano-pedal-interface
111 'pitched-trill-interface
112 "A note head to indicate trill pitches"
116 'rhythmic-grob-interface
117 "Any object with a rhythmic basis. Used to determine which grobs
118 are interesting enough to maintain a hara-kiri staff."
122 'stanza-number-interface
123 "A stanza number, to be put in from of a lyrics line"
127 'system-start-text-interface
128 "A text at the beginning of a system."
129 '(text long-text collapse-height style))
131 ;;; todo: this is not typesetting info. Move to interpretation.
134 "An interface for any notes set in a tablature staff"
138 'vertically-spaceable-interface
139 "Objects that should be kept at constant vertical distances. Typically:
140 @internalsref{VerticalAxisGroup} objects of @internalsref{Staff} contexts."