]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
Merge branch 'master' of git+ssh://jneem@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / scm / define-context-properties.scm
index 7aa2fce12371aec320751081ab4d64fc97b60c7e..7dda76b16bf885aa8986e1a502dc41573c1efdb3 100644 (file)
@@ -2,7 +2,7 @@
 ;;;;
 ;;;;  source file of the GNU LilyPond music typesetter
 ;;;; 
-;;;; (c) 1998--2006  Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; (c) 1998--2006  Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 
 
@@ -38,7 +38,6 @@
      (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.")
      (associatedVoice ,string? "Name of the
 @code{Voice} that has the melody for this @code{Lyrics} line.")
      (autoBeamSettings ,list? "Specifies
@@ -187,9 +186,7 @@ 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 bar line.
-")
+     (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at every bar line. ")
      (defaultBarType ,string? "Sets the default type of bar line.
 See @code{whichBar} for information on available bar types.
 
@@ -212,11 +209,7 @@ visibility for normal (i.e. at the start of the line) key signatures.")
 extra natural sign before accidentals changing from a non-natural to 
 another non-natural.")
 
-     (extraVerticalExtent ,number-pair?
-                         "extra vertical extent, same format as @var{minimumVerticalExtent}")
-
-
-     (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.")
+     (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.  This does not work with three or more lines")
      (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the the main figure.")
      
      (figuredBassAlterationDirection ,ly:dir? "Where to put
@@ -255,6 +248,8 @@ selector for tab notation.")
      (ignoreBarChecks ,boolean? "Ignore bar checks")
      (ignoreMelismata ,boolean? "Ignore melismata for this @internalsref{Lyrics} line.")
 
+     (implicitTimeSignatureVisibility ,vector? "break visibility for the default timesignature.")
+
      (implicitBassFigures ,list? "List of bass figures that are not
 printed as numbers, but only as extender lines.")
      
@@ -266,10 +261,16 @@ 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.
 ")
+
+     ;; the definition is reversed wrt  traditional transposition
+     ;; this because \transpose { \transposition .. } won't work
+     ;; otherwise.
      (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.")
 
+     (internalBarNumber ,integer? "Contains the current barnumber. This property is used for internal timekeeping, among others by the @code{Accidental_engraver}.")
+     
      (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that
 are worth keeping an staff with @code{remove-empty} set around for.")   
      (keyAlterationOrder ,list? " Alist that defines in what order
@@ -279,9 +280,10 @@ alterations should be printed.  The format is (@var{step}
 ")
 
      (keySignature ,list? "The current key signature. This is an alist
-containing (@var{name} . @var{alter}) or ((@var{octave} . @var{name}) . @var{alter}).
- where @var{name} is from 0.. 6 and
-@var{alter} from -4 (double flat) to 4 (double sharp).
+containing (@var{step} . @var{alter}) or ((@var{octave} . @var{step})
+. @var{alter}).  where @var{step} is from 0.. 6 and @var{alter} a fraction, denoting
+alteration.  For alterations, use symbols, eg.
+@code{keySignature = #`((6 . ,FLAT))}
 ")
      (majorSevenSymbol ,markup? "How should
 the major 7th be formatted in a chord name?")
@@ -312,14 +314,14 @@ markup.  Called with 2 arguments, event and context.")
      (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.")
      (minimumFret ,number? "The tablature auto string-selecting mechanism
 selects the highest string with a fret at least @code{minimumFret}")
+     (maximumFretStretch ,number? "Don't allocate frets further than this from specified frets.")
      (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a page turn to be allowed")
      (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a repeated section for a page
 turn to be allowed within that section")
-     (minimumVerticalExtent ,number-pair? "minimum vertical extent, same
-format as @var{verticalExtent}")
      (output ,ly:music-output? "The output produced by a score-level translator during music interpretation")
      (ottavation ,string? "If set, the text for an ottava spanner. Changing
 this creates a new text spanner. ")
+     (noteToFretFunction ,procedure? "How to produce a fret diagram.  Parameters: list of note events and list of tabstring events.")
      (pedalSustainStrings ,list? "List of string to print for
 sustain-pedal. Format is (@var{up} @var{updown} @var{down}), where
 each of the three is the string to print when this is done with the
@@ -377,6 +379,7 @@ up the interpretation phase. This speeds up debugging large scores.")
 squashing for @internalsref{Pitch_squash_engraver}.")
 
      (stringNumberOrientations ,list? "See @code{fingeringOrientations}")
+     (strokeFingerOrientations ,list? "See @code{fingeringOrientations}")
      (stringOneTopmost ,boolean? "Whether the 1st string is printed on the
 top line of the tablature.")
 
@@ -440,18 +443,6 @@ property, you can make brackets last shorter.  Example
      (useBassFigureExtenders ,boolean? "Whether to use extender lines
 for repeated bass figures")
 
-     (verticalExtent ,number-pair? "Hard coded vertical extent.  The format
-is a pair of dimensions, for example, this sets the sizes of a staff
-to 10 (5+5) staff-spaces high.
-
-@example
-\\set Staff.verticalExtent = #'(-5.0 . 5.0)
-@end example
-
-
-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.")
@@ -495,7 +486,7 @@ Valid values are described in @internalsref{bar-line-interface}.
      )
 
    `((slurMelismaBusy ,boolean? "Signal if a slur is present.")
-     (originalCentralCPosition
+     (originalMiddleCPosition
       ,integer?
       "Used for temporary overriding middle C in octavation brackets. ")
      (melismaBusy ,boolean? "Signifies
@@ -517,9 +508,6 @@ 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.")
 
-     
-     (localKeySignatureChanges ,list? "Experimental. [DOCME]")
-
      (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