]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
* scm/define-grobs.scm (all-grob-descriptions): remove arch-*
[lilypond.git] / scm / define-context-properties.scm
index f5404a7d8b66218d35a197cf6647e1d96079a1b4..d15ed9b30340df60fea37cb075d7852b8af7a455 100644 (file)
@@ -1,8 +1,8 @@
-;;;; 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>
+;;;; (c) 1998--2005  Han-Wen Nienhuys <hanwen@cs.uu.nl>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 
 
@@ -10,9 +10,7 @@
 
 (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:error (_ "symbol ~S redefined" symbol)))
   
   (set-object-property! symbol 'translation-type? type?)
   (set-object-property! symbol 'translation-doc description)
      (apply translator-property-description x))
    `(
      (aDueText ,string? "Text to print at a unisono passage.")
+     (alignBelowContext ,string? "Where to insert newly created context in vertiical alignment.")
+     (alignAboveContext ,string? "Where to insert newly created context in vertiical alignment.")
      (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
@@ -74,6 +74,9 @@ immediately, and if @var{laziness} is @code{#t} then the accidental
 lasts forever.
 @end table
 ")
+     (autoBeamCheck ,procedure? "Procedure taking three
+arguments, CONTEXT, DIR start/stop (-1 or 1) and TEST shortest
+note in the beam.  A non-#f return value starts or stops the auto beam.")
      (autoBeaming ,boolean? "If set to true then beams are generated
 automatically.")
 
@@ -88,7 +91,7 @@ printed automatically; they must be explicitly created with
 are still counted.  Bar generation will resume according to that count
 if this property is unset.
 ")
-
+     
      (barAlways ,boolean? "If set to true a bar line is drawn after each
 note.")
 
@@ -134,6 +137,9 @@ Contains (@var{chord} . @var{markup}) entries.")
      (chordNameSeparator ,markup?
                         "The markup object used to separate
  parts of a chord name.")
+     (chordPrefixSpacer ,number?
+                       "The space added between the root symbol and the prefix
+ of a chord name")
      (chordChanges ,boolean? "Only show changes in chords scheme?")
      (clefGlyph ,string? "Name of the symbol within the music font.")
      (clefOctavation ,integer? "Add
@@ -206,9 +212,13 @@ switches by a thin line")
 determines where fingerings are put relative to the chord being
 fingered.")
 
+     (firstClef ,boolean? "If true, create a new clef when starting a
+staff.")
      (forceClef ,boolean? "Show clef symbol, even if it has not
 changed. Only active for the first clef after the property is set, not
 for the full staff.")
+     (gridInterval ,ly:moment?
+                  "Interval for which to generate @ref{GridPoint}s")
 
      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 get accidentals.")
@@ -216,6 +226,7 @@ get accidentals.")
 highest pitch on the instrument. This used by the automatic string
 selector for tab notation.")
 
+     (ignoreBarChecks ,boolean? "Ignore bar checks")
      (ignoreMelismata ,boolean? "Ignore melismata for this @internalsref{Lyrics} line.")
      (instr ,markup? "See @code{instrument}")
 
@@ -229,6 +240,8 @@ Function taking a string (instrument name), and returning a (@var{min} . @var{ma
 the instrument. Its value is the pitch that sounds like middle C. This
 is used to transpose the MIDI output, and @code{\\quote}s.")
 
+     (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that
+are worth keeping a RemoveEmptyStaff staff around for.")   
      (keyAccidentalOrder ,list? " Alist that defines in what order
 alterations should be printed.  The format is (@var{name}
 . @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from
@@ -312,18 +325,19 @@ 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
 squashing for @internalsref{Pitch_squash_engraver}.")
 
+     (stringNumberOrientations ,list? "See @code{fingeringOrientations}")
      (stringOneTopmost ,boolean? "Whether the 1st string is printed on the
 top line of the tablature.")
 
@@ -351,6 +365,8 @@ the system/staff? Set to @code{SystemStartBrace},
 takes a string number, a list of string tunings and Pitch object. It
 returns the text as a string.")
 
+     (tieWaitForNote ,boolean? "If true, tied notes do not have to follow each other directly.
+This can be used for writing out arpeggios")
      (timeSignatureFraction ,number-pair?
                            "pair of numbers, signifying the time
 signature. For example @code{#'(4 . 4)} is a 4/4 time signature.")
@@ -370,8 +386,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]
@@ -394,7 +410,7 @@ 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
@@ -457,7 +473,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]")
@@ -467,7 +483,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.")