]> git.donarmstrong.com Git - lilypond.git/blobdiff - scm/define-context-properties.scm
Loglevels: Add ly:input-warning, ly:music-warning Scheme functions
[lilypond.git] / scm / define-context-properties.scm
index 755c9fdf344728213ea2e47201b90efcc401291d..dab5211f14372444171626f23fb0ef3120175ee8 100644 (file)
@@ -1,6 +1,6 @@
 ;;;; This file is part of LilyPond, the GNU music typesetter.
 ;;;;
-;;;; Copyright (C) 1998--2010  Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2011  Han-Wen Nienhuys <hanwen@xs4all.nl>
 ;;;;                  Jan Nieuwenhuizen <janneke@gnu.org>
 ;;;;
 ;;;; LilyPond is free software: you can redistribute it and/or modify
@@ -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
@@ -174,6 +174,12 @@ crescendi.  Available values are @samp{hairpin} and @samp{text}.  If unset,
 a hairpin crescendo is used.")
      (crescendoText ,markup? "The text to print at start of non-hairpin
 crescendo, i.e., @samp{cresc.}.")
+     (cueClefGlyph ,string? "Name of the symbol within the music font.")
+     (cueClefOctavation ,integer? "Add this much extra octavation.
+Values of 7 and -7 are common.")
+     (cueClefPosition ,number? "Where should the center of the clef
+symbol go, measured in half staff spaces from the center of the
+staff.")
      (currentBarNumber ,integer? "Contains the current barnumber.
 This property is incremented at every bar line.")
 
@@ -188,6 +194,9 @@ non-hairpin decrescendo, i.e., @samp{dim.}.")
 
 This variable is read by @rinternals{Timing_translator} at
 @rinternals{Score} level.")
+     (defaultStrings ,list? "A list of strings to use in calculating
+frets for tablatures and fretboards if no strings are provided in
+the notes for the current moment.")
      (doubleRepeatType ,string? "Set the default bar line for double
 repeats.")
      (doubleSlurs ,boolean? "If set, two slurs are created for every
@@ -207,6 +216,8 @@ values.")
 
      (explicitClefVisibility ,vector? "@samp{break-visibility}
 function for clef changes.")
+     (explicitCueClefVisibility ,vector? "@samp{break-visibility}
+function for cue clef changes.")
      (explicitKeySignatureVisibility ,vector? "@samp{break-visibility}
 function for explicit key changes.  @samp{\\override} of the
 @code{break-visibility} property will set the visibility for normal
@@ -246,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
@@ -323,10 +344,13 @@ 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}.")
+     (middleCCuePosition ,number? "The position of the middle C,
+as determined only by the clef of the cue notes.  This can be calculated by
+looking at @code{cueClefPosition} and @code{cueClefGlyph}.")
      (middleCOffset ,number? "The offset of
 middle C from the position given by @code{middleCClefPosition} This
 is used for ottava brackets.")
@@ -334,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}.")
@@ -361,6 +388,8 @@ Changing this creates a new text spanner.")
 translator during music interpretation.")
 
 
+     (partCombineTextsOnNote ,boolean? "Print part-combine texts only on
+the next note rather than immediately on rests or skips.")
      (pedalSostenutoStrings ,list? "See @code{pedalSustainStrings}.")
      (pedalSostenutoStyle ,symbol? "See @code{pedalSustainStyle}.")
      (pedalSustainStrings ,list? "A list of strings to print for
@@ -392,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}.")
@@ -436,7 +468,7 @@ value is only used once, and then it is erased.")
      (stringOneTopmost ,boolean? "Whether the first string is
 printed on the top line of the tablature.")
      (stringTunings ,list? "The tablature strings tuning.  It is a list
-of the pitch (in semitones) of each string (starting with the lower
+of the pitches of each string (starting with the lowest numbered
 one).")
      (strokeFingerOrientations ,list? "See
 @code{fingeringOrientations}.")
@@ -457,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? "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
@@ -503,9 +532,6 @@ setting this property, you can make brackets last shorter.
      (useBassFigureExtenders ,boolean? "Whether to use extender lines
 for repeated bass figures.")
 
-     (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.")
      (voltaSpannerDuration ,ly:moment? "This specifies the maximum
 duration to use for the brackets printed for @code{\\alternative}.