"Internal variable: store interface to engraver smob table for current
context. Don't mess with this.")
(translator-property-description 'aDueText string? "text for begin of a due")
+(translator-property-description 'alignBassFigureAccidentals boolean?
+ "If true, then the accidentals are aligned in bass figure context.")
+
+(translator-property-description 'allowBeamBreak boolean?
+ "If true allow line breaks during beams.")
(translator-property-description 'associatedVoice string? "Name of the
Voice that has the melody for this LyricsVoice.")
+(translator-property-description 'associatedVoiceContext ly:context? "The context object of the Voice that has the melody for this LyricsVoice.")
(translator-property-description 'autoBeamSettings list? "Specifies
when automatically generated beams should begin and end. The elements
have the format:
same-octave.
@end table
")
+(translator-property-description 'autoBeaming boolean? "If set to true
+then beams are generated automatically.")
(translator-property-description 'autoCautionaries list? "List similar to
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.
")
-
-(translator-property-description 'automaticPhrasing boolean? " If set,
-the @ref{Lyric_phrasing_engraver} will match note heads of context
-called Voice X to syllables from LyricsVoice called
-X-<something>. This feature is turned on by default. See the example
-file @file{lyrics-multi-stanza.ly}.
+(translator-property-description 'automaticBars boolean? " If set to true then bar lines will not be printed
+ automatically; they must be explicitly created with @code{bar}
+ keywords. Unlike with the @code{cadenza} keyword, measures are
+ still counted. Bar generation will resume according to that
+ count if this property is set to zero.
")
-(translator-property-description 'automaticMelismata boolean? " If
-set, \\addlyrics will assume that beams, slurs and ties signal
-melismata, and align lyrics accordingly.
+(translator-property-description 'barAlways boolean? "If set to true a bar line is drawn after each note.
")
+(translator-property-description 'barCheckLastFail ly:moment? "Where in the measurze did the last barcheck fail?")
-(translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note.
-")
(translator-property-description 'barCheckSynchronize boolean? "If
true then reset measurePosition when finding a barcheck. Turn off when
using barchecks in polyphonic music.")
-(translator-property-description 'barNonAuto boolean? " If set to true then bar lines will not be printed
- automatically; they must be explicitly created with @code{bar}
- keywords. Unlike with the @code{cadenza} keyword, measures are
- still counted. Bar generation will resume according to that
- count if this property is set to zero.
-")
(translator-property-description 'barNumberVisibility procedure? "Procedure that takes an int and returns whether the corresponding bar number should be printed")
(translator-property-description 'bassFigureFormatFunction procedure? "DOCME")
-(translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is set when automaticMelismata is set")
+(translator-property-description 'beamMelismaBusy boolean? "Signal if a beam is present.")
(translator-property-description 'beatLength ly:moment? "The length of one beat in this time signature.")
(translator-property-description 'beatGrouping list?
"List of beatgroups. Eg. in 5/8 time #(list 2 3).")
+
+
+(translator-property-description 'breakableSeparationItem ly:grob?
+"The breakable items in this time step, for this staff.")
+
(translator-property-description 'breakAlignOrder list? "Defines the order in which
prefatory matter (clefs, key signatures) appears, eg. this puts the
key signatures after the bar lines:
the central C, measured in half staffspaces. Usually determined by
looking at clefPosition and clefGlyph.")
-(translator-property-description
- 'changeMoment moment-pair?
- "duration that voices are examined for differences, when
-part-combining. Usually unset or zero when combining threads into one
-voice, and 1 (or the duration of one measure) when combining voices
-into one staff.")
-
(translator-property-description
'chordNameFunction procedure?
"The function that converts lists of pitches to chord names.")
-(translator-property-description
- 'chordNameStyle symbol?
- "The chord name style: ignatzek, banter or jazz.")
(translator-property-description
'chordNoteNamer procedure?
"Function that converts from a pitch object to a text markup. Used for single pitches.")
'chordNameSeparator markup?
"The markup object used to separate parts of a chord name.")
-
(translator-property-description 'chordChanges boolean? "Only show changes in chords scheme?")
(translator-property-description 'clefGlyph string? "Name of the symbol within the music font")
(translator-property-description 'clefOctavation integer? "Add
positive value shifts it up, a negative value shifts it down. The
unit of this distance is the half staff space.")
-(translator-property-description 'combineParts boolean? "try to combine parts?")
(translator-property-description 'connectArpeggios boolean? " If
set, connect all arpeggios that are found. In this way, you can make
arpeggios that cross staves.
Staff.defaultBarType will have no effect.
")
-(translator-property-description 'devNullThread symbol? "User control of Thread_devnull_engraver: one of
-@table @samp
-@item (), or unset
-Behave in normal way: remove one set of grobs when in unisolo.
-@item always:
-Remove any grob that comes along.
-@item never:
-Do nothing.
-@end table
-")
-(translator-property-description 'devNullVoice symbol? "User control of Voice_devnull_engraver: one of
-@table @samp
-@item (), or unset
-Behave in normal way: remove spanners when in unisolo.
-@item always:
-Remove any spanners that come along.
-@item never:
-Do nothing.
-@end table
-")
+
(translator-property-description 'decrescendoSpanner symbol? "Type of spanner to be used for decrescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.")
(translator-property-description 'dynamicAbsoluteVolumeFunction procedure? "
")
(translator-property-description 'explicitClefVisibility procedure? "visibility-lambda function for clef changes.")
-
-
(translator-property-description 'explicitKeySignatureVisibility
procedure? "visibility-lambda function for explicit Key changes;
-\override of #'break-visibility will set the visibility for normal
+\\override of #'break-visibility will set the visibility for normal
(ie. at the start of the line) key signatures.")
(translator-property-description 'extraNatural boolean? "Whether to typeset an
(translator-property-description 'finalizations list? "List of expressions to evaluate before proceeding to next time step. Internal variable.")
(translator-property-description 'followVoice boolean?
"if set, note heads are tracked across staff switches by a thin line")
-(translator-property-description 'fontSize integer?
+(translator-property-description 'fontSize number?
"Used to set the relative size of all grobs
in a context. This is done using the @code{Font_size_engraver}.")
-(translator-property-description 'allowBeamBreak boolean?
- "If true allow line breaks during beams.")
+(translator-property-description
+ 'fingeringOrientations list?
+ "List of symbols, containing left, right, up and/or down. This list determines where fingerings are put wrt. to the chord being fingered.")
(translator-property-description 'forceClef boolean? "Show clef symbol, even if it hasn't changed. Only active for the first clef after the property is set, not for the full staff.")
-(translator-property-description 'graceAccidentalSpace number? "amount space to alot for an accidental")
-(translator-property-description 'graceAlignPosition ly:dir? "put the grace note before or after the main note?")
-(translator-property-description 'highStringOne boolean? "Whether the 1st string is the string with
-highest pitch on the instrument (used by the automatic string selector).")
+
+(translator-property-description 'graceSettings vector?
+ "Overrides for grace notes. This
+property should be manipulated through the @code{add-grace-property}
+function.")
+
+(translator-property-description 'highStringOne boolean? "Whether the
+1st string is the string with highest pitch on the instrument (used by
+the automatic string selector).")
+
+(translator-property-description 'ignoreMelismata boolean?
+ "Ignore melismata for this @ref{LyricsVoice}.")
(translator-property-description 'instr markup? "see @code{instrument}")
(translator-property-description 'instrument markup? " If @code{Instrument_name_engraver}
@cindex Instrument_name_engraver
)
(translator-property-description 'localKeySignatureChanges list? "Experimental.
[DOCME]")
+
(translator-property-description 'majorSevenSymbol markup? "How should
the major7 be formatted in a chord name?")
+(translator-property-description 'markFormatter procedure? "Procedure
+taking as arguments context and rehearsal mark. It should return the
+formatted mark as a markup object.")
+
(translator-property-description 'measureLength ly:moment? "Length of one
measure in the current time signature last?")
-(translator-property-description 'measurePosition ly:moment? " How much
+(translator-property-description 'measurePosition ly:moment? "How much
of the current measure (measured in whole notes) have we had. This
can be set manually to create incomplete measures (anacrusis, upbeat),
the start of the music.
(translator-property-description 'melismaBusy boolean? "Signifies
whether a melisma is active. This can be used to signal melismas on
top of those automatically detected. ")
-(translator-property-description 'melismaEngraverBusy boolean? "See melismaBusy. This is set automatically.")
+(translator-property-description 'melismaBusyProperties list?
+ "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
+(i.e. setting @code{melismaBusy} to @code{#t}) and manual beams are
+considered. Possible values include @code{melismaBusy},
+@code{slurMelismaBusy}, @code{tieMelismaBusy}, and
+@code{beamMelismaBusy}")
+
+
(translator-property-description 'metronomeMarkFormatter procedure?
"How to produce a metronome markup.
Called with 2 arguments, event and context.")
not less than minimumFret")
(translator-property-description 'minimumVerticalExtent number-pair?
"minimum vertical extent, same format as VerticalExtent")
-(translator-property-description 'autoBeaming boolean? "If set to true
-then beams are generated automatically.")
-(translator-property-description 'noDirection boolean? "Don't set directions by a2-engraver when part-combining.")
-(translator-property-description 'oneBeat ly:moment? " How long does one beat in the current time signature last?")
+(translator-property-description 'recordEventSequence procedure?
+ "Upon termination of this 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're processed in this context.")
+
(translator-property-description
'originalCentralCPosition integer?
"Used for temporary overriding central C in octavation brackets. ")
this is done with the pedal.")
(translator-property-description 'pedalUnaCordaStrings list? "see pedalSustainStrings.")
(translator-property-description 'pedalSostenutoStrings list? "see pedalSustainStrings.")
-
-(translator-property-description 'phrasingPunctuation string? "")
-(translator-property-description 'rehearsalMark number-or-string? "")
-(translator-property-description 'regularSpacingDelta ly:moment? "TODO")
+(translator-property-description 'pedalSustainStyle symbol? "A symbol
+that indicates how to print sustain pedals: text, bracket or mixed
+(both).")
+(translator-property-description 'pedalUnaCordaStyle symbol? "see pedalSustainStyle.")
+(translator-property-description 'pedalSostenutoStyle symbol? "see pedalSustainStyle.")
+
+(translator-property-description 'rehearsalMark integer? "The
+last rehearsal mark printed.")
(translator-property-description 'repeatCommands list? "This property is read to find any command of the form (volta . X), where X is a string or #f")
(translator-property-description 'scriptDefinitions list? "
Description of scripts. This is used by Script_engraver for typesetting note-super/subscripts. See @file{scm/script.scm} for more information
"If a multimeasure rest takes less
than this number of measures, no number is printed. ")
-(translator-property-description 'scriptHorizontal boolean? " Put
-scripts left or right of note heads. Support for this is limited.
-Accidentals will collide with scripts.
-")
-(translator-property-description 'fingerHorizontalDirection integer?
- "If set, put the middle fingerings to
-the side of the note head. Use LEFT, RIGHT or unset.")
-
-(translator-property-description 'skipBars boolean? " Set to true to
+(translator-property-description 'skipBars boolean? "If set to true, then
skip the empty bars that are produced by multimeasure notes and rests.
These bars will not appear on the printed output. If not set (the
default) multimeasure notes and rests expand into their full length,
"When true, all no typesetting is done at
this moment, causing the interpretation phase to go a lot faster. This can
help with debugging large scores.")
-(translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.")
+(translator-property-description 'slurMelismaBusy boolean? "Signal if a slur is present.")
(translator-property-description 'solo boolean? "set if solo is detected by the part combiner.")
(translator-property-description 'soloADue boolean? "set Solo/A due texts in the part combiner?.")
(translator-property-description 'soloIIText string? "text for begin of solo for voice ``two'' when part-combining.")
(translator-property-description 'soloText string? "text for begin of solo when part-combining.")
(translator-property-description 'sparseTies boolean? "only create one tie per chord.")
-(translator-property-description 'splitInterval number-pair? "part-combiner will separate its two voices (or threads) when interval between the two voices is contained in this range.")
-(translator-property-description 'split-interval boolean? "set if part-combiner separated voices based on splitInterval.")
(translator-property-description 'squashedPosition integer? " Vertical position of
squashing for Pitch_squash_engraver.")
(translator-property-description 'stringOneTopmost boolean? "Whether the 1st string is printed on the
top line of the tablature.")
(translator-property-description 'stavesFound list? "list of all staff-symbols found.")
-(translator-property-description 'stanza markup? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.")
+(translator-property-description 'stanza markup? "Stanza `number' to
+print before the start of a verse. Use in LyricsVoice context.")
(translator-property-description '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
.")
(translator-property-description 'stemRightBeamCount integer? "idem, for the right side.")
(translator-property-description 'stringTunings list? "The tablature strings tuning. Must be a list of the different semitons pitch of each string (starting by the lower one).")
-(translator-property-description 'stz markup? "Abbreviated form for a stanza, see also Stanza property.")
(translator-property-description 'subdivideBeams boolean? "If set, multiple beams will be subdivided at beat
positions - by only drawing one beam over the beat.")
-(translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff?")
+(translator-property-description 'systemStartDelimiter symbol? "Which grob to make for the start of the system/staff? Set to @code{SystemStartBrace}, @code{SystemStartBracket} or @code{SystemStartBar}.")
(translator-property-description 'tablatureFormat procedure?
"Function formatting a tab notehead; it takes
a string number, a list of string tunings and Pitch object. It returns the text as a string.")
-(translator-property-description 'textNonEmpty boolean? " If set
-to true then text placed above or below the staff is not assumed to
-have zero width. @code{\fatText} and @code{\emptyText} are predefined
-settings.
-.")
-(translator-property-description 'tieMelismaBusy boolean? "Signal ties when automaticMelismata is set.")
-(translator-property-description 'timeSignatureFraction number-pair? "
-pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time signature.")
+(translator-property-description 'tieMelismaBusy boolean? "Signal whether a tie is present.")
+(translator-property-description 'timeSignatureFraction number-pair?
+"pair of numbers, signifying the time signature. For example #'(4 . 4)
+is a 4/4 time signature.")
+
(translator-property-description 'timing boolean? " Keep administration of measure length, position, bar number, etc?
Switch off for cadenzas.")
(translator-property-description 'tonic ly:pitch?
(translator-property-description 'tupletNumberFormatFunction procedure?
"Function taking a music as input, producing a string. This function is called to determine the text to print on a tuplet bracket.")
+
+;; remove this?
(translator-property-description 'tupletInvisible boolean? "
If set to true, tuplet bracket creation is switched off
entirely. This has the same effect as setting both
@code{tupletNumberVisibility} and @code{tupletBracketVisibility} to
@code{#f}, but as this does not even create any grobs, this setting
uses less memory and time.")
+
(translator-property-description 'tupletSpannerDuration ly:moment? "
Normally a tuplet bracket is as wide as the
@code{ imes} expression that gave rise to it. By setting this
@@lilypond[verbatim,fragment]
context Voice imes 2/3 @{
property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
- [c8 c c] [c c c]
+ c-[8 c c-] c-[ c c-]
@}
@@end lilypond
@end example
.")
-(translator-property-description 'unirhythm boolean? "set if unirhythm is detected by the part combiner.")
-(translator-property-description 'unisilence boolean? "set if unisilence is detected by the part combiner.")
-(translator-property-description 'unison boolean? "set if unisono is detected by the part combiner. .")
(translator-property-description 'verticalAlignmentChildCallback
procedure? "what callback to add to children of a vertical alignment.
It determines what alignment procedure is used on the alignment
@code{Axis_group_engraver}.
")
+(translator-property-description 'vocalName markup?
+ "Name of a vocal line.")
+(translator-property-description 'vocNam markup?
+ "Name of a vocal line, short version.")
+
(translator-property-description 'voltaOnThisStaff boolean?
- "Normally, volta brackets are put only on the topmost staff. Setting this variable to true, will force a bracket to be on this staff as well.")
+ "Normally, volta brackets are put only on the topmost staff. Setting
+this variable to true, will force a bracket to be on this staff as
+well.")
+
(translator-property-description 'voltaSpannerDuration ly:moment? "maximum duration of the volta bracket.
Set to a duration to control the size of the brackets printed by
This will create a start-repeat bar in this staff only.
-If not set explicitly (by property or @code{\bar}), this is set
+If not set explicitly (by property or @code{\\bar}), this is set
according to values of @code{defaultBarType}, @code{barAlways},
@code{barNonAuto} and @code{measurePosition}.
Valid values are described in @ref{(lilypond-internals)bar-line-interface}.
.")
+
+
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+
+(define-public default-melisma-properties '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy))
projects / lilypond.git / blobdiff