]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
*** empty log message ***
[lilypond.git] / scm / define-context-properties.scm
index 3606f842267581782bddc97548395aea07512a7c..3bf7c51fc010f99021335111382018fce841b46c 100644 (file)
@@ -1,9 +1,9 @@
-;;;; translator-property-description.scm -- part of backend documentation
+;;;; define-context-properties.scm -- part of backend documentation
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c)  1998--2004  Han-Wen Nienhuys <hanwen@cs.uu.nl>
-;;;;                 Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 
 
 (define-public all-translation-properties '())
 (define (translator-property-description symbol type? description)
  (if (not (equal? #f (object-property symbol 'translation-doc)))
       (begin
-       (ly:warn  "Redefining ~S " symbol)
-       (exit 2)
-      ))
+       (ly:warn "Redefining ~S " symbol)
+       (exit 2)))
   
   (set-object-property! symbol 'translation-type? type?)
   (set-object-property! symbol 'translation-doc description)
   (set! all-translation-properties (cons symbol all-translation-properties))
-  symbol
-  )
+  symbol)
 
 (define-public all-user-translation-properties
   (map
@@ -30,7 +28,7 @@
      (alignBassFigureAccidentals ,boolean?
                                 "If true, then the accidentals are aligned in bass figure context.")
 
-     (allowBeamBreak ,boolean? "If true allow line breaks for  beams over bar lines.")
+     (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")
      (associatedVoice ,string? "Name of the
 @code{Voice} that has the melody for this @code{Lyrics} line.")
      (autoBeamSettings ,list? "Specifies
@@ -227,7 +225,9 @@ the @code{instr} property labels following lines.")
      (instrumentEqualizer ,procedure? "
 Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument.
 ")
-     (instrumentTransposition ,ly:pitch? "Define the transposition of the instrument. This is used to transpose the MIDI output, and @code{\\quote}s.")
+     (instrumentTransposition ,ly:pitch? "Defines the transposition of
+the instrument. Its value is the pitch that sounds like middle C. This
+is used to transpose the MIDI output, and @code{\\quote}s.")
 
      (keyAccidentalOrder ,list? " Alist that defines in what order
 alterations should be printed.  The format is (@var{name}
@@ -298,9 +298,10 @@ context.")
      (rehearsalMark ,integer? "The last rehearsal mark printed.")
      (repeatCommands ,list? "This property is read to find any command of the form @code{(volta . @var{x})}, where @var{x} is a string or @code{#f}")
      (restNumberThreshold ,number?
-                         "If a multimeasure rest takes less
-than this number of measures, no number is printed. ")
-
+                         "If a multimeasure rest has more measures
+than this, a number is printed. ")
+     (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
+head relative to the tonic (qv.) of the scale.")
      (skipBars ,boolean? "If set to true, then
 skip the empty bars that are produced by multimeasure notes and rests.
 These bars will not appear on the printed output.  If not set (the
@@ -311,13 +312,13 @@ with other voices is preserved.
 
 @example
 @@lilypond[fragment,verbatim,center]
-r1 r1*3 R1*3  \\\\property Score.skipBars= ##t r1*3 R1*3
+r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
 @@end lilypond
 @end example
 ")
      (skipTypesetting ,boolean?
                      "When true, all no typesetting is done, speeding
-up  the interpretation phase. This speeds up debugging large scores.")
+up the interpretation phase. This speeds up debugging large scores.")
      (soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
      (soloText ,string? "text for begin of solo when part-combining.")
      (squashedPosition ,integer? " Vertical position of
@@ -369,8 +370,8 @@ is called to determine the text to print on a tuplet bracket.")
 
      (tupletSpannerDuration ,ly:moment? "
 Normally a tuplet bracket is as wide as the
-@code{\\times} expression that gave rise to it. By setting this
-property, you can make brackets last shorter. Example
+@code{\\times} expression that gave rise to it.  By setting this
+property, you can make brackets last shorter.  Example
 
 @example
 @@lilypond[verbatim,fragment]
@@ -393,9 +394,13 @@ to 10 (5+5) staffspaces high.
 @end example
 
 
-This does not work for Voice or any other context  that doesn't form a
+This does not work for Voice or any other context that doesn't form a
 vertical group.")
-
+     
+     (verticallySpacedContexts ,list? "List of symbols, containing
+context names whose vertical axis groups should be taken into account for
+vertical spacing of systems.")
+     
      (vocalName ,markup? "Name of a vocal line.")
      (vocNam ,markup? "Name of a vocal line, short version.")
 
@@ -438,7 +443,7 @@ Valid values are described in @internalsref{bar-line-interface}.
      (melismaBusy ,boolean? "Signifies
 whether a melisma is active. This can be used to signal melismas on
 top of those automatically detected. ")
-     (graceSettings ,vector?
+     (graceSettings ,list?
                    "Overrides for grace notes. This property should
 be manipulated through the @code{add-grace-property} function.")
      (currentCommandColumn ,ly:grob? "Grob that is X-parent to all
@@ -452,7 +457,7 @@ for this staff.")
      (localKeySignature ,list? "the key signature at this point in the
 measure.  The format is the same as for keySignature, but can also
 contain ((@var{octave} . @var{name}) . (@var{alter} . @var{barnumber}))
-pairs. It is reset at every bar line."  )
+pairs. It is reset at every bar line.")
 
      
      (localKeySignatureChanges ,list? "Experimental. [DOCME]")
@@ -462,7 +467,7 @@ pairs. It is reset at every bar line."  )
 conses. This is for internal (C++) use only.  This property contains
 the grobs which are still busy (e.g. note heads, spanners, etc.)
 ")
-     (barCheckLastFail ,ly:moment? "Where in  the measure did the last barcheck fail?") 
+     (barCheckLastFail ,ly:moment? "Where in the measure did the last barcheck fail?") 
      (associatedVoiceContext ,ly:context? "The context object of the Voice that has the melody for this Lyrics.")
      (acceptHashTable ,vector? "Internal
 variable: store table with MusicName to Engraver entries.")
@@ -488,8 +493,9 @@ event types that should be duplicated for @code{\\quote} commands.")
      (instrumentSupport ,grob-list? "list of grobs to attach instrument name
 to.")
      (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
-     )
-   ))
+     (tweakCount ,number? "Number of otherwise unique Contexts.")
+     (tweakRank ,number? "Identify otherwise unique Contexts.")
+     )))
 
 (define-public all-translation-properties
   (append all-user-translation-properties