-;;;; define-context-properties.scm -- part of backend documentation
+;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; source file of the GNU LilyPond music typesetter
-;;;;
-;;;; (c) 1998--2007 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2015 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;;
+;;;; LilyPond is free software: you can redistribute it and/or modify
+;;;; it under the terms of the GNU General Public License as published by
+;;;; the Free Software Foundation, either version 3 of the License, or
+;;;; (at your option) any later version.
+;;;;
+;;;; LilyPond is distributed in the hope that it will be useful,
+;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;;;; GNU General Public License for more details.
+;;;;
+;;;; You should have received a copy of the GNU General Public License
+;;;; along with LilyPond. If not, see <http://www.gnu.org/licenses/>.
(define-public all-translation-properties '())
(define (translator-property-description symbol type? description)
(if (not (and
- (symbol? symbol)
- (procedure? type?)
- (string? description)))
+ (symbol? symbol)
+ (procedure? type?)
+ (string? description)))
(throw 'init-format-error))
-
-
+
+
(if (not (equal? #f (object-property symbol 'translation-doc)))
- (ly:error (_ "symbol ~S redefined" symbol)))
-
+ (ly:error (_ "symbol ~S redefined") symbol))
+
(set-object-property! symbol 'translation-type? type?)
(set-object-property! symbol 'translation-doc description)
(set! all-translation-properties (cons symbol all-translation-properties))
`(
;; TODO FIXME
-
+
+ (accidentalGrouping ,symbol? "If set to @code{'voice}, accidentals
+on the same note in different octaves may be horizontally staggered
+if in different voices.")
(aDueText ,markup? "Text to print at a unisono passage.")
- (alignBelowContext ,string? "Where to insert newly created context in
-vertiical alignment.")
+ (additionalBassStrings ,list? "The additional tablature bass-strings, which
+will not get a seprate line in TabStaff. It is a list of the pitches of each
+string (starting with the lowest numbered one).")
+ (additionalPitchPrefix ,string? "Text with which to prefix
+additional pitches within a chord name.")
(alignAboveContext ,string? "Where to insert newly created context in
-vertiical alignment.")
+vertical alignment.")
(alignBassFigureAccidentals ,boolean? "If true, then the accidentals
are aligned in bass figure context.")
- (associatedVoice ,string? "Name of the @code{Voice} that has the
+ (alignBelowContext ,string? "Where to insert newly created context in
+vertical alignment.")
+ (alternativeNumberingStyle ,symbol? "The style of an alternative's bar
+numbers. Can be @code{numbers} for going back to the same number or
+@code{numbers-with-letters} for going back to the same number with letter
+suffixes. No setting will not go back in measure-number time.")
+ (alternativeRestores ,symbol-list? "Timing variables that are
+restored to their value at the start of the first alternative in
+subsequent alternatives.")
+ (associatedVoice ,string? "Name of the context (see
+@code{associatedVoiceType} for its type, usually @code{Voice}) that
+has the melody for this @code{Lyrics} line.")
+ (associatedVoiceType ,symbol? "Type of the context that has the
melody for this @code{Lyrics} line.")
(autoAccidentals ,list? "List of different ways to typeset an
accidental.
@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.
@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
-arguments, @var{context}, @var{dir} [start/stop (-1 or 1)], and
+arguments, @var{context}, @var{dir} [start/@/stop (-1 or 1)], and
@var{test} [shortest note in the beam]. A non-@code{#f} return value
starts or stops the auto beam.")
- (autoBeamSettings ,list? "Specifies when automatically generated
-beams should begin and end. See @ruser{Setting automatic beam
-behavior} for more information.")
(autoBeaming ,boolean? "If set to true then beams are generated
automatically.")
(autoCautionaries ,list? "List similar to @code{autoAccidentals},
but it controls cautionary accidentals rather than normal ones. Both
lists are tried, and the one giving the most accidentals wins. In
case of draw, a normal accidental is typeset.")
- (automaticBars ,boolean? "If set to true then bar lines will not
+ (automaticBars ,boolean? "If set to false then bar lines will not
be printed automatically; they must be explicitly created with a
-@code{\\bar} command. Unlike the @code{\\cadenza} keyword, measures
-are still counted. Bar generation will resume according to that count
-if this property is unset.")
+@code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures
+are still counted. Bar line 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.")
(barCheckSynchronize ,boolean? "If true then reset
@code{measurePosition} when finding a bar check.")
- (barNumberVisibility ,procedure? "A Procedure that takes an
-integer and returns whether the corresponding bar number should be
-printed.")
+ (barNumberFormatter ,procedure? "A procedure that takes a bar
+number, measure position, and alternative number and returns a markup
+of the bar number to print.")
+ (barNumberVisibility ,procedure? "A procedure that takes a bar
+number and a measure position and returns whether the corresponding
+bar number should be printed. Note that the actual print-out of
+bar numbers is controlled with the @code{break-visibility} property.
+
+The following procedures are predefined:
+
+@table @code
+@item all-bar-numbers-visible
+Enable bar numbers for all bars, including the first one and broken
+bars (which get bar numbers in parentheses).
+
+@item first-bar-number-invisible
+Enable bar numbers for all bars (including broken bars) except the
+first one. If the first bar is broken, it doesn't get a bar number
+either.
+
+@item first-bar-number-invisible-save-broken-bars
+Enable bar numbers for all bars (including broken bars) except the
+first one. A broken first bar gets a bar number.
+
+@item first-bar-number-invisible-and-no-parenthesized-bar-numbers
+Enable bar numbers for all bars except the first bar and broken bars.
+This is the default.
+
+@item (every-nth-bar-number-visible @var{n})
+Assuming @var{n} is value@tie{}2, for example, this enables bar numbers
+for bars 2, 4, 6, etc.
+
+@item (modulo-bar-number-visible @var{n} @var{m})
+If bar numbers 1, 4, 7, etc., should be enabled, @var{n}@tie{}(the modulo)
+must be set to@tie{}3 and @var{m}@tie{}(the division remainder) to@tie{}1.
+@end table")
+
+ (baseMoment ,ly:moment? "Smallest unit of time that will stand on its
+own as a subdivided section.")
(bassFigureFormatFunction ,procedure? "A 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.")
- (bassStaffProperties ,list? "An alist of property settings to
-apply for the down staff of @code{PianoStaff}. Used by
-@code{\\autochange}.")
- (beatLength ,ly:moment? "The length of one beat in this time
-signature.")
- (beatGrouping ,list? "A list of beatgroups, e.g., in 5/8 time
-@code{'(2 3)}.")
-
+ (beamExceptions ,list? "An alist of exceptions to autobeam rules
+that normally end on beats.")
+ (beamHalfMeasure ,boolean? "Whether to allow a beam to begin
+halfway through the measure in triple time, which could look like 6/8.")
+ (beatStructure ,list? "List of @code{baseMoment}s that are combined
+to make beats.")
(chordChanges ,boolean? "Only show changes in chords scheme?")
- (chordNameFunction ,procedure? "The function that converts lists
-of pitches to chord names.")
(chordNameExceptions ,list? "An alist of chord exceptions.
Contains @code{(@var{chord} . @var{markup})} entries.")
(chordNameExceptionsFull ,list? "An alist of full chord
(chordNameExceptionsPartial ,list? "An alist of partial chord
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?")
(chordNameSeparator ,markup? "The markup object used to
separate parts of a chord name.")
+ (slashChordSeparator ,markup? "The markup object used to separate
+a chord name from its root note in case of inversions or slash
+chords.")
(chordNoteNamer ,procedure? "A function that converts from a pitch
object to a text markup. Used for single pitches.")
(chordPrefixSpacer ,number? "The space added between the root
(chordRootNamer ,procedure? "A function that converts from a pitch
object to a text markup. Used for chords.")
(clefGlyph ,string? "Name of the symbol within the music font.")
- (clefOctavation ,integer? "Add this much extra octavation.
+ (clefTransposition ,integer? "Add this much extra transposition.
Values of 7 and -7 are common.")
+ (clefTranspositionFormatter ,procedure? "A procedure that takes the
+Transposition number as a string and the style as a symbol and returns a
+markup.")
+ (clefTranspositionStyle ,symbol? "Determines the way the ClefModifier
+grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
+and @samp{bracketed}.")
(clefPosition ,number? "Where should the center of the clef
symbol go, measured in half staff spaces from the center of the
staff.")
(completionBusy ,boolean? "Whether a completion-note head is playing.")
+ (completionFactor ,rational-or-procedure?
+"When @code{Completion_heads_engraver} and
+@code{Completion_rest_engraver} need to split a note or rest with a
+scaled duration, such as @code{c2*3}, this specifies the scale factor
+to use for the newly-split notes and rests created by the engraver.
+
+If @code{#f}, the completion engraver uses the scale-factor of
+each duration being split.
+
+If set to a callback procedure, that procedure is called with the
+context of the completion engraver, and the duration to be split.")
+ (completionUnit ,ly:moment? "Sub-bar unit of completion.")
(connectArpeggios ,boolean? "If set, connect arpeggios across
piano staff.")
(countPercentRepeats ,boolean? "If set, produce counters for
the clef is changed.")
(createSpacing ,boolean? "Create @code{StaffSpacing} objects?
Should be set for staves.")
+ (crescendoSpanner ,symbol? "The type of spanner to be used for
+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.}.")
- (crescendoSpanner ,symbol? "The type of spanner to be used for
-crescendi. Available values are @samp{hairpin}, @samp{line},
-@samp{dashed-line}, @samp{dotted-line}. If unset, a hairpin crescendo
-is used.")
+ (cueClefGlyph ,string? "Name of the symbol within the music font.")
+ (cueClefTransposition ,integer? "Add this much extra transposition.
+Values of 7 and -7 are common.")
+ (cueClefTranspositionFormatter ,procedure? "A procedure that
+takes the Transposition number as a string and the style as a symbol
+and returns a markup.")
+ (cueClefTranspositionStyle ,symbol? "Determines the way the ClefModifier
+grob is displayed. Possible values are @samp{default}, @samp{parenthesized}
+and @samp{bracketed}.")
+ (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.")
- (decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
+ (decrescendoSpanner ,symbol? "The type of spanner to be used for
+decrescendi. Available values are @samp{hairpin} and @samp{text}. If
+unset, a hairpin decrescendo is used.")
(decrescendoText ,markup? "The text to print at start of
non-hairpin decrescendo, i.e., @samp{dim.}.")
(defaultBarType ,string? "Set the default type of bar line. See
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.")
+ (doubleRepeatSegnoType ,string? "Set the default bar line for
+the combinations double repeat with segno. Default is @samp{:|.S.|:}.")
(doubleRepeatType ,string? "Set the default bar line for double
repeats.")
(doubleSlurs ,boolean? "If set, two slurs are created for every
instruments (symbols) to pitches.")
(drumStyleTable ,hash-table? "A hash table which maps drums to
layout settings. Predefined values: @samp{drums-style},
-@samp{timbales-style}, @samp{congas-style}, @samp{bongos-style}, and
-@samp{percussion-style}.
+@samp{agostini-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 (e.g.,
the symbol @samp{hihat}) as keys, and a list
@code{(@var{notehead-style} @var{script} @var{vertical-position})} as
values.")
-
+ (endRepeatSegnoType ,string? "Set the default bar line for the
+combinations ending of repeat with segno. Default is @samp{:|.S}.")
+ (endRepeatType ,string? "Set the default bar line for the ending
+of repeats.")
(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
-(i.e., at the start of the line) key signatures.")
+@code{break-visibility} property will set the visibility for
+normal (i.e., at the start of the line) key signatures.")
(extendersOverRests ,boolean? "Whether to continue extenders as
they cross a rest.")
(extraNatural ,boolean? "Whether to typeset an extra natural sign
-before accidentals changing from a non-natural to another
-non-natural.")
+before accidentals that reduce the effect of a previous alteration.")
(figuredBassAlterationDirection ,ly:dir? "Where to put alterations
(figuredBassPlusDirection ,ly:dir? "Where to put plus signs
relative to the main figure.")
(fingeringOrientations ,list? "A list of symbols, containing
-@samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list
+@samp{left}, @samp{right}, @samp{up} and/@/or @samp{down}. This list
determines where fingerings are put relative to the chord being
fingered.")
(firstClef ,boolean? "If true, create a new clef when starting a
(followVoice ,boolean? "If set, note heads are tracked across
staff switches by a thin line.")
(fontSize ,number? "The relative size of all grobs in a context.")
- (forbidBreak ,boolean? "If set to @code{##t}, prevent a line break
+ (forbidBreak ,boolean? "If set to @code{#t}, prevent a line break
at this point.")
(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.")
-
-
+ (fretLabels ,list? "A list of strings or Scheme-formatted markups
+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
@rinternals{Lyrics} line.")
(implicitBassFigures ,list? "A list of bass figures that are not
printed as numbers, but only as extender lines.")
- (implicitTimeSignatureVisibility ,vector? "break visibility for
-the default time signature.")
+ (initialTimeSignatureVisibility ,vector? "break visibility for
+the initial time signature.")
+ (includeGraceNotes ,boolean? "Do not ignore grace notes for
+@rinternals{Lyrics}.")
(instrumentCueName ,markup? "The name to print if another
instrument is to be taken.")
+ (instrumentEqualizer ,procedure? "A function taking a
+string (instrument name), and returning a @code{(@var{min} . @var{max})}
+pair of numbers for the loudness range of the instrument.")
(instrumentName ,markup? "The name to print left of a staff. The
-@code{instrument} property labels the staff in the first system, and
-the @code{instr} property labels following lines.")
- (instrumentEqualizer ,procedure? "A function taking a string
-(instrument name), and returning a @code{(@var{min} . @var{max})} pair
-of numbers for the loudness range of the instrument.")
- ;; the definition is reversed wrt traditional transposition
- ;; otherwise \transpose { \transposition .. } won't work
+@code{instrumentName} property labels the staff in the first system, and
+the @code{shortInstrumentName} property labels following lines.")
(instrumentTransposition ,ly:pitch? "Define the transposition of
-the instrument. Its value is the pitch that sounds like middle@tie{}C.
-This is used to transpose the MIDI output, and @code{\\quote}s.")
+the instrument. Its value is the pitch that sounds when the instrument
+plays written 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? "A list of symbols, signifying grob
interfaces that are worth keeping a staff with @code{remove-empty} set
-around for.")
+around for.")
(keyAlterationOrder ,list? "An alist that defines in what order
-alterations should be printed. The format is @code{(@var{step}
-. @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and
+alterations should be printed. The format is
+@code{(@var{step} . @var{alter})},
+where @var{step} is a number from 0 to@tie{}6 and
@var{alter} from -2 (sharp) to 2 (flat).")
- (keySignature ,list? "The current key signature. This is an alist
-containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} .
-@var{step}) . @var{alter})}, where @var{step} is a number in the range
-0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For
-alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.")
+ (keyAlterations ,list? "The current key signature. This is an alist
+containing @code{(@var{step} . @var{alter})} or
+@code{((@var{octave} . @var{step}) . @var{alter})}, where @var{step}
+is a number in the range 0 to@tie{}6 and @var{alter} a fraction,
+denoting alteration. For alterations, use symbols, e.g.
+@code{keyAlterations = #`((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
(melismaBusyProperties ,list? "A list of properties (symbols) to
determine whether a melisma is playing. Setting this property will
influence how lyrics are aligned to notes. For example, if set to
-@code{#'(melismaBusy beamMelismaBusy)}, only manual melismata and
+@code{'(melismaBusy beamMelismaBusy)}, only manual melismata and
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.")
- (midiInstrument ,string? "Name of the MIDI instrument to use.")
- (midiMaximumVolume ,number? "Analogous to
-@code{midiMinimumVolume}.")
- (midiMinimumVolume ,number? "Set the minimum loudness for MIDI.
-Ranges from 0 to@tie{}1.")
+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.")
(middleCPosition ,number? "The place of the middle C, measured in
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{staff} (default), @code{instrument} or @code{voice}.")
+ (midiBalance ,number? "Stereo balance for the MIDI channel
+associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
+where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
+and@tie{}1 (@code{#RIGHT}) correspond to leftmost emphasis, center
+balance, and rightmost emphasis, respectively.")
+ (midiPanPosition ,number? "Pan position for the MIDI channel
+associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1,
+where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER})
+and@tie{}1 (@code{#RIGHT}) correspond to hard left, center, and hard
+right, respectively.")
+ (midiExpression ,number? "Expression control for the MIDI
+channel associated with the current context. Ranges from 0
+to@tie{}1 (0=off,@tie{}1=full effect).")
+ (midiReverbLevel ,number? "Reverb effect level for the MIDI
+channel associated with the current context. Ranges from 0
+to@tie{}1 (0=off,@tie{}1=full effect).")
+ (midiChorusLevel ,number? "Chorus effect level for the MIDI
+channel associated with the current context. Ranges from 0
+to@tie{}1 (0=off,@tie{}1=full effect).")
(minimumFret ,number? "The tablature auto string-selecting
mechanism selects the highest string with a fret at least
@code{minimumFret}.")
(minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a
repeated section for a page turn to be allowed within that section.")
+ (minorChordModifier ,markup? "Markup displayed following the root
+for a minor chord")
- (noteToFretFunction ,procedure? "How to produce a fret diagram.
-Parameters: A list of note events and a list of tabstring events.")
-
+ (noChordSymbol ,markup? "Markup to be displayed for rests in a
+ChordNames context.")
+ (noteToFretFunction ,procedure? "Convert list of notes and list of
+defined strings to full list of strings and fret numbers.
+Parameters: The context, a list of note events, a list of
+tabstring events, and the fretboard grob if a fretboard is desired.")
+ (nullAccidentals ,boolean? "The @code{Accidental_engraver}
+generates no accidentals for notes in contexts were this is set.
+In addition to supressing the printed accidental, this option removes
+any effect the note would have had on accidentals in other voices.")
(ottavation ,markup? "If set, the text for an ottava spanner.
Changing this creates a new text spanner.")
translator during music interpretation.")
+ (partCombineForced ,symbol? "Override for the partcombine
+decision. Can be @code{apart}, @code{chords}, @code{unisono},
+@code{solo1}, or @code{solo2}.")
+ (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
notation.")
- (recordEventSequence ,procedure? "When
-@code{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 a list of commands
of the form @code{(list 'volta @var{x})}, where @var{x} is a string or
@code{#f}. @code{'end-repeat} is also accepted as a command.")
+ (repeatCountVisibility ,procedure? "A procedure taking as
+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.")
-
-
+ (restrainOpenStrings ,boolean? "Exclude open strings from the
+automatic fret calculator.")
+
+ (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.")
+ (segnoType ,string? "Set the default bar line for a requested segno.
+Default is @samp{S}.")
(shapeNoteStyles ,vector? "Vector of symbols, listing style for
each note head relative to the tonic (qv.) of the scale.")
- (shortInstrumentName ,markup? "See @code{instrument}.")
+ (shortInstrumentName ,markup? "See @code{instrumentName}.")
(shortVocalName ,markup? "Name of a vocal line, short version.")
(skipBars ,boolean? "If set to true, then skip the empty bars
that are produced by multimeasure notes and rests. These bars will
@rinternals{Pitch_squash_engraver}.")
(staffLineLayoutFunction ,procedure? "Layout of staff lines,
@code{traditional}, or @code{semitone}.")
+ (magnifyStaffValue ,positive? "The most recent value set with
+@code{\\magnifyStaff}.")
(stanza ,markup? "Stanza @q{number} to print before the start of a
verse. Use in @code{Lyrics} context.")
+ (startRepeatSegnoType ,string? "Set the default bar line for the
+combinations beginning of repeat with segno. Default is @samp{S.|:}.")
+ (startRepeatType ,string? "Set the default bar line for the beginning
+of repeats.")
(stemLeftBeamCount ,integer? "Specify the number of beams to draw
on the left side of the next note. Overrides automatic beaming. The
value is only used once, and then it is erased.")
(stemRightBeamCount ,integer? "See @code{stemLeftBeamCount}.")
+ (strictBeatBeaming ,boolean? "Should partial beams reflect the
+beat structure even if it causes flags to hang out?")
(stringNumberOrientations ,list? "See
@code{fingeringOrientations}.")
(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}.")
(subdivideBeams ,boolean? "If set, multiple beams will be
-subdivided at beat positions by only drawing one beam over the beat.")
+subdivided at @code{baseMoment} positions by only drawing one beam over the beat.")
(suggestAccidentals ,boolean? "If set, accidentals are typeset as
cautionary suggestions over the note.")
+ (supportNonIntegerFret ,boolean? "If set in @code{Score} the
+@code{TabStaff} will print micro-tones as @samp{2½}")
(systemStartDelimiter ,symbol? "Which grob to make for the start
-of the system/staff? Set to @code{SystemStartBrace},
+of the system/@/staff? Set to @code{SystemStartBrace},
@code{SystemStartBracket} or @code{SystemStartBar}.")
(systemStartDelimiterHierarchy ,pair? "A nested list, indicating
-the nesting of a start delimiters.")
+the nesting of a start delimiters.")
(tablatureFormat ,procedure? "A function formatting a tablature
-note head. Called with three arguments: string number, context and event.
-It returns the text as a string.")
+note head. Called with three arguments: context, string number and,
+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.")
(tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per
minute.")
- (tempoUnitCount ,number? "Count for specifying tempo.")
- (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.")
- (tempoText ,markup? "Text for tempo marks.")
- (tempoHideNote ,boolean? "Hide the note=count in tempo marks.")
(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? "A pair of numbers,
-signifying the time signature. For example, @code{#'(4 . 4)} is a
+ (timeSignatureFraction ,fraction? "A pair of numbers,
+signifying the time signature. For example, @code{'(4 . 4)} is a
4/4 time signature.")
+ (timeSignatureSettings ,cheap-list? "A nested alist of settings for
+time signatures. Contains elements for various time signatures. The
+element for each time signature contains entries for @code{baseMoment},
+@code{beatStructure}, and @code{beamExceptions}.")
(timing ,boolean? "Keep administration of measure length,
position, bar number, etc.? Switch off for cadenzas.")
(tonic ,ly:pitch? "The tonic of the current scale.")
- (trebleStaffProperties ,list? "An alist of property settings to
-apply for the up staff of @code{PianoStaff}. Used by
-@code{\\autochange}.")
- (tremoloFlags ,integer? "The number of tremolo flags to add if no
-number is specified.")
+ (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
+will create a @var{VerticalAlignment}; otherwise, it will create a
+@var{StaffGrouper}")
(tupletFullLength ,boolean? "If set, the tuplet is printed up to
the start of the next note.")
(tupletFullLengthNote ,boolean? "If set, end at the next note,
(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}.
Example:
@example
-\\set Staff.whichBar = \"|:\"
+\\set Staff.whichBar = \".|:\"
@end example
@noindent
This will create a start-repeat bar in this staff only. Valid values
-are described in @rinternals{bar-line-interface}.")
+are described in @file{scm/bar-line.scm}.")
+ (suspendRestMerging ,boolean? "When using the Merge_rest_engraver do not
+ merge rests when this is set to true.")
)))
(barCheckLastFail ,ly:moment? "Where in the measure did the last
barcheck fail?")
(beamMelismaBusy ,boolean? "Signal if a beam is present.")
- (breakableSeparationItem ,ly:grob? "The breakable items in this
-time step, for this staff.")
(busyGrobs ,list? "A queue of @code{(@var{end-moment} .
-@var{GROB})} cons cells. This is for internal (C++) use only. This
+@var{grob})} cons cells. This is for internal (C++) use only. This
property contains the grobs which are still busy (e.g. note heads,
spanners, etc.).")
non-breakable items (note heads, lyrics, etc.).")
- (dynamicAbsoluteVolumeFunction ,procedure? "[DOCUMENT-ME]")
+ (dynamicAbsoluteVolumeFunction ,procedure? "A procedure that takes
+one argument, the text value of a dynamic event, and returns the absolute
+volume of that dynamic event.")
(finalizations ,list? "A list of expressions to evaluate before
should be manipulated through the @code{add-grace-property} function.")
+ (hasAxisGroup ,boolean? "True if the current context is contained
+in an axis group.")
(hasStaffSpacing ,boolean? "True if the current
@code{CommandColumn} contains items that will affect spacing.")
- (instrumentSupport ,grob-list? "A list of grobs to attach the
-instrument name to.")
-
-
- (lastKeySignature ,list? "Last key signature before a key
+ (lastChord ,markup? "Last chord, used for detecting chord changes.")
+ (lastKeyAlterations ,list? "Last key signature before a key
signature change.")
- (localKeySignature ,list? "The key signature at this point in the
-measure. The format is the same as for @code{keySignature}, but can
+ (localAlterations ,list? "The key signature at this point in the
+measure. The format is the same as for @code{keyAlterations}, but can
also contain @code{((@var{octave} . @var{name}) . (@var{alter}
@var{barnumber} . @var{measureposition}))} pairs.")
detected.")
- (originalMiddleCPosition ,integer? "Used for temporary overriding
-middle@tie{}C in octavation brackets.")
+ (partialBusy ,boolean? "Signal that \\partial acts at the current timestep.")
+ (quotedCueEventTypes ,list? "A list of symbols, representing the
+event types that should be duplicated for @code{\\cueDuring} commands.")
(quotedEventTypes ,list? "A list of symbols, representing the
-event types that should be duplicated for @code{\\quote} commands.")
-; (quotes ,hash-table? "A hash table, mapping names to
-;@code{music-event} vectors.")
+event types that should be duplicated for @code{\\quoteDuring} commands.
+This is also a fallback for @code{\\cueDuring} if @code{quotedCueEventTypes}
+is not set")
(rootSystem ,ly:grob? "The System object.")
(scriptDefinitions ,list? "The description of scripts. This is
used by the @code{Script_engraver} for typesetting note-superscripts
-and subscripts. See @file{scm/script.scm} for more information.")
+and subscripts. See @file{scm/@/script.scm} for more information.")
(slurMelismaBusy ,boolean? "Signal if a slur is present.")
(stavesFound ,grob-list? "A list of all staff-symbols found.")
(define-public all-translation-properties
(append all-user-translation-properties
- all-internal-translation-properties))
+ all-internal-translation-properties))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
projects / lilypond.git / blobdiff