Web-ja: update introduction

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

diff --git a/scm/define-music-properties.scm b/scm/define-music-properties.scm
index a6b910c7db6c60527c3ffeaef8bff2792696f211..211af8afb366b1f5cde58fec3c349a0169dc85f1 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--2015  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


@@ -28,19 +28,25 @@
    (lambda (x) (apply music-property-description x))
    `(
      (absolute-octave ,integer?
    (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.")
      (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.")
      (articulations ,ly:music-list?
      (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
+                    "Articulation events specifically for this note.")
+     (associated-context ,string? "Name of the context associated with

 this @code{\\lyricsto} section.")
 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).")
+     (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).")
+     (augmented-slash ,boolean? "This figure is for an augmented
+figured bass (back-slashed number).")

      (automatically-numbered ,boolean? "Should a footnote be automatically
 numbered?")
      (autosplit-end ,boolean? "Duration of event was truncated by automatic
      (automatically-numbered ,boolean? "Should a footnote be automatically
 numbered?")
      (autosplit-end ,boolean? "Duration of event was truncated by automatic


@@ -54,14 +60,15 @@ TODO: Use SpanEvents?")
      (bracket-stop ,boolean? "Stop a bracket here.")
      (break-penalty ,number? "Penalty for line break hint.")
      (break-permission ,symbol?
      (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.")
 
      (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.")
+     (class ,symbol? "The class name of an event class.")
+     (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.")
      (context-id ,string? "Name of context.")
      (context-type ,symbol?  "Type of context.")
      (create-new ,boolean? "Create a fresh context.")


@@ -83,25 +90,25 @@ 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?
      (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.")
+                  "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.")
 
      (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
 property, e.g., @code{(beamed-lengths details)}.")
      (grob-value ,scheme? "The value of the grob property to set.")
 
 
      (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.")
 

+     (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
 @code{music-event-iterator} object for this music.")
 
      (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
 @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.
      (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.


@@ -111,6 +118,15 @@ 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?")

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

 
      (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,9 +135,9 @@ 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?")
      (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,
      (ottava-number ,integer? "The octavation for @code{\\ottava}.")
 
      (page-break-permission ,symbol? "When the music is at top-level,


@@ -132,20 +148,18 @@ 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?")
      (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.")
      (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.")
 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.")
      (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.")

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


@@ -167,10 +181,9 @@ If zero, signals a beat containing varying durations.")
      (span-direction ,ly:dir? "Does this start or stop a spanner?")
      (span-type ,symbol? "What kind of dynamic spanner should be created?
 Options are @code{'text} and @code{'hairpin}.")
      (span-direction ,ly:dir? "Does this start or stop a spanner?")
      (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.")
+     (span-text ,markup? "The displayed text for dynamic text
+spanners (e.g., cresc.)")
+     (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}.")
      (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}.")


@@ -200,14 +213,16 @@ 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.
 
 FIXME: Naming.")
 
      (X-offset ,number?
 
      (what ,symbol? "What to change for auto-change.
 
 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?
 
      (Y-offset ,number?

-              "Offset of resulting grob; only used for balloon texts.")
-    )))
+               "Offset of resulting grob; only used for balloon texts.")
+     )))