-;;;; 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--2011 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 '())
(procedure? type?)
(string? description)))
(throw 'init-format-error))
-
-
+
+
(if (not (equal? #f (object-property symbol 'translation-doc)))
(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
-
- (aDueText ,string? "Text to print at a unisono passage.")
- (alignBelowContext ,string? "Where to insert newly created context in
-vertiical alignment.")
+
+ (aDueText ,markup? "Text to print at a unisono passage.")
(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.")
+ (alignBelowContext ,string? "Where to insert newly created context in
+vertical alignment.")
(associatedVoice ,string? "Name of the @code{Voice} that has the
melody for this @code{Lyrics} line.")
(autoAccidentals ,list? "List of different ways to typeset an
For determining when to print an accidental, several different rules
are tried. The rule that gives the highest number of accidentals is
-used. Each rule consists of
+used.
+
+Each entry in the list is either a symbol or a procedure.
@table @var
-@item context
-In which context is the rule 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.
+@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
+staves share accidentals, and if @var{context} is @rinternals{Staff} then
+all voices in the same staff share accidentals, but staves do not.
+
+@item procedure
+The procedure represents an accidental rule to be applied to the previously
+specified context.
-@item octavation
-Whether the accidental changes all octaves or only the current octave.
-Valid choices are
+The procedure takes the following arguments:
@table @code
-@item same-octave
-This is the default algorithm. Accidentals are typeset if the note
-changes the accidental of that note in that octave. Accidentals lasts
-to the end of the measure and then as many measures as specified in the
-value. This is, @code{1}@tie{}means to the end of next measure,
-@code{-1}@tie{}means to the end of previous measure (that is: no
-duration at all), etc. @code{#t} means forever.
+@item context
+The current context to which the rule should be applied.
+
+@item pitch
+The pitch of the note to be evaluated.
+
+@item barnum
+The current bar number.
-@item any-octave
-Accidentals are typeset if the note is different from the previous note
-on the same pitch in any octave. The value has same meaning as in
-@code{same-octave}.
+@item measurepos
+The current measure position.
@end table
-@item laziness
-Over how many bar lines the accidental lasts. If @var{laziness} is
-@code{-1} then the accidental is forgotten immediately, and if
-@var{laziness} is @code{#t} then the accidental lasts forever.
+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
@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
(barNumberVisibility ,procedure? "A Procedure that takes an
integer and returns whether the corresponding bar number should be
printed.")
+ (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
(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.")
+ (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.")
(chordNoteNamer ,procedure? "A function that converts from a pitch
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.")
+ (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.")
- (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.")
+ (doubleRepeatType ,string? "Set the default bar line for double
+repeats.")
(doubleSlurs ,boolean? "If set, two slurs are created for every
slurred note, one above and one below the chord.")
(drumPitchTable ,hash-table? "A table mapping percussion
(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
(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
+dots.")
(highStringOne ,boolean? "Whether the first string is the string
with highest pitch on the instrument. This used by the automatic
string selector for tablature notation.")
printed as numbers, but only as extender lines.")
(implicitTimeSignatureVisibility ,vector? "break visibility for
the default 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.")
- (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.")
+ (instrumentName ,markup? "The name to print left of a staff. The
+@code{instrumentName} property labels the staff in the first system, and
+the @code{shortInstrumentName} property labels following lines.")
;; the definition is reversed wrt traditional transposition
;; otherwise \transpose { \transposition .. } won't work
(instrumentTransposition ,ly:pitch? "Define the transposition of
(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
@code{melismaBusy}, @code{slurMelismaBusy}, @code{tieMelismaBusy}, and
@code{beamMelismaBusy}.")
(metronomeMarkFormatter ,procedure? "How to produce a metronome
-markup. Called with two arguments, event 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{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}.")
repeated section for a page turn to be allowed within that section.")
- (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.")
(ottavation ,markup? "If set, the text for an ottava 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
sustain pedals: @code{text}, @code{bracket} or @code{mixed} (both).")
(pedalUnaCordaStrings ,list? "See @code{pedalSustainStrings}.")
(pedalUnaCordaStyle ,symbol? "See @code{pedalSustainStyle}.")
+ (predefinedDiagramTable ,hash-table? "The hash table of predefined
+fret diagrams to use in FretBoards.")
(printKeyCancellation ,boolean? "Print restoration alterations
before a key signature change.")
(printOctaveNames ,boolean? "Print octave marks for the
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 read to find any command
-of the form @code{(volta . @var{x})}, where @var{x} is a string or
-@code{#f}.")
+ (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.")
-
+ (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{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
(skipTypesetting ,boolean? "If true, no typesetting is done,
speeding up the interpretation phase. Useful for debugging large
scores.")
- (soloIIText ,string? "The text for the start of a solo for
+ (soloIIText ,markup? "The text for the start of a solo for
voice @q{two} when part-combining.")
- (soloText ,string? "The text for the start of a solo when
+ (soloText ,markup? "The text for the start of a solo when
part-combining.")
(squashedPosition ,integer? "Vertical position of squashing for
@rinternals{Pitch_squash_engraver}.")
(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.")
(systemStartDelimiter ,symbol? "Which grob to make for the start
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; it takes a string number, a list of string tunings and a
-@code{Pitch} object. 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.")
(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
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.")
+ (topLevelAlignment ,boolean? "If true, the @var{Vertical_align_engraver}
+will create a @var{VerticalAlignment}; otherwise, it will create a
+@var{StaffGrouper}")
(trebleStaffProperties ,list? "An alist of property settings to
apply for the up staff of @code{PianoStaff}. Used by
@code{\\autochange}.")
(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}.
(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
property contains the grobs which are still busy (e.g. note heads,
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
@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
signature change.")
(localKeySignature ,list? "The key signature at this point in the
measure. The format is the same as for @code{keySignature}, but can
-also contain @code{((@var{octave} . @var{name}) . (@var{alter} .
-@var{barnumber}))} pairs. It is reset at every bar line.")
+also contain @code{((@var{octave} . @var{name}) . (@var{alter}
+@var{barnumber} . @var{measureposition}))} pairs.")
(melismaBusy ,boolean? "Signifies whether a melisma is active.
detected.")
- (originalMiddleCPosition ,integer? "Used for temporary overriding
-middle@tie{}C in octavation brackets.")
-
-
+ (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.")
projects / lilypond.git / blobdiff