Doc-es: update CHANGES.

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

diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm
index a6b910c7db6c60527c3ffeaef8bff2792696f211..42aa0e023812dd51c30ec6e0342216dab33594a4 100644 (file)
--- 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.
 ;;;;
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;

-;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2012  Han-Wen Nienhuys <hanwen@xs4all.nl>

 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
 ;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify


@@ -30,6 +30,10 @@
      (absolute-octave ,integer?
                      "The absolute octave for a octave check note.")
      (alteration ,number? "Alteration for figured bass.")
      (absolute-octave ,integer?
                      "The absolute octave for a 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.")
+     (alternative-increment ,integer? "The number of times an alternative's
+lettering should be incremented.")

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


@@ -60,8 +64,10 @@ TODO: Use SpanEvents?")
 cautionary accidental.")
      (change-to-id ,string? "Name of the context to change to.")
      (change-to-type ,symbol? "Type of the context to change to.")
 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.")
      (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-id ,string? "Name of context.")
      (context-type ,symbol?  "Type of context.")
      (create-new ,boolean? "Create a fresh context.")
      (context-id ,string? "Name of context.")
      (context-type ,symbol?  "Type of context.")
      (create-new ,boolean? "Create a fresh context.")


@@ -84,6 +90,7 @@ simultaneous music, or the alternatives of repeated music.")
 a sequential iterator.  Takes a single music parameter.")
      (error-found ,boolean?
                  "If true, a parsing error was found in this expression.")
 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.")

 
      (figure ,integer? "A bass figure.")
      (footnote-text ,markup? "Text to appear in a footnote.")
 
      (figure ,integer? "A bass figure.")
      (footnote-text ,markup? "Text to appear in a footnote.")


@@ -96,6 +103,7 @@ always be printed on this note.")
 property, e.g., @code{(beamed-lengths details)}.")
      (grob-value ,scheme? "The value of the grob property to set.")
 
 property, e.g., @code{(beamed-lengths details)}.")
      (grob-value ,scheme? "The value of the grob property to set.")
 

+     (id ,symbol? "The ID of an event.")

      (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 a
      (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 a


@@ -111,6 +119,9 @@ 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?")
 whether to allow, forbid or force a line break.")
 
      (metronome-count ,number-or-pair? "How many beats in a minute?")

+     (moment ,ly:moment? "The moment at which an event happens.")
+     (music-cause ,ly:music? "The music object that is the cause of
+an event.")

 
      (name ,symbol? "Name of this music object.")
      (no-continuation ,boolean? "If set, disallow continuation lines.")
 
      (name ,symbol? "Name of this music object.")
      (no-continuation ,boolean? "If set, disallow continuation lines.")


@@ -119,6 +130,8 @@ whether to allow, forbid or force a line break.")
      (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?")
      (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?")

+     (ops ,scheme? "The operations to apply during the creation of a
+context.")

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


@@ -146,6 +159,7 @@ on some grob property.")
 It must take a single argument, being the context.")
      (property-operations ,list? "Do these operations for instantiating
 the context.")
 It must take a single argument, being the context.")
      (property-operations ,list? "Do these operations for instantiating
 the context.")

+     (property-path ,symbol? "The path of a property.")

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


@@ -200,6 +214,8 @@ engraver this music expression is processed.")
      (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.")
      (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.")

+     (volta-repeats ,list? "A list that is transformed into a volta
+repeat element list.")

 
      (what ,symbol? "What to change for auto-change.
 
 
      (what ,symbol? "What to change for auto-change.