;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; Copyright (C) 1998--2010 Han-Wen Nienhuys <hanwen@xs4all.nl>
+;;;; Copyright (C) 1998--2012 Han-Wen Nienhuys <hanwen@xs4all.nl>
;;;; Jan Nieuwenhuizen <janneke@gnu.org>
;;;;
;;;; LilyPond is free software: you can redistribute it and/or modify
;; TODO FIXME
(aDueText ,markup? "Text to print at a unisono passage.")
+ (additionalPitchPrefix ,string? "Text with which to prefix
+additional pitches within a chord name.")
(alignAboveContext ,string? "Where to insert newly created context in
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.")
+ (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.")
(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
@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.")
(autoBeaming ,boolean? "If set to true then beams are generated
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.")
(baseMoment ,ly:moment? "Smallest unit of time that will stand on its
own as a subdivided section.")
(bassFigureFormatFunction ,procedure? "A procedure that is
@code{\\autochange}.")
(beamExceptions ,list? "An alist of exceptions to autobeam rules
that normally end on beats.")
+ (beamHalfMeasure ,boolean? "Allow a half measure of eighth notes to
+be beamed together in 3/4 time?")
+ (beamWholeMeasure ,boolean? "Allow a whole measure of eighth notes
+to be beamed together in 3/4 time?")
(beatStructure ,list? "List of @code{baseMoment}s that are combined
to make beats.")
@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.")
+ (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
symbol go, measured in half staff spaces from the center of the
staff.")
(completionBusy ,boolean? "Whether a completion-note head is playing.")
+ (completionUnit ,ly:moment? "Sub-bar unit of completion.")
(connectArpeggios ,boolean? "If set, connect arpeggios across
piano staff.")
(countPercentRepeats ,boolean? "If set, produce counters for
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.")
@code{(@var{notehead-style} @var{script} @var{vertical-position})} as
values.")
-
+ (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
(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
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
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
(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.")
+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.")
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}.")
(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")
(noChordSymbol ,markup? "Markup to be displayed for rests in a
ChordNames context.")
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.")
(shapeNoteStyles ,vector? "Vector of symbols, listing style for
each note head relative to the tonic (qv.) of the scale.")
(shortInstrumentName ,markup? "See @code{instrumentName}.")
@code{traditional}, or @code{semitone}.")
(stanza ,markup? "Stanza @q{number} to print before the start of a
verse. Use in @code{Lyrics} context.")
+ (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}.")
(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},
+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.")
(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
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
(apply translator-property-description x))
`(
+ (EventClasses ,cheap-list? "The initial list of event classes.")
(associatedVoiceContext ,ly:context? "The context object of the
@code{Voice} that has the melody for this @code{Lyrics}.")
barcheck fail?")
(beamMelismaBusy ,boolean? "Signal if a beam is present.")
(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.).")
(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.")