X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-properties.scm;h=211af8afb366b1f5cde58fec3c349a0169dc85f1;hb=HEAD;hp=9387294636c793d83a9d04c1e989af2431685ff9;hpb=00e988e3411483174d55606b5ac61f3feee504fd;p=lilypond.git diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm index 9387294636..211af8afb3 100644 --- a/scm/define-music-properties.scm +++ b/scm/define-music-properties.scm @@ -1,6 +1,6 @@ ;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2015 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen ;;;; ;;;; LilyPond is free software: you can redistribute it and/or modify @@ -28,7 +28,7 @@ (lambda (x) (apply music-property-description x)) `( (absolute-octave ,integer? - "The absolute octave for a octave check note.") + "The absolute octave for an octave check note.") (alteration ,number? "Alteration for figured bass.") (alternative-dir ,ly:dir? "Indicates if an AlternativeMusic is the First (-1), Middle (0), or Last (1) of group of alternate endings.") @@ -38,8 +38,10 @@ lettering should be incremented.") TODO: Consider making type into symbol.") (articulations ,ly:music-list? - "Articulation events specifically for this note.") - (associated-context ,string? "Name of the Voice context associated with + "Articulation events specifically for this note.") + (associated-context ,string? "Name of the context associated with +this @code{\\lyricsto} section.") + (associated-context-type ,symbol? "Type of the context associated with this @code{\\lyricsto} section.") (augmented ,boolean? "This figure is for an augmented figured bass (with @code{+} sign).") @@ -58,16 +60,15 @@ 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.") + "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.") (class ,symbol? "The class name of an event class.") - (compress-procedure ,procedure? "Compress this music expression. -Arg@tie{}1: the music, arg@tie{}2: factor.") (context ,ly:context? "The context to which an event is sent.") + (context-change-list ,list? "Context changes for @code{\\autochange} or @code{\\partcombine}.") (context-id ,string? "Name of context.") (context-type ,symbol? "Type of context.") (create-new ,boolean? "Create a fresh context.") @@ -89,14 +90,12 @@ 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.") (error-found ,boolean? - "If true, a parsing error was found in this expression.") - (events ,list? "A list of events contained in this event.") + "If true, a parsing error was found in this expression.") (figure ,integer? "A bass figure.") (footnote-text ,markup? "Text to appear in a footnote.") (force-accidental ,boolean? "If set, a cautionary accidental should always be printed on this note.") - (forced-type ,symbol? "Override for the part-combiner.") (grob-property ,symbol? "The symbol of the grob property to set.") (grob-property-path ,list? "A list of symbols, locating a nested grob @@ -109,7 +108,7 @@ property, e.g., @code{(beamed-lengths details)}.") (iterator-ctor ,procedure? "Function to construct a @code{music-event-iterator} object for this music.") - (label ,markup? "Label of a mark.") + (label ,number-or-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. @@ -119,6 +118,12 @@ This property can only be defined as initializer in whether to allow, forbid or force a line break.") (metronome-count ,number-or-pair? "How many beats in a minute?") + (midi-extra-velocity ,integer? "How much louder or softer should +this note be in MIDI output? The default is 0.") + (midi-length ,procedure? "Function to determine how long to play +a note in MIDI. It should take a moment (the written length of the +note) and a context, and return a moment (the length to play the +note).") (moment ,ly:moment? "The moment at which an event happens.") (music-cause ,ly:music? "The music object that is the cause of an event.") @@ -143,16 +148,13 @@ 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.") (parenthesize ,boolean? "Enclose resulting objects in parentheses?") - (partial-duration ,ly:duration? "The length of a partial measure as a -duration.") (part-combine-status ,symbol? "Change to what kind of state? Options are @code{solo1}, @code{solo2} and @code{unisono}.") (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 + (pop-first ,boolean? "Do a revert before we try to do an 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 @@ -181,8 +183,7 @@ If zero, signals a beat containing varying durations.") Options are @code{'text} and @code{'hairpin}.") (span-text ,markup? "The displayed text for dynamic text spanners (e.g., cresc.)") - (spanner-id ,string? "Identifier to distinguish concurrent spanners.") - (split-list ,list? "Splitting moments for part combiner.") + (spanner-id ,key? "Identifier to distinguish concurrent spanners.") (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}.") @@ -220,8 +221,8 @@ repeat element list.") FIXME: Naming.") (X-offset ,number? - "Offset of resulting grob; only used for balloon texts.") + "Offset of resulting grob; only used for balloon texts.") (Y-offset ,number? - "Offset of resulting grob; only used for balloon texts.") - ))) + "Offset of resulting grob; only used for balloon texts.") + )))