;;;; This file is part of LilyPond, the GNU music typesetter.
;;;;
-;;;; Copyright (C) 1998--2009 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
@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
(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}.")
- (beamSettings ,list? "Specifies when automatically generated
-beams should begin and end, as well as beam subdivision behavior.
-See @ruser{Setting automatic beam
-behavior} for more information.")
- (beatLength ,ly:moment? "The length of one beat in this time
-signature.")
-
+ (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?")
(chordNameExceptions ,list? "An alist of chord exceptions.
@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
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.")
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
(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
(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
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.")
(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.")
+@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
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}.")
(noChordSymbol ,markup? "Markup to be displayed for rests in a
ChordNames context.")
- (noteToFretFunction ,procedure? "How to produce a fret diagram.
-Parameters: A list of note events and a list of tabstring events.")
+ (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
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
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
(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},
+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.")
(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.")
- (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.")
+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.")
(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
+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.")
(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}.
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.).")
@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
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.")
(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.")
projects / lilypond.git / blobdiff