]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
Loglevels: Also document Grob:: warning functions and clean them up
[lilypond.git] / scm / define-context-properties.scm
index 5a6e67d2a613a51b26ca066f3c4ff2e4e44547e7..f59a862f1532edfad257718f0df3446ce0a84bae 100644 (file)
@@ -66,7 +66,7 @@ Each entry in the list is either a symbol or a procedure.
 
 @item symbol
 The symbol is the name of the context in which the following rules are to be
-applied. For example, if @var{context} is @rinternals{Score} then all
+applied.  For example, if @var{context} is @rinternals{Score} then all
 staves share accidentals, and if @var{context} is @rinternals{Staff} then
 all voices in the same staff share accidentals, but staves do not.
 
@@ -92,9 +92,9 @@ The current measure position.
 
 @end table
 
-The procedure returns a pair of booleans. The first states whether an extra
-natural should be added. The second states whether an accidental should be
-printed. @code{(#t . #f)} does not make sense.
+The procedure returns a pair of booleans.  The first states whether an extra
+natural should be added.  The second states whether an accidental should be
+printed.  @code{(#t . #f)} does not make sense.
 
 @end table")
      (autoBeamCheck ,procedure? "A procedure taking three
@@ -145,7 +145,7 @@ exceptions.  Contains @code{(@var{chord} . (@var{prefix-markup}
 @var{suffix-markup}))} entries.")
      (chordNameFunction ,procedure? "The function that converts lists
 of pitches to chord names.")
-        (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
+     (chordNameLowercaseMinor ,boolean? "Downcase roots of minor chords?")
      (chordNameSeparator ,markup? "The markup object used to
 separate parts of a chord name.")
      (chordNoteNamer ,procedure? "A function that converts from a pitch
@@ -257,10 +257,20 @@ containing, in the correct order, the labels to be used for lettered
 frets in tablature.")
 
 
+     (glissandoMap ,list? "A map in the form of '((source1 . target1)
+(source2 . target2) (sourcen . targetn)) showing the glissandi to
+be drawn for note columns.  The value '() will default to '((0 . 0)
+(1 . 1) (n . n)), where n is the minimal number of note-heads in
+the two note columns between which the glissandi occur.")
      (gridInterval ,ly:moment? "Interval for which to generate
 @code{GridPoint}s.")
 
 
+     (handleNegativeFrets ,symbol? "How the automatic fret calculator
+should handle calculated negative frets.  Values include @code{'ignore},
+to leave them out of the diagram completely, @code{'include}, to include
+them as calculated, and @code{'recalculate}, to ignore the specified
+string and find a string where they will fit with a positive fret number.")
      (harmonicAccidentals ,boolean? "If set, harmonic notes in chords
 get accidentals.")
      (harmonicDots ,boolean? "If set, harmonic notes in dotted chords get
@@ -312,7 +322,7 @@ containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
 
 
-     (lyricMelismaAlignment ,ly:dir? "Alignment to use for a melisma syllable.")
+     (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.")
 
 
      (majorSevenSymbol ,markup? "How should the major 7th be formatted
@@ -334,7 +344,7 @@ manual beams are considered.  Possible values include
 @code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
 @code{beamMelismaBusy}.")
      (metronomeMarkFormatter ,procedure? "How to produce a metronome
-markup.  Called with four arguments: text, duration, count and context.")
+markup.  Called with two arguments: a @code{TempoChangeEvent} and context.")
      (middleCClefPosition ,number? "The position of the middle C,
 as determined only by the clef.  This can be calculated by looking at
 @code{clefPosition} and @code{clefGlyph}.")
@@ -348,10 +358,13 @@ is used for ottava brackets.")
 half staff-spaces.  Usually determined by looking at
 @code{middleCClefPosition} and @code{middleCOffset}.")
      (midiInstrument ,string? "Name of the MIDI instrument to use.")
+     (midiMergeUnisons ,boolean? "If true, output only one MIDI note-on
+event when notes with the same pitch, in the same MIDI-file track, overlap.")
      (midiMaximumVolume ,number? "Analogous to
 @code{midiMinimumVolume}.")
      (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
 Ranges from 0 to@tie{}1.")
+     (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.")
      (minimumFret ,number? "The tablature auto string-selecting
 mechanism selects the highest string with a fret at least
 @code{minimumFret}.")
@@ -408,10 +421,13 @@ of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
 arguments an integer and context, returning whether the corresponding
 percent repeat number should be printed when @code{countPercentRepeats}
 is set.")
+     (restCompletionBusy ,boolean? "Signal whether a completion-rest is active.")
      (restNumberThreshold ,number? "If a multimeasure rest has more
 measures than this, a number is printed.")
 
-
+     (searchForVoice ,boolean? "Signal whether a search should be made
+of all contexts in the context hierarchy for a voice to provide rhythms
+for the lyrics.")
      (shapeNoteStyles ,vector? "Vector of symbols, listing style for
 each note head relative to the tonic (qv.) of the scale.")
      (shortInstrumentName ,markup? "See @code{instrumentName}.")
@@ -473,10 +489,7 @@ fret number.  It returns the text as a markup.")
      (tabStaffLineLayoutFunction ,procedure? "A function determining the
 staff position of a tablature note head.  Called with two arguments:
 the context and the string.")
-     (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
-     (tempoText ,markup? "Text for tempo marks.")
-     (tempoUnitCount ,number-or-pair? "Count for specifying tempo.")
-     (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.")
+     (tempoHideNote ,boolean? "Hide the note = count in tempo marks.")
      (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
 minute.")
      (tieWaitForNote ,boolean? "If true, tied notes do not have to