]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
remove split around-space hack.
[lilypond.git] / scm / define-context-properties.scm
index 1f2533d1f53cb333c3fcb2affb44bb9e4b0a06bc..c041e85cfeceb9bcf98f8534450e3ab9bb1222dd 100644 (file)
@@ -30,7 +30,7 @@
      (alignBassFigureAccidentals ,boolean?
                                 "If true, then the accidentals are aligned in bass figure context.")
 
-     (allowBeamBreak ,boolean? "If true allow line breaks for  beams over barlines.")
+     (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
@@ -99,27 +99,15 @@ when finding a barcheck.")
 
      (barNumberVisibility ,procedure? "Procedure that takes an int and
 returns whether the corresponding bar number should be printed")
-     (bassFigureFormatFunction ,procedure? "Procedure that produces a markup text. It takes a list of @code{BassFigureEvent}s, and a context.")
+     (bassFigureFormatFunction ,procedure? "Procedure that is called
+to produce the formatting for a @code{BassFigure} grob. It takes a
+list of @code{BassFigureEvent}s, a context, and the grob to format.")
      (beatLength ,ly:moment? "The length of one beat in this time signature.")
      (beatGrouping ,list?
-                  "List of beatgroups. Eg. in 5/8 time @code{'(2 3)}.")
+                  "List of beatgroups, e.g., in 5/8 time @code{'(2
+3)}.")
 
 
-     (breakAlignOrder ,list? "Defines the order in which
-prefatory matter (clefs, key signatures) appears, eg. this puts the
-key signatures after the bar lines:
-
-@example
-       \\property Score.breakAlignOrder = #'(
-         span-bar
-         breathing-sign
-         clef
-         staff-bar
-         key
-         time-signature
-       )
-@end example
-")
 
      (middleCPosition ,number? "Place of the middle C, measured in half
 staffspaces.  Usually determined by looking at @code{clefPosition} and
@@ -155,11 +143,11 @@ symbol go, measured in half staff spaces from the center of the staff.")
      (connectArpeggios ,boolean? " If set, connect arpeggios across
 piano staff.")
      (createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
-     (crescendoText ,markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}")
+     (crescendoText ,markup? "Text to print at start of non-hairpin crescendo, i.e.: @samp{cresc.}")
      (crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
 One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
 @samp{dotted-line}.  If unset, hairpin type is used.")
-     (decrescendoText ,markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}")
+     (decrescendoText ,markup? "Text to print at start of non-hairpin decrescendo, i.e.: @samp{dim.}")
 
      (drumPitchTable ,hash-table? "A table mapping percussion
 instruments (symbols) to pitches.")
@@ -169,12 +157,12 @@ drums to layout settings.  Predefined values: @samp{drums-style},
 @samp{timbales-style}, @samp{congas-style}, @samp{bongos-style} and
 @samp{percussion-style}.
 
-The layout style is a hash table, containing the drum-pitches (eg. the
+The layout style is a hash table, containing the drum-pitches (e.g. the
 symbol @samp{hihat}) as key, and a list (@var{notehead-style}
 @var{script} @var{vertical-position}) as values.
  ")
      (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at
-every barline.
+every bar line.
 ")
      (defaultBarType ,string? "Sets the default type of bar line.
 See @code{whichBar} for information on available bar types.
@@ -273,12 +261,6 @@ markup.  Called with 2 arguments, event and context.")
 selects the highest string with a fret at least @var{minimumFret}")
      (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
 format as @var{verticalExtent}")
-     (recordEventSequence ,procedure? "When
-@internalsref{Recording_group_engraver} is in this context, then upon
-termination of the context, this function is called with current
-context and a list of music objects.  The list of contains entries
-with start times, music objects and whether they are processed in this
-context.")
      (ottavation ,string? "If set, the text for an ottava spanner. Changing
 this creates a new text spanner. ")
      (pedalSustainStrings ,list? "List of string to print for
@@ -291,10 +273,18 @@ pedal.")
 sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
      (pedalUnaCordaStyle ,symbol? "see @code{pedalSustainStyle}.")
      (pedalSostenutoStyle ,symbol? "see @code{pedalSustainStyle}.")
+     (printKeyCancellation ,boolean? "Print restoration alterations before a key signature change. ")
      (printOctaveNames ,boolean? "Print octave marks for the NoteNames 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}")
+     (recordEventSequence ,procedure? "When
+@internalsref{Recording_group_engraver} is in this context, then upon
+termination of the context, this function is called with current
+context and a list of music objects.  The list of contains entries
+with start times, music objects and whether they are processed in this
+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. ")
@@ -345,7 +335,7 @@ at beat positions by only drawing one beam over the beat.")
 the system/staff? Set to @code{SystemStartBrace},
 @code{SystemStartBracket} or @code{SystemStartBar}.")
 
-     (tablatureFormat ,procedure? "Function formatting a tab notehead; it
+     (tablatureFormat ,procedure? "Function formatting a tab note head; it
 takes a string number, a list of string tunings and Pitch object. It
 returns the text as a string.")
 
@@ -388,7 +378,7 @@ is a pair of dimensions, for example, this sets the sizes of a staff
 to 10 (5+5) staffspaces high.
 
 @example
-\set Staff.verticalExtent = #'(-5.0 . 5.0)
+\\set Staff.verticalExtent = #'(-5.0 . 5.0)
 @end example
 
 
@@ -410,7 +400,7 @@ alternative is very large.")
 
      (whichBar
       ,string?
-      "This property is read to determine what type of barline to create.
+      "This property is read to determine what type of bar line to create.
 
 Example:
 @example
@@ -459,9 +449,9 @@ pairs. It is reset at every bar line."  )
      (finalizations ,list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
      (busyGrobs ,list? "a queue of (@var{end-moment} . @var{GROB})
 conses. This is for internal (C++) use only.  This property contains
-the grobs which are still busy (eg. noteheads, spanners, etc.)
+the grobs which are still busy (e.g. note heads, spanners, etc.)
 ")
-     (barCheckLastFail ,ly:moment? "Where in  the measurze 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.")
@@ -481,7 +471,7 @@ Script_engraver for typesetting note-super/subscripts. See
 ")
      (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
      (stavesFound ,grob-list? "list of all staff-symbols found.")
-     (instrumentSupport ,ly:grob-list? "list of grobs to attach instrument name
+     (instrumentSupport ,grob-list? "list of grobs to attach instrument name
 to.")
      (tieMelismaBusy ,boolean? "Signal whether a tie is present.")
      )