;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 1998--2005 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@cs.uu.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(define (music-property-description symbol type? description)
(augmented ,boolean? "This figure is for an augmented figured bass (with +) sign.")
(associated-context ,string? "Name of the Voice context associated with this \\newaddlyrics section")
(bass ,boolean? "Set if this note is a bass note in a chord")
+ (break-penalty ,number? "Penalty for line break hint.")
+ (break-permission ,symbol? "Whether to allow, forbid or force a line break.")
(cautionary ,boolean? "If set, this alteration needs cautionary accidental")
(change-to-id ,string? "name of the context to change to ")
(change-to-type ,symbol? "type of the context to change to.")
(compress-procedure ,procedure? "compress this music expression. Argument 1: the music, arg 2: factor")
(context-id ,string? "name of context")
(context-type ,symbol? "type of context")
- (descend-only ,boolean? "If set, this @code{\\context} will only
-descend in the context tree.")
+ (create-new ,boolean? "Create a fresh context.")
+ (descend-only ,boolean? "If set, this @code{\\context} will only descend in the context tree.")
(denominator ,integer? "denominator in a time signature")
(digit ,integer? "digit for fingering")
(diminished ,boolean? "This bass figure should be slashed.")
(error-found ,boolean? "If true, a parsing error was found in this expression")
(element ,ly:music? "The single child of a Music_wrapper music object, or the body of a repeat.")
(elements ,ly:music-list? "A list of elements for sequential of simultaneous music, or the alternatives of repeated music. ")
+ (expected-beam-count ,integer? "Expected number of non-tremolo beams in a tremolo repeat")
(force-accidental ,boolean? "If set, a cautionary accidental should always be printed on this note")
(grob-property ,symbol? "The symbol of the grob property to set. ")
(grob-property-path ,list? "A list of symbols, locating a nested grob property, e.g. (beamed-lengths details). ")
(label ,markup? "label of a mark.")
(last-pitch ,ly:pitch? "The last pitch after relativization.")
(length ,ly:moment? "The duration of this music")
- (length-callback ,procedure? "How to compute the duration of this music. This property
-can only be defined as initializer in @file{define-music-types.scm}.")
+ (length-callback ,procedure? "How to compute the duration of this music. This property can only be defined as initializer in @file{define-music-types.scm}.")
(name ,symbol? "Name of this music object")
(no-continuation ,boolean? "If set, disallow continuation lines")
(numerator ,integer? "numerator of a time signature")
(once ,boolean? "Apply this operation only during one time step?")
- (octavation ,integer?
- "This pitch was octavated by how many octaves?
-For chord inversions, this is negative.")
+ (octavation ,integer? "This pitch was octavated by how many octaves? For chord inversions, this is negative.")
(origin ,ly:input-location? "where was this piece of music defined?")
- (page-penalty ,number? "Penalty for page break hint.")
- (penalty ,number? "Penalty for line break hint.")
+ (parenthesize ,boolean? "Enclose resulting objects in parentheses?")
(pitch ,ly:pitch? "the pitch of this note")
(pitch-alist ,list? "list of pitches jointly forming the scale of a key signature")
(pop-first ,boolean? "Do a revert before we try to do a override on some grob property.")
(quoted-voice-direction ,ly:dir? "Should the quoted voice be up-stem or down-stem?")
(quoted-context-type ,symbol? "The name of the context to direct quotes to, eg., @code{Voice}.")
(quoted-context-id ,string? "The id of the context to direct quotes to, eg., @code{cue}.")
+ (quoted-transposition ,ly:pitch? "The pitch used for the quote, overriding \\transposition")
(to-relative-callback ,procedure? "How to transform a piece of music to relative pitches")
(tweaks ,list? "An alist of properties to override in the backend
for the grob made of this event.")
(text ,markup? "markup expression to be printed")
(tempo-unit ,ly:duration? "The unit for the metronome count.")
(tonic ,ly:pitch? "Base of the scale")
- (tremolo-type ,integer? "")
+ (tremolo-type ,integer? "speed of tremolo, e.g. 16 for c4:16")
(trill-pitch ,ly:pitch? "Pitch of other note of the trill.")
(type ,symbol? "The type of this music object. Determines iteration in some cases.")
(types ,list? "The types of this music object; determines by what
engraver this music expression is processed.")
(value ,scheme? "Assignment value for a
translation property")
+ (void ,boolean? "If this property is #t, then the music expression is to be
+discarded by the toplevel music handler.")
(what ,symbol? "What to change for auto-change. FIXME, naming")
(part-combine-status ,symbol?
"Change to what kind of state? Options are