Imported Upstream version 2.14.2

[lilypond.git] / scm / define-music-properties.scm

diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm
index 6150a2ad040027a81ba6bc5fb1f9dba14c99b0c6..5e1159363654e42981a8677b67ff785cf91d3dc9 100644 (file)
--- a/scm/define-music-properties.scm
+++ b/scm/define-music-properties.scm
@@ -1,9 +1,20 @@
-;;;; music-property-description.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--2008  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>

 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>

+;;;;
+;;;; 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 <http://www.gnu.org/licenses/>.

 
 (define (music-property-description symbol type? description)
   (if (not (equal? #f (object-property symbol 'music-doc)))
 
 (define (music-property-description symbol type? description)
   (if (not (equal? #f (object-property symbol 'music-doc)))


@@ -16,27 +27,25 @@
   (map
    (lambda (x) (apply music-property-description x))
    `(
   (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.")

      (absolute-octave ,integer?
                      "The absolute octave for a octave check note.")
      (absolute-octave ,integer?
                      "The absolute octave for a octave check note.")

-     (articulations ,ly:music-list?
-                   "Articulation events specifically for this note.")
+     (alteration ,number? "Alteration for figured bass.")

      (articulation-type ,string? "Key for script definitions alist.
 
 TODO: Consider making type into symbol.")
      (articulation-type ,string? "Key for script definitions alist.
 
 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
+this @code{\\lyricsto} section.")

      (augmented ,boolean? "This figure is for an augmented figured bass
 (with @code{+} sign).")
      (augmented-slash ,boolean? "This figure is for an augmented figured bass
 (back-slashed number).")
      (augmented ,boolean? "This figure is for an augmented figured bass
 (with @code{+} sign).")
      (augmented-slash ,boolean? "This figure is for an augmented figured bass
 (back-slashed number).")

-     (associated-context ,string? "Name of the Voice context associated with
-this @code{\\newaddlyrics} section.")
+     (autosplit-end ,boolean? "Duration of event was truncated by automatic
+splitting in @code{Completion_heads_engraver}.")

 
      (bass ,boolean? "Set if this note is a bass note in a chord.")
 
      (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?")
      (bracket-start ,boolean? "Start a bracket here.
 
 TODO: Use SpanEvents?")


@@ -56,29 +65,29 @@ Arg@tie{}1: the music, arg@tie{}2: factor.")
      (create-new ,boolean? "Create a fresh context.")
 
      (delta-step ,number? "How much should a fall change pitch?")
      (create-new ,boolean? "Create a fresh context.")
 
      (delta-step ,number? "How much should a fall change pitch?")

+     (denominator ,integer? "Denominator in a time signature.")

      (descend-only ,boolean? "If set, this @code{\\context} only descends
 in the context tree.")
      (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 or lyric.")
 
      (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 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.")
      (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.")
+     (error-found ,boolean?
+                 "If true, a parsing error was found in this expression.")

 
      (figure ,integer? "A bass figure.")
 
      (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.")
      (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
 
      (grob-property ,symbol? "The symbol of the grob property to set.")
      (grob-property-path ,list? "A list of symbols, locating a nested grob


@@ -99,16 +108,19 @@ 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.")
 
      (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.")
      (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.")
      (octavation ,integer? "This pitch was octavated by how many octaves?
 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?")
      (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.")
 
      (page-break-permission ,symbol? "When the music is at top-level,
 whether to allow, forbid or force a page break.")


@@ -117,9 +129,11 @@ whether to allow, forbid or force a page break.")
 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.")
 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}.")
      (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? "A list of pitches jointly forming the scale
 of a key signature.")
      (pitch ,ly:pitch? "The pitch of this note.")
      (pitch-alist ,list? "A list of pitches jointly forming the scale
 of a key signature.")


@@ -131,50 +145,53 @@ It must take a single argument, being the context.")
      (property-operations ,list? "Do these operations for instantiating
 the context.")
 
      (property-operations ,list? "Do these operations for instantiating
 the context.")
 

+     (quoted-context-id ,string? "The ID of the context to direct quotes to,
+e.g., @code{cue}.")
+     (quoted-context-type ,symbol? "The name of the context to
+direct quotes to, e.g., @code{Voice}.")

      (quoted-events ,vector? "A vector of with @code{moment} and
 @code{event-list} entries.")
      (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-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, 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}.")
      (quoted-transposition ,ly:pitch? "The pitch used for the quote,
 overriding @code{\\transposition}.")

+     (quoted-voice-direction ,ly:dir? "Should the quoted voice be up-stem
+or down-stem?")

 
      (repeat-count ,integer? "Do a @code{\\repeat} how often?")
 
 
      (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-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.")
+     (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.)")
+     (spanner-id ,string? "Identifier to distinguish concurrent spanners.")

      (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
      (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.}")
+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.")
      (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.")
      (tempo-unit ,ly:duration? "The unit for the metronome count.")

+     (text ,markup? "Markup expression to be printed.")

      (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.")
      (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.")

+     (tweaks ,list? "An alist of properties to override in the backend
+for the grob made of this event.")

      (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.")
      (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.")

 
      (untransposable ,boolean? "If set, this music is not transposed.")
 
 
      (untransposable ,boolean? "If set, this music is not transposed.")
 


@@ -185,4 +202,10 @@ music expression is to be discarded by the toplevel music handler.")
      (what ,symbol? "What to change for auto-change.
 
 FIXME: Naming.")
      (what ,symbol? "What to change for auto-change.
 
 FIXME: Naming.")

+
+     (X-offset ,number?
+              "Offset of resulting grob; only used for balloon texts.")
+
+     (Y-offset ,number?
+              "Offset of resulting grob; only used for balloon texts.")

     )))
     )))