;;;; music-property-description.scm -- part of generated backend documentation
;;;;
;;;; source file of the GNU LilyPond music typesetter
-;;;;
+;;;;
;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
(map
(lambda (x) (apply music-property-description x))
`(
- (X-offset ,number? "Offset of resulting grob; only used for balloon texts.")
- (Y-offset ,number? "Offset of resulting grob; only used for balloon texts. ")
-
- (alteration ,number? "alteration for figured bass")
+ (X-offset ,number?
+ "Offset of resulting grob; only used for balloon texts.")
+ (Y-offset ,number?
+ "Offset of resulting grob; only used for balloon texts.")
+ (alteration ,number? "Alteration for figured bass.")
(absolute-octave ,integer?
"The absolute octave for a octave check note.")
(articulations ,ly:music-list?
"Articulation events specifically for this note.")
- (articulation-type ,string? "key for script definitions alist.
-
-TODO: consider making type into symbol ")
- (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")
- (bracket-start ,boolean? "start a bracket
-here. TODO: use SpanEvents?")
- (bracket-stop ,boolean? "stop a bracket here.")
+ (articulation-type ,string? "Key for script definitions alist.
+
+TODO: Consider making type into symbol.")
+ (augmented ,boolean? "This figure is for an augmented figured bass
+(with @code{+} sign).")
+ (associated-context ,string? "Name of the Voice context associated with
+this @code{\\newaddlyrics} section.")
+
+ (bass ,boolean? "Set if this note is a bass note in a chord.")
+ (bracket-start ,boolean? "Start a bracket here.
+
+TODO: Use SpanEvents?")
+ (bracket-stop ,boolean? "Stop a bracket here.")
(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")
+ (break-permission ,symbol?
+ "Whether to allow, forbid or force a line break.")
+
+ (cautionary ,boolean? "If set, this alteration needs a
+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.
+Arg@tie{}1: the music, arg@tie{}2: factor.")
+ (context-id ,string? "Name of context.")
+ (context-type ,symbol? "Type of context.")
(create-new ,boolean? "Create a fresh context.")
- (delta-step ,number? "How much should a fall change pitch?")
- (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")
+
+ (delta-step ,number? "How much should a fall change pitch?")
+ (descend-only ,boolean? "If set, this @code{\\context} only descends
+in the context tree.")
+ (denominator ,integer? "Denominator in a time signature.")
+ (digit ,integer? "Digit for fingering.")
(diminished ,boolean? "This bass figure should be slashed.")
(direction ,ly:dir? "Print this up or down?")
(drum-type ,symbol? "Which percussion instrument to play this note on.")
- (duration ,ly:duration? "Duration of this note/lyric.")
- (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. ")
- (elements-callback ,procedure? "Return a list of children, for use by a sequential iterator. Takes a single Music parameter")
- (expected-beam-count ,integer? "Expected number of non-tremolo beams in a tremolo repeat")
- (figure ,integer? "a bass figure")
- (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). ")
- (grob-value ,scheme? "The value of the grob property to set")
- (input-tag ,scheme? "Arbitrary marker to relate input and output")
+ (duration ,ly:duration? "Duration of this note or lyric.")
+
+ (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.")
+ (elements-callback ,procedure? "Return a list of children, for use by
+a sequential iterator. Takes a single music parameter.")
+ (expected-beam-count ,integer? "Expected number of non-tremolo beams
+in a tremolo repeat.")
+
+ (figure ,integer? "A bass figure.")
+ (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., @code{(beamed-lengths details)}.")
+ (grob-value ,scheme? "The value of the grob property to set.")
+
+ (input-tag ,scheme? "Arbitrary marker to relate input and output.")
(inversion ,boolean? "If set, this chord note is inverted.")
- (iterator-ctor ,procedure? "Function to construct music-event-iterator object for this Music")
-
- (label ,markup? "label of a mark.")
+ (iterator-ctor ,procedure? "Function to construct a
+@code{music-event-iterator} object for this music.")
+
+ (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}.")
- (line-break-permission ,symbol? "When the music is at top-level, whether to allow, forbid or force a line break.")
+ (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{scm/@/define-music-types.scm}.")
+ (line-break-permission ,symbol? "When the music is at top-level,
+whether to allow, forbid or force a line break.")
+
(metronome-count ,number? "How many beats in a minute?")
- (name ,symbol? "Name of this music object")
- (no-continuation ,boolean? "If set, disallow continuation lines")
- (numerator ,integer? "numerator of a time signature")
+
+ (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.")
- (origin ,ly:input-location? "where was this piece of music defined?")
- (page-break-permission ,symbol? "When the music is at top-level, whether to allow, forbid or force a page break.")
- (page-label ,symbol? "The label of a page marker")
- (page-marker ,boolean? "If true, and the music expression is found at top-level, a page marker object is instanciated instead of a score.")
- (page-turn-permission ,symbol? "When the music is at top-level, whether to allow, forbid or force a page turn.")
- (part-combine-status ,symbol?
- "Change to what kind of state? Options are
-solo1, solo2 and unisono")
+ (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-break-permission ,symbol? "When the music is at top-level,
+whether to allow, forbid or force a page break.")
+ (page-label ,symbol? "The label of a page marker.")
+ (page-marker ,boolean? "If true, and the music expression is found at
+top-level, a page marker object is instanciated instead of a score.")
+ (page-turn-permission ,symbol? "When the music is at top-level,
+whether to allow, forbid or force a page turn.")
+ (part-combine-status ,symbol? "Change to what kind of state?
+Options are @code{solo1}, @code{solo2} and @code{unisono}.")
(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.")
- (prob-property ,symbol? "The symbol of the prob property to set. ")
- (procedure ,procedure?
- "The function to run with \\applycontext.
+ (pitch ,ly:pitch? "The pitch of this note.")
+ (pitch-alist ,list? "A 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.")
+ (prob-property ,symbol? "The symbol of the prob property to set.")
+ (procedure ,procedure? "The function to run with @code{\\applycontext}.
It must take a single argument, being the context.")
- (property-operations ,list?
- "Do these operations for instantiating the context.")
- (quoted-events ,vector? "A vector of with moment/event-list entries.")
+ (property-operations ,list? "Do these operations for instantiating
+the context.")
+
+ (quoted-events ,vector? "A vector of with @code{moment} and
+@code{event-list} entries.")
(quoted-music-name ,string? "The name of the voice to quote.")
- (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")
- (repeat-count ,integer? "do a @code{\repeat} how ofen?")
+ (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, e.g., @code{Voice}.")
+ (quoted-context-id ,string? "The ID of the context to direct quotes to,
+e.g., @code{cue}.")
+ (quoted-transposition ,ly:pitch? "The pitch used for the quote,
+overriding @code{\\transposition}.")
+
+ (repeat-count ,integer? "Do a @code{\\repeat} how often?")
+
(span-direction ,ly:dir? "Does this start or stop a spanner?")
(span-type ,string? "What kind of spanner should be created?
-TODO: consider making type into symbol")
- (split-list ,list? "splitting moments for part combiner.")
- (start-callback ,procedure? "Function to compute the negative
-length of starting grace notes. This property can only be defined as
-initializer in @file{define-music-types.scm}.")
- (string-number ,integer? "The number of the string in a StringNumberEvent")
- (symbol ,symbol? "Grob name to perform an override/revert on.")
- (tags ,list? "List of symbols that for denoting extra details,
-e.g. @code{\\tag #'part ...} could tag a piece of music as only being active in a part.")
- (text-type ,symbol? "Particular type of text script (e.g. finger, dynamic).")
-
- (text ,markup? "markup expression to be printed")
+TODO: Consider making type into symbol.")
+ (split-list ,list? "Splitting moments for part combiner.")
+ (start-callback ,procedure? "Function to compute the negative length
+of starting grace notes. This property can only be defined as initializer
+in @file{scm/@/define-music-types.scm}.")
+ (string-number ,integer? "The number of the string in
+a @code{StringNumberEvent.}")
+ (symbol ,symbol? "Grob name to perform an override or revert on.")
+
+ (tags ,list? "List of symbols that for denoting extra details, e.g.,
+@code{\\tag #'part @dots{}} could tag a piece of music as only being active
+in a part.")
+ (text-type ,symbol?
+ "Particular type of text script (e.g., finger, dynamic).")
+ (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? "speed of tremolo, e.g. 16 for c4:16")
+ (to-relative-callback ,procedure? "How to transform a piece of music
+to relative pitches.")
+ (tonic ,ly:pitch? "Base of the scale.")
+ (tremolo-type ,integer? "Speed of tremolo, e.g., 16 for @code{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.")
+ (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.")
(tweaks ,list? "An alist of properties to override in the backend
--for the grob made of this event.")
- (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")
+for the grob made of this event.")
+
(untransposable ,boolean? "If set, this music is not transposed.")
- )))
+
+ (value ,scheme? "Assignment value for a translation property.")
+ (void ,boolean? "If this property is @code{#t}, then the
+music expression is to be discarded by the toplevel music handler.")
+
+ (what ,symbol? "What to change for auto-change.
+
+FIXME: Naming.")
+ )))
;;;; define-music-types.scm --
;;;;
;;;; source file of the GNU LilyPond music typesetter
-;;;;
+;;;;
;;;; (c) 1998--2006 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
;; TODO: should link back into user manual.
(define (mm-rest-child-list music)
- "Generate events for multimeasure rests, to be used by the sequential-iterator"
+ "Generate events for multimeasure rests,
+to be used by the sequential-iterator"
(let ((location (ly:music-property music 'origin))
(duration (ly:music-property music 'duration)))
(list (make-music 'BarCheck
(define-public music-descriptions
`(
(AbsoluteDynamicEvent
- . (
- (description . "Creates a dynamic mark.
+ . ((description . "Create a dynamic mark.
-Syntax: @var{note}@code{\\x},
-where x is one of \\ppp, \\pp, \\p, \\mp, \\mf, \\f, \\ff, \\fff.")
+Syntax: @var{note}@code{\\x}, where @code{\\x} is a dynamic mark like
+@code{\\ppp} or @code{\\sfz}. A complete list is in file
+@file{ly/@/dynamic-scripts-init.ly}.")
(types . (general-music event dynamic-event absolute-dynamic-event))
))
. ((description . "Print an annotation of an output element.")
(types . (general-music event annotate-output-event))
))
-
+
(ApplyContext
- . (
- (description . "Call the argument with the current context during interpreting phase")
+ . ((description . "Call the argument with the current context during
+interpreting phase.")
(types . (general-music apply-context))
(iterator-ctor . ,ly:apply-context-iterator::constructor)
))
-
- (ApplyOutputEvent
- . (
- (description . "
-Call the argument with all current grobs during interpreting phase.
-
-Syntax
-\\applyOutput #'Context FUNC
+ (ApplyOutputEvent
+ . ((description . "Call the argument with all current grobs during
+interpreting phase.
-arguments to func are 1. the grob, 2. the originating context,
-3. context where FUNC is called.
+Syntax: @code{\\applyOutput #'@var{context} @var{func}}
-")
+Arguments to @var{func} are 1.@tie{}the grob, 2.@tie{}the originating
+context, and 3.@tie{}the context where @var{func} is called.")
(types . (general-music event apply-output-event))
))
- (ArpeggioEvent
- . (
- (description . "Make an arpeggio on this note.
-Syntax:
-@var{note}-@code{\\arpeggio}")
+ (ArpeggioEvent
+ . ((description . "Make an arpeggio on this note.
+
+Syntax: @var{note}@code{-\\arpeggio}")
(types . (general-music arpeggio-event event))
))
;; todo: use articulation-event for slur as well.
- ;; separate non articulation scripts
+ ;; separate non articulation scripts
(ArticulationEvent
- . (
- (description . "Adds an articulation marking to a note.
-
-Syntax:
-@var{note}@code{X}@code{Y}, where X is a direction (up @code{^}, down
-@code{_}, or LilyPond's choice (no direction specified)), and where Y
-is an articulation (such as @code{-.}, @code{->}, @code{\\tenuto},
-@code{\\downbow}). See the user manual for details.")
+ . ((description . "Add an articulation marking to a note.
+Syntax: @var{note}@code{x}@code{y}, where @code{x} is a direction
+(@code{^} for up or @code{_} for down), or LilyPond's choice
+(no direction specified)), and where @code{y} is an articulation
+(such as @code{-.}, @code{->}, @code{\\tenuto}, @code{\\downbow}).
+See the user manual for details.")
(types . (general-music event articulation-event script-event))
- ))
+ ))
+
(AutoChangeMusic
- . (
- (description . "Used for making voices that switch between piano staves automatically.")
+ . ((description . "Used for making voices that switch between
+piano staves automatically.")
(iterator-ctor . ,ly:auto-change-iterator::constructor)
(start-callback . ,ly:music-wrapper::start-callback)
(length-callback . ,ly:music-wrapper::length-callback)
(types . (general-music music-wrapper-music auto-change-instruction))
))
+
(BarCheck
- . (
- (description .
- "Check whether this music coincides with the start of the measure.")
+ . ((description . "Check whether this music coincides with
+the start of the measure.")
(types . (general-music bar-check))
(iterator-ctor . ,ly:bar-check-iterator::constructor)
))
- (BassFigureEvent
- . (
- (description . "Print a bass-figure text")
+ (BassFigureEvent
+ . ((description . "Print a bass-figure text.")
(types . (general-music event rhythmic-event bass-figure-event))
))
-
+
(BeamEvent
- . (
- (description . "Starts or stops a beam.
+ . ((description . "Start or stop a beam.
-Syntax for manual control:
-c8-[ c c-] c8")
+Syntax for manual control: @code{c8-[ c c-] c8}")
(types . (general-music event beam-event span-event))
))
+
+ (BeamForbidEvent
+ . ((description . "Specify that a note may not auto-beamed.")
+ (types . (general-music event beam-forbid-event))
+ ))
+
(BendAfterEvent
- . ((description . "A drop/fall/doit jazz articulation")
+ . ((description . "A drop/fall/doit jazz articulation.")
(types . (general-music bend-after-event event))))
(BreathingEvent
- . (
- (description . "Creates a `breath mark' or `comma'.
+ . ((description . "Create a @q{breath mark} or @q{comma}.
-Syntax:
-@var{note}\\breathe.")
+Syntax: @var{note}@code{\\breathe}")
(types . (general-music event breathing-event))
- ))
+ ))
+
(ContextChange
- . (
- (description . "Change staves in Piano staff.
+ . ((description . "Change staves in Piano staff.
-Syntax @code{\\translator Staff = @var{new-id}}.")
- (iterator-ctor . , ly:change-iterator::constructor)
+Syntax: @code{\\change Staff = @var{new-id}}")
+ (iterator-ctor . ,ly:change-iterator::constructor)
(types . (general-music translator-change-instruction))
))
(ClusterNoteEvent
- . ((description . "A note that is part of a cluster.")
-
- ;; not a note-event, to ensure that Note_engraver doesn't eat it.
- (types . (general-music cluster-note-event melodic-event rhythmic-event event))
+ . ((description . "A note that is part of a cluster.")
+ ;; not a note-event, to ensure that Note_engraver doesn't eat it.
+ (types . (general-music cluster-note-event melodic-event
+ rhythmic-event event))
))
-
+
(ContextSpeccedMusic
- . (
- (description . "Interpret the argument music within a specific context.")
+ . ((description . "Interpret the argument music within a
+specific context.")
(iterator-ctor . ,ly:context-specced-music-iterator::constructor)
(length-callback . ,ly:music-wrapper::length-callback)
(start-callback . ,ly:music-wrapper::start-callback)
(types . (context-specification general-music music-wrapper-music))
))
-
+
(CrescendoEvent
- . (
- (description . "Begins or ends a crescendo.
+ . ((description . "Begin or end a crescendo.
-Syntax: @var{note}\\cr
-... @var{note}\\rc (you can also use \\<, \\!, \\cresc, and
-\\endcresc. See the user manual for details.).")
+Syntax: @var{note}@code{\\cr} @dots{} @var{note}@code{\\rc}
- (types . (general-music span-event span-dynamic-event crescendo-event event))
- ))
- (DecrescendoEvent
- . (
- (description . "See @ref{CrescendoEvent}.")
+You can also use @code{\\<}, @code{\\!}, @code{\\cresc}, and
+@code{\\endcresc}. See the user manual for details.")
+ (types . (general-music span-event span-dynamic-event crescendo-event
+ event))
+ ))
- (types . (general-music span-event span-dynamic-event decrescendo-event event))
+ (DecrescendoEvent
+ . ((description . "See @ref{CrescendoEvent}.")
+ (types . (general-music span-event span-dynamic-event decrescendo-event
+ event))
))
-
- (ExtenderEvent
- . (
- (description . "Extend lyrics.")
+ (ExtenderEvent
+ . ((description . "Extend lyrics.")
(types . (general-music extender-event event))
))
(Event
- . (
- (description . "Atomic music event.")
+ . ((description . "Atomic music event.")
(types . (general-music event))
))
-
+
(EventChord
- . (
- (description . "Internally used to group a set of events.")
+ . ((description . "Internally used to group a set of events.")
(iterator-ctor . ,ly:event-chord-iterator::constructor)
(length-callback . ,ly:music-sequence::maximum-length-callback)
- (to-relative-callback . ,ly:music-sequence::event-chord-relative-callback)
+ (to-relative-callback .
+ ,ly:music-sequence::event-chord-relative-callback)
(types . (general-music event-chord simultaneous-music))
))
-
(FingeringEvent
- . (
- (description . "Specify what finger to use for this note.")
+ . ((description . "Specify what finger to use for this note.")
(types . (general-music fingering-event event))
))
- (BeamForbidEvent
- . (
- (description . "Specify that a note may not auto-beamed ")
- (types . (general-music event beam-forbid-event))
+
+ (FoldedRepeatedMusic
+ . ((description . "Repeats with alternatives placed in parallel.")
+ (iterator-ctor . ,ly:folded-repeat-iterator::constructor)
+ (start-callback . ,ly:repeated-music::minimum-start)
+ (length-callback . ,ly:repeated-music::folded-music-length)
+ (types . (general-music repeated-music folded-repeated-music))
))
+
(GlissandoEvent
- . (
- (description . "Start a glissando on this note.")
+ . ((description . "Start a glissando on this note.")
(types . (general-music glissando-event event))
))
-
+
(GraceMusic
- . (
- (description . "Interpret the argument as grace notes. ")
+ . ((description . "Interpret the argument as grace notes.")
(start-callback . ,ly:grace-music::start-callback)
(length . ,ZERO-MOMENT)
(iterator-ctor . ,ly:grace-iterator::constructor)
(types . (grace-music music-wrapper-music general-music))
))
- (NoteGroupingEvent
- . (
- (description . "Start or stop grouping brackets.")
- (types . (general-music event note-grouping-event))
- ))
+
(HarmonicEvent
- . (
- (description . "Mark a note as harmonic")
+ . ((description . "Mark a note as harmonic.")
(types . (general-music event harmonic-event))
))
- (HyphenEvent
- . (
- (description . "A hyphen between lyric syllables.")
+ (HyphenEvent
+ . ((description . "A hyphen between lyric syllables.")
(types . (general-music hyphen-event event))
))
-
+
(KeyChangeEvent
- . (
- (description . "Change the key signature.
+ . ((description . "Change the key signature.
-Syntax: @code{\\key } @var{name} @var{scale}.")
+Syntax: @code{\\key} @var{name} @var{scale}")
(to-relative-callback . ,(lambda (x p) p))
(types . (general-music key-change-event event))
))
+
(LabelEvent
- . ((description . "Place a bookmarking label")
- (types . (general-music label-event event))))
+ . ((description . "Place a bookmarking label.")
+ (types . (general-music label-event event))
+ ))
+
(LaissezVibrerEvent
. ((description . "Don't damp this chord.
-Syntax: @var{note}\\laissezVibrer.")
-
+Syntax: @var{note}@code{\\laissezVibrer}")
(types . (general-music event laissez-vibrer-event))
))
+
(LigatureEvent
- . (
- (description . "Start or end a ligature.")
+ . ((description . "Start or end a ligature.")
(span-type . ligature)
(types . (general-music span-event ligature-event event))
))
+
(LineBreakEvent
- . (
- (description . "Allow, forbid or force a line break.")
+ . ((description . "Allow, forbid or force a line break.")
(types . (general-music line-break-event break-event event))
))
-
+
(LyricCombineMusic
- . (
- (description . "Align lyrics to the start of notes.
+ . ((description . "Align lyrics to the start of notes.
-Syntax @var{\\lyricsto }@var{voicename} @var{lyrics}.")
+Syntax: @code{\\lyricsto} @var{voicename} @var{lyrics}")
(length . ,ZERO-MOMENT)
(types . (general-music lyric-combine-music))
(iterator-ctor . ,ly:lyric-combine-music-iterator::constructor)
))
(LyricEvent
- . (
- (description . "A lyric syllable. Must be entered in lyrics mode, i.e.
-@code{\\lyrics @{ twinkle4 twinkle4 @} } .")
-
+ . ((description . "A lyric syllable. Must be entered in lyrics mode,
+i.e., @code{\\lyrics @{ twinkle4 twinkle4 @} }.")
(types . (general-music rhythmic-event lyric-event event))
))
+
(MarkEvent
- . (
- (description . "Insert a rehearsal mark.
+ . ((description . "Insert a rehearsal mark.
-Syntax: @code{\\mark} @var{marker},
-e.g. @code{\\mark \"A\"}.")
+Syntax: @code{\\mark} @var{marker}
+Example: @code{\\mark \"A\"}")
(types . (general-music mark-event event))
))
+
+ (MultiMeasureRestEvent
+ . ((description . "Used internally by @code{MultiMeasureRestMusic}
+to signal rests.")
+ (types . (general-music event rhythmic-event
+ multi-measure-rest-event))
+ ))
+
(MultiMeasureRestMusic
- . (
- (description . "Rests that may be compressed into Multi rests.
+ . ((description . "Rests that may be compressed into Multi rests.
-Syntax
-@code{R2.*4} for 4 measures in 3/4 time.")
+Syntax: @code{R2.*4} for 4 measures in 3/4 time.")
(iterator-ctor . ,ly:sequential-iterator::constructor)
(elements-callback . ,mm-rest-child-list)
(types . (general-music multi-measure-rest))
))
- (MultiMeasureRestEvent
- . (
- (description . "Used internally by MultiMeasureRestMusic to signal rests")
- (types . (general-music event rhythmic-event multi-measure-rest-event))
- ))
-
(MultiMeasureTextEvent
- . (
- (description . "Texts on mm rests.
+ . ((description . "Texts on multi measure rests.
-Syntax
-@code{R-\\markup @{ \\roman \"bla\" @}}. Note the explicit font switch.")
+Syntax: @code{R-\\markup @{ \\roman \"bla\" @}}
+
+Note the explicit font switch.")
(types . (general-music event multi-measure-text-event))
))
(Music
- . (
- (description . "Generic type for music expressions.")
-
- (types . (general-music))
+ . ((description . "Generic type for music expressions.")
+ (types . (general-music))
))
+
(NoteEvent
- . (
- (description . "A note.")
- (types . (general-music event note-event rhythmic-event melodic-event))
+ . ((description . "A note.")
+ (types . (general-music event note-event rhythmic-event
+ melodic-event))
))
-
- (OverrideProperty
- . (
- (description . "Extend the definition of a graphical object.
-SYNTAX
+ (NoteGroupingEvent
+ . ((description . "Start or stop grouping brackets.")
+ (types . (general-music event note-grouping-event))
+ ))
-@code{\\override [ @var{Ctxt} . ] @var{Obj} @var{prop} = @var{val}}
-")
- (types . (general-music layout-instruction-event override-property-event))
+ (OverrideProperty
+ . ((description . "Extend the definition of a graphical object.
+
+Syntax: @code{\\override} [ @var{context} @code{.} ]
+@var{object} @var{property} @code{=} @var{value}")
+ (types . (general-music layout-instruction-event
+ override-property-event))
(iterator-ctor . ,ly:push-property-iterator::constructor)
))
+
(PageBreakEvent
- . (
- (description . "Allow, forbid or force a page break.")
+ . ((description . "Allow, forbid or force a page break.")
(types . (general-music break-event page-break-event event))
))
+
(PageTurnEvent
- . (
- (description . "Allow, forbid or force a page turn.")
+ . ((description . "Allow, forbid or force a page turn.")
(types . (general-music break-event page-turn-event event))
))
+
(PartCombineMusic
- . (
- (description . "Combine two parts on a staff, either merged or
+ . ((description . "Combine two parts on a staff, either merged or
as separate voices.")
(length-callback . ,ly:music-sequence::maximum-length-callback)
(start-callback . ,ly:music-sequence::minimum-start-callback)
(types . (general-music part-combine-music))
(iterator-ctor . ,ly:part-combine-iterator::constructor)
))
+
+ (PercentEvent
+ . ((description . "Used internally to signal percent repeats.")
+ (types . (general-music event percent-event rhythmic-event))
+ ))
+
+ (PercentRepeatedMusic
+ . ((description . "Repeats encoded by percents.")
+ (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
+ (start-callback . ,ly:repeated-music::first-start)
+ (length-callback . ,ly:repeated-music::unfolded-music-length)
+ (types . (general-music repeated-music percent-repeated-music))
+ ))
+
+ (PesOrFlexaEvent
+ . ((description . "Within a ligature, mark the previous and the
+following note to form a pes (if melody goes up) or a flexa (if melody
+goes down).")
+ (types . (general-music pes-or-flexa-event event))
+ ))
+
(PhrasingSlurEvent
- . (
- (description . "Start or end phrasing slur.
+ . ((description . "Start or end phrasing slur.
-Syntax NOTE \\( and \\) NOTE")
+Syntax: @var{note}@code{\\(} and @var{note}@code{\\)}")
(types . (general-music span-event event phrasing-slur-event))
))
-
+
(PropertySet
- . (
- (description . "Set a context property.
+ . ((description . "Set a context property.
-Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}.")
+Syntax: @code{\\property @var{context}.@var{prop} = @var{scheme-val}}")
(types . (layout-instruction-event general-music))
(iterator-ctor . ,ly:property-iterator::constructor)
))
(PropertyUnset
- . (
- (description . "Remove the definition of a context @code{\\property}.")
-
+ . ((description . "Remove the definition of a context
+@code{\\property}.")
(types . (layout-instruction-event general-music))
(iterator-ctor . ,ly:property-unset-iterator::constructor)
))
- (PercentEvent
- . (
- (description . "Used internally to signal percent repeats.")
- (types . (general-music event percent-event rhythmic-event))
- ))
-
- (PesOrFlexaEvent
- . (
- (description . "Within a ligature, mark the previous and the
-following note to form a pes (if melody goes up) or a flexa (if melody
-goes down).")
-
- (types . (general-music pes-or-flexa-event event))
- ))
-
(QuoteMusic
- . (
- (description . "Quote preprocessed snippets of music. ")
+ . ((description . "Quote preprocessed snippets of music.")
(iterator-ctor . ,ly:music-wrapper-iterator::constructor)
(length-callback . ,ly:music-wrapper::length-callback)
(start-callback . ,ly:music-wrapper::start-callback)
(types . (general-music music-wrapper-music))
))
-
+
(RelativeOctaveCheck
. ((description . "Check if a pitch is in the correct octave.")
(to-relative-callback . ,ly:relative-octave-check::relative-callback)
(types . (general-music relative-octave-check))
))
-
- (RepeatedMusic
- . (
- (description . "Repeat music in different ways")
- (types . (general-music repeated-music))
+
+ (RelativeOctaveMusic
+ . ((description . "Music that was entered in relative octave notation.")
+ (to-relative-callback . ,ly:relative-octave-music::relative-callback)
+ (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
+ (length-callback . ,ly:music-wrapper::length-callback)
+ (start-callback . ,ly:music-wrapper::start-callback)
+ (types . (music-wrapper-music general-music relative-octave-music))
))
+
(RepeatTieEvent
- . (
- (description . "Ties for starting a second volta bracket.")
+ . ((description . "Ties for starting a second volta bracket.")
(types . (general-music event repeat-tie-event))
))
- (RestEvent
- . (
- (description . "A Rest.
-Syntax @code{r4} for a quarter rest. ")
+ (RepeatedMusic
+ . ((description . "Repeat music in different ways.")
+ (types . (general-music repeated-music))
+ ))
+
+ (RestEvent
+ . ((description . "A Rest.
+Syntax: @code{r4} for a quarter rest.")
(types . (general-music event rhythmic-event rest-event))
- ))
- (RevertProperty
- . (
- (description . "The opposite of @ref{OverrideProperty}: remove a
-previously added property from a graphical object definition
- ")
+ ))
+ (RevertProperty
+ . ((description . "The opposite of @ref{OverrideProperty}: remove a
+previously added property from a graphical object definition.")
(types . (general-music layout-instruction-event))
- (iterator-ctor . , ly:pop-property-iterator::constructor)
+ (iterator-ctor . ,ly:pop-property-iterator::constructor)
))
- (SequentialMusic
- . (
- (description . "Music expressions concatenated.
+ (ScriptEvent
+ . ((description . "Add an articulation mark to a note.")
+ (types . (general-music event))
+ ))
-Syntax \\sequential @{..@} or simply @{..@} .")
+ (SequentialMusic
+ . ((description . "Music expressions concatenated.
+Syntax: @code{\\sequential @{ @dots{} @}} or simply @code{@{ @dots{} @}}")
(length-callback . ,ly:music-sequence::cumulative-length-callback)
(start-callback . ,ly:music-sequence::first-start-callback)
(elements-callback . ,(lambda (m) (ly:music-property m 'elements)))
(types . (general-music sequential-music))
))
- (SoloOneEvent
- . (
- (description . "Print Solo.1")
- (part-combine-status . solo1)
- (types . (general-music event part-combine-event solo-one-event))
- ))
- (SoloTwoEvent
- . (
- (description . "Print Solo.2")
- (part-combine-status . solo2)
- (types . (general-music event part-combine-event solo-two-event))
- ))
- (UnisonoEvent
- . ((description . "Print a2")
- (part-combine-status . unisono)
- (types . (general-music event part-combine-event unisono-event))))
-
(SimultaneousMusic
- . (
- (description . "Music playing together.
-
-SYNTAX
-
-@code{ \\simultaneous @{ .. @}} or << .. >>.")
+ . ((description . "Music playing together.
+Syntax: @code{\\simultaneous @{ @dots{} @}} or @code{<< @dots{} >>}")
(iterator-ctor . ,ly:simultaneous-music-iterator::constructor)
(start-callback . ,ly:music-sequence::minimum-start-callback)
(length-callback . ,ly:music-sequence::maximum-length-callback)
- (to-relative-callback . ,ly:music-sequence::simultaneous-relative-callback)
-
+ (to-relative-callback .
+ ,ly:music-sequence::simultaneous-relative-callback)
(types . (general-music simultaneous-music))
))
-
- (SlurEvent
- . (
- (description . "Start or end slur.
-Syntax NOTE( and NOTE) ")
+ (SkipEvent
+ . ((description . "Filler that takes up duration, but does not
+print anything.
- (types . (general-music span-event event slur-event))
- ))
-
- (StaffSpanEvent
- . ((description . "Start or stop a staff symbol.")
- (types . (general-music event span-event staff-span-event))
- ))
-
- (TextSpanEvent
- . (
- (description . "Start a text spanner like 8va.....|")
- (types . (general-music span-event event text-span-event))
- ))
-
- (TrillSpanEvent
- . (
- (description . "Start a trill spanner tr~~~")
- (types . (general-music span-event event trill-span-event))
- ))
-
- (TransposedMusic
- . (
- (description . "Music that has been transposed.")
- (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
- (start-callback . ,ly:music-wrapper::start-callback)
- (length-callback . ,ly:music-wrapper::length-callback)
- (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
- (types . (music-wrapper-music general-music transposed-music))
+Syntax: @code{s4} for a skip equivalent to a quarter rest.")
+ (types . (general-music event rhythmic-event skip-event))
))
- (TimeScaledMusic
- . (
- (description . "Multiply durations, as in tuplets.
+ (SkipMusic
+ . ((description . "Filler that takes up duration, does not
+print anything, and also does not create staves or voices implicitly.
-Syntax @code{\\times @var{fraction} @var{music}}, e.g.
-@code{\\times 2/3 @{ ... @}} for triplets.
- ")
- (length-callback . ,ly:music-wrapper::length-callback)
- (start-callback . ,ly:music-wrapper::start-callback)
- (iterator-ctor . ,ly:time-scaled-music-iterator::constructor)
- (types . (time-scaled-music music-wrapper-music general-music))
+Syntax: @code{\\skip} @var{duration}")
+ (length-callback . ,ly:music-duration-length)
+ (iterator-ctor . ,ly:simple-music-iterator::constructor)
+ (types . (general-music event rhythmic-event skip-event))
))
- (TupletSpanEvent
- . (
- (description . "Used internally to signal where tuplet brackets start and stop.")
- (types . (tuplet-span-event span-event event general-music))
- ))
+ (SlurEvent
+ . ((description . "Start or end slur.
- (UnrelativableMusic
- . (
- (description . "Music that can not be converted from relative to absolute notation.
-For example, transposed music.")
- (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
- (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
- (length-callback . ,ly:music-wrapper::length-callback)
- (types . (music-wrapper-music general-music unrelativable-music))
+Syntax: @var{note}@code{(} and @var{note}@code{)}")
+ (types . (general-music span-event event slur-event))
))
- (RelativeOctaveMusic
- . (
- (description . "Music that was entered in relative octave notation.")
- (to-relative-callback . ,ly:relative-octave-music::relative-callback)
- (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
- (length-callback . ,ly:music-wrapper::length-callback)
- (start-callback . ,ly:music-wrapper::start-callback)
- (types . (music-wrapper-music general-music relative-octave-music))
+ (SoloOneEvent
+ . ((description . "Print @q{Solo@tie{}1}.")
+ (part-combine-status . solo1)
+ (types . (general-music event part-combine-event solo-one-event))
))
- (ScriptEvent
- . (
- (description . "Add an articulation mark to a note. ")
- (types . (general-music event))
+ (SoloTwoEvent
+ . ((description . "Print @q{Solo@tie{}2}.")
+ (part-combine-status . solo2)
+ (types . (general-music event part-combine-event solo-two-event))
))
- (SkipMusic
- . (
- (description . "Filler that takes up duration, does not print anything, and also
-does not create staves or voices implicitly.
-
+ (SostenutoEvent
+ . ((description . "Depress or release sostenuto pedal.")
+ (types . (general-music event pedal-event sostenuto-event))
+ ))
+ (SpacingSectionEvent
+ . ((description . "Start a new spacing section.")
+ (types . (general-music event spacing-section-event))))
-Syntax: @code{\\skip }@var{duration}.")
- (length-callback . ,ly:music-duration-length)
- (iterator-ctor . ,ly:simple-music-iterator::constructor)
- (types . (general-music event rhythmic-event skip-event))
+ (SpanEvent
+ . ((description . "Event for anything that is started at a
+different time than stopped.")
+ (types . (general-music event))
))
-
- (SkipEvent
- . (
- (description . "Filler that takes up duration, but does not print anything.
-
+ (StaffSpanEvent
+ . ((description . "Start or stop a staff symbol.")
+ (types . (general-music event span-event staff-span-event))
+ ))
-Syntax: @code{s}@var{duration}")
+ (StringNumberEvent
+ . ((description . "Specify on which string to play this note.
- (types . (general-music event rhythmic-event skip-event))
+Syntax: @code{\\@var{number}}")
+ (types . (general-music string-number-event event))
))
- (SpacingSectionEvent
- . ((description . "Start a new spacing section")
- (types . (general-music event spacing-section-event))))
-
- (SpanEvent
- . (
- (description . "Event for anything that is started at a different time than stopped.")
+ (StrokeFingerEvent
+ . ((description . "Specify with which finger to pluck a string.
- (types . (general-music event))
+Syntax: @code{\\rightHandFinger @var{text}}")
+ (types . (general-music stroke-finger-event event))
))
-
+
(SustainEvent
- . (
- (description . "Depress or release sustain pedal. ")
+ . ((description . "Depress or release sustain pedal.")
(types . (general-music event pedal-event sustain-event))
))
-
- (SostenutoEvent
- . (
- (description . "Depress or release sostenuto pedal. ")
- (types . (general-music event pedal-event sostenuto-event))
+
+ (TextScriptEvent
+ . ((description . "Print text.")
+ (types . (general-music script-event text-script-event event))
))
-
- (UnaCordaEvent
- . (
- (description . "Depress or release una-corda pedal.")
- (types . (general-music event pedal-event una-corda-event))
+
+ (TextSpanEvent
+ . ((description . "Start a text spanner, e.g., 8va.....|")
+ (types . (general-music span-event event text-span-event))
))
-
- (StringNumberEvent
- . (
- (description . "Specify on which string to play this note.
-Syntax: @code{\\@var{number}}.")
+ (TieEvent
+ . ((description . "A tie.
- (types . (general-music string-number-event event))
- ))
+Syntax: @var{note}@code{-~}")
+ (types . (general-music tie-event event))
+ ))
- (StrokeFingerEvent
- . (
- (description . "Specify with which finger to pluck a string.
+ (TimeScaledMusic
+ . ((description . "Multiply durations, as in tuplets.
-Syntax: @code{\\rightHandFinger @var{text}}.")
+Syntax: @code{\\times @var{fraction} @var{music}}, e.g.
+@code{\\times 2/3 @{ @dots{} @}} for triplets.")
+ (length-callback . ,ly:music-wrapper::length-callback)
+ (start-callback . ,ly:music-wrapper::start-callback)
+ (iterator-ctor . ,ly:time-scaled-music-iterator::constructor)
+ (types . (time-scaled-music music-wrapper-music general-music))
+ ))
- (types . (general-music stroke-finger-event event))
- ))
-
- (TextScriptEvent
- . (
- (description . "")
- (types . (general-music script-event text-script-event event))
- ))
- (TieEvent
- . (
- (description . "A tie. Entered as @var{note}-~.")
- (types . (general-music tie-event event))
+ (TransposedMusic
+ . ((description . "Music that has been transposed.")
+ (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
+ (start-callback . ,ly:music-wrapper::start-callback)
+ (length-callback . ,ly:music-wrapper::length-callback)
+ (to-relative-callback .
+ ,ly:relative-octave-music::no-relative-callback)
+ (types . (music-wrapper-music general-music transposed-music))
))
+
(TremoloEvent
- . (
- (description . "Un measured tremolo.")
+ . ((description . "Unmeasured tremolo.")
(types . (general-music event tremolo-event))
))
-
+
+ (TremoloRepeatedMusic
+ . ((iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
+ (description . "Repeated notes denoted by tremolo beams.")
+ (start-callback . ,ly:repeated-music::first-start)
+ ;; the length of the repeat is handled by shifting the note logs
+ (length-callback . ,ly:repeated-music::folded-music-length)
+ (types . (general-music repeated-music tremolo-repeated-music))
+ ))
+
(TremoloSpanEvent
. (
(description . "Tremolo over two stems")
(types . (general-music event span-event tremolo-span-event))
))
- (VoiceSeparator
- . (
- (description . "Separate polyphonic voices in simultaneous music.
+ (TrillSpanEvent
+ . ((description . "Start a trill spanner tr~~~")
+ (types . (general-music span-event event trill-span-event))
+ ))
-Syntax: @code{\\\\}")
+ (TupletSpanEvent
+ . ((description . "Used internally to signal where tuplet
+brackets start and stop.")
+ (types . (tuplet-span-event span-event event general-music))
+ ))
- (types . (separator general-music))
+ (UnaCordaEvent
+ . ((description . "Depress or release una-corda pedal.")
+ (types . (general-music event pedal-event una-corda-event))
))
- (VoltaRepeatedMusic
- . (
- (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
- (description . "")
- (start-callback . ,ly:repeated-music::first-start)
- (length-callback . ,ly:repeated-music::volta-music-length)
- (types . (general-music repeated-music volta-repeated-music))
- ))
-
(UnfoldedRepeatedMusic
- . (
+ . ((description . "DOCME")
(iterator-ctor . ,ly:unfolded-repeat-iterator::constructor)
- (description . "")
(start-callback . ,ly:repeated-music::first-start)
(types . (general-music repeated-music unfolded-repeated-music))
(length-callback . ,ly:repeated-music::unfolded-music-length)
))
- (PercentRepeatedMusic
- . (
- (description . "Repeats encoded by percents.")
- (iterator-ctor . ,ly:percent-repeat-iterator::constructor)
- (start-callback . ,ly:repeated-music::first-start)
- (length-callback . ,ly:repeated-music::unfolded-music-length)
- (types . (general-music repeated-music percent-repeated-music))
+
+ (UnisonoEvent
+ . ((description . "Print @q{a@tie{}2}.")
+ (part-combine-status . unisono)
+ (types . (general-music event part-combine-event unisono-event))))
+
+ (UnrelativableMusic
+ . ((description . "Music that cannot be converted from relative
+to absolute notation. For example, transposed music.")
+ (to-relative-callback . ,ly:relative-octave-music::no-relative-callback)
+ (iterator-ctor . ,ly:music-wrapper-iterator::constructor)
+ (length-callback . ,ly:music-wrapper::length-callback)
+ (types . (music-wrapper-music general-music unrelativable-music))
))
-
- (TremoloRepeatedMusic
- . (
- (iterator-ctor . ,ly:chord-tremolo-iterator::constructor)
- (description . "Repeated notes denoted by tremolo beams.")
- (start-callback . ,ly:repeated-music::first-start)
- ;; the length of the repeat is handled by shifting the note logs
- (length-callback . ,ly:repeated-music::folded-music-length)
- (types . (general-music repeated-music tremolo-repeated-music))
-
+ (VoiceSeparator
+ . ((description . "Separate polyphonic voices in simultaneous music.
+
+Syntax: @code{\\\\}")
+ (types . (separator general-music))
))
-
- (FoldedRepeatedMusic
- . (
- (description . "Repeats with alternatives placed in parallel. ")
- (iterator-ctor . ,ly:folded-repeat-iterator::constructor)
- (start-callback . ,ly:repeated-music::minimum-start)
- (length-callback . ,ly:repeated-music::folded-music-length)
- (types . (general-music repeated-music folded-repeated-music))
+
+ (VoltaRepeatedMusic
+ . ((description . "DOCME")
+ (iterator-ctor . ,ly:volta-repeat-iterator::constructor)
+ (start-callback . ,ly:repeated-music::first-start)
+ (length-callback . ,ly:repeated-music::volta-music-length)
+ (types . (general-music repeated-music volta-repeated-music))
))
))
(define-safe-public (make-music name . music-properties)
"Create a music object of given name, and set its properties
-according to `music-properties', a list of alterning property symbols
+according to @code{music-properties}, a list of alterning property symbols
and values. E.g:
- (make-music 'OverrideProperty
+ (make-music 'OverrideProperty
'symbol 'Stem
'grob-property 'thickness
'grob-value (* 2 1.5))"
(ly:warning (_ "See music-types.scm for supported repeats"))
'VoltaRepeatedMusic))))
(make-music music-name)))
-
projects / lilypond.git / commitdiff