X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-music-properties.scm;h=78a2dec6e1b71a89dd4624e9850180088e04b36b;hb=67ff565b4ada90eeb753a866b22ddb4eaa8c6234;hp=05f9e2b221e8c518334273b06f26f78c356e650e;hpb=a1fa0e63b1bf2c61a9c19a33b7034989fb3fac05;p=lilypond.git diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm index 05f9e2b221..78a2dec6e1 100644 --- a/scm/define-music-properties.scm +++ b/scm/define-music-properties.scm @@ -1,9 +1,20 @@ -;;;; define-music-properties.scm -- part of generated backend documentation +;;;; This file is part of LilyPond, the GNU music typesetter. ;;;; -;;;; source file of the GNU LilyPond music typesetter -;;;; -;;;; (c) 1998--2009 Han-Wen Nienhuys +;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen +;;;; +;;;; LilyPond is free software: you can redistribute it and/or modify +;;;; it under the terms of the GNU General Public License as published by +;;;; the Free Software Foundation, either version 3 of the License, or +;;;; (at your option) any later version. +;;;; +;;;; LilyPond is distributed in the hope that it will be useful, +;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of +;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +;;;; GNU General Public License for more details. +;;;; +;;;; You should have received a copy of the GNU General Public License +;;;; along with LilyPond. If not, see . (define (music-property-description symbol type? description) (if (not (equal? #f (object-property symbol 'music-doc))) @@ -32,6 +43,7 @@ this @code{\\lyricsto} section.") (back-slashed number).") (bass ,boolean? "Set if this note is a bass note in a chord.") + (beat-structure ,list? "A beatStructure to be used in autobeaming.") (bracket-start ,boolean? "Start a bracket here. TODO: Use SpanEvents?") @@ -70,8 +82,10 @@ a sequential iterator. Takes a single music parameter.") "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 @@ -92,7 +106,7 @@ This property can only be defined as initializer in (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?") + (metronome-count ,number-or-pair? "How many beats in a minute?") (name ,symbol? "Name of this music object.") (no-continuation ,boolean? "If set, disallow continuation lines.") @@ -102,6 +116,9 @@ whether to allow, forbid or force a line break.") For chord inversions, this is negative.") (once ,boolean? "Apply this operation only during one time step?") (origin ,ly:input-location? "Where was this piece of music defined?") + (original-chord ,ly:music? "Original chord of a repeated chord. +Used by repeated chords in \\relative mode, to determine the first note octave") + (ottava-number ,integer? "The octavation for @code{\\ottava}.") (page-break-permission ,symbol? "When the music is at top-level, whether to allow, forbid or force a page break.") @@ -111,6 +128,8 @@ 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.") @@ -130,6 +149,7 @@ e.g., @code{cue}.") direct quotes to, e.g., @code{Voice}.") (quoted-events ,vector? "A vector of with @code{moment} and @code{event-list} entries.") + (quoted-music-clef ,string? "The clef of the voice to quote.") (quoted-music-name ,string? "The name of the voice to quote.") (quoted-transposition ,ly:pitch? "The pitch used for the quote, overriding @code{\\transposition}.") @@ -138,12 +158,13 @@ or down-stem?") (repeat-count ,integer? "Do a @code{\\repeat} how often?") + (slash-count ,integer? "The number of slashes in a single-beat repeat. +If zero, signals a beat containing varying durations.") (span-direction ,ly:dir? "Does this start or stop a spanner?") - (span-type ,string? "What kind of spanner should be created? E.g. ligature -for ligatures, or text or hairpin for (de-)crescendi. - -TODO: Consider making type into symbol.") - (span-text ,string? "The displayed text for text spanners (e.g. cresc.)") + (span-type ,symbol? "What kind of dynamic spanner should be created? +Options are @code{'text} and @code{'hairpin}.") + (span-text ,markup? "The displayed text for dynamic text spanners +(e.g., cresc.)") (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 @@ -157,8 +178,6 @@ a @code{StringNumberEvent}.") in a part.") (tempo-unit ,ly:duration? "The unit for the metronome count.") (text ,markup? "Markup expression to be printed.") - (text-type ,symbol? - "Particular type of text script (e.g., finger, dynamic).") (to-relative-callback ,procedure? "How to transform a piece of music to relative pitches.") (tonic ,ly:pitch? "Base of the scale.")