;; 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.")
(additionalPitchPrefix ,string? "Text with which to prefix
additional pitches within a chord name.")
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.")
+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
@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?")
+ (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.")
(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.")
(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.
+ (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.")
(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
@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}
(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
-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}.")
(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{instrumentName}.")
@code{traditional}, or @code{semitone}.")
(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
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}.")
)))
(graceSettings ,list? "Overrides for grace notes. This property
should be manipulated through the @code{add-grace-property} function.")
-
(hasStaffSpacing ,boolean? "True if the current
@code{CommandColumn} contains items that will affect spacing.")
projects / lilypond.git / blobdiff