+;;;; translator-property-description.scm -- part of backend documentation
+;;;;
+;;;; source file of the GNU LilyPond music typesetter
+;;;;
+;;;; (c) 1998--2003 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+;;;; Jan Nieuwenhuizen <janneke@gnu.org>
+
(define-public all-translation-properties '())
(define (translator-property-description symbol type? description)
(if (not (equal? #f (object-property symbol 'translation-doc)))
(begin
- (ly-warn (string-append "Redefining " (symbol->string symbol) "\n"))
+ (ly:warn (string-append "Redefining " (symbol->string symbol) "\n"))
(exit 2)
))
-(translator-property-description 'extraVerticalExtent
- number-pair? "extra vertical extent, same format as MinimumVerticalExtent")
-(translator-property-description 'minimumVerticalExtent number-pair?
- "minimum vertical extent, same format as VerticalExtent")
-(translator-property-description 'verticalExtent number-pair?
- "hard coded vertical extent.
-The format is a pair of dimensions, for example, this sets the sizes
-of a staff to 10 (5+5) staffspaces high.
-
-@example
-property Staff.verticalExtent = #(-5.0 . 5.0)
-@end example
-
-VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
-predefined in all relevant contexts to @code{#f}, so they will not
-inherit values.
-
-Note that these VerticalExtents can only operate on vertical groups,
-and therefore only work in contexts which contain an
-@code{Axis_group_engraver}.
-")
-
-(translator-property-description
- 'acknowledgeHashTable vector?
- "Internal variable: store interface to engraver smob table for current context. Don't mess with this."
- )
-
(translator-property-description 'acceptHashTable vector? "Internal
variable: store table with MusicName to Engraver entries.")
+(translator-property-description 'acknowledgeHashTable vector?
+"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 'associatedVoice string? "Name 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:
+(translator-property-description 'associatedVoice string? "Name 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:
@example
The user can override beam begin or end time by pushing a wildcard entries
'(begin * * * *) or '(end * * * *) resp., eg:
- property Voice.autoBeamSettings push #'(end * * * *) = #(make-moment 1 4)
+ property Voice.autoBeamSettings push #'(end * * * *) = #(ly:make-moment 1 4)
The head of the list:
'(
-((end * * 3 2) . ,(make-moment 1 2))
-((end 1 16 3 2) . ,(make-moment 1 4))
-((end 1 32 3 2) . ,(make-moment 1 8))
+((end * * 3 2) . ,(ly:make-moment 1 2))
+((end 1 16 3 2) . ,(ly:make-moment 1 4))
+((end 1 32 3 2) . ,(ly:make-moment 1 8))
...
)
@end example")
+;; "
+
(translator-property-description 'autoAccidentals list? "List of
different ways to typeset an accidental. All algorithms in the list
are tried, and the one returning the most accidentals is used.
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 'beatLength moment? "The length of one beat in this time signature.")
+(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 'breakAlignOrder list? "Defines the order in which
prefatory matter (clefs, key signatures) appears, eg. this puts the
key signatures after the bar lines:
a queue of (END-MOMENT . GROB) conses. This is for internal (C++) use only.
Use at your own risk. This property contains the grobs for which END-MOMENT >= NOW.
")
-(translator-property-description 'centralCPosition number? "Place of the central C. Usually determined by looking at clefPosition and clefGlyph.")
+
+(translator-property-description 'centralCPosition number? "Place of
+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
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
+ 'chordNoteNamer procedure?
+ "Function that converts from a pitch object to a text markup. Used for single pitches.")
+(translator-property-description
+ 'chordRootNamer procedure?
+ "Function that converts from a pitch object to a text markup. Used for chords.")
+(translator-property-description
+ 'chordNameExceptions list?
+ "Alist of chord exceptions. Contains (CHORD . MARKUP) entries.")
+(translator-property-description
+ '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
this much extra octavation. Values of 7 and -7 are common.")
-(translator-property-description 'clefPosition number? "Where should the center of the symbol go?")
+
+(translator-property-description 'clefPosition number? "Where should
+the center of the clef symbol go? On systems with an odd number of
+stafflines, the value 0 puts the clef on the middle staffline; a
+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
(translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at
every barline.
")
-(translator-property-description 'currentCommandColumn ly-grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
-(translator-property-description 'currentMusicalColumn ly-grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
+(translator-property-description 'currentCommandColumn ly:grob? "Grob that is X-parent to all current breakable (clef, key signature, etc.) items.")
+(translator-property-description 'currentMusicalColumn ly:grob? "Grob that is X-parent to all non-breakable items (note heads, lyrics, etc.).")
(translator-property-description 'defaultBarType string? "Sets the default type of bar line. Available bar types: [FIXME];
This variable is typically read at Score level, so overriding
another non-natural.
")
+(translator-property-description 'extraVerticalExtent number-pair?
+"extra vertical extent, same format as MinimumVerticalExtent")
+
+
(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 '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 dir? "put the grace note before or after the main note?")
+(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 'instr markup? "see @code{instrument}")
)
(translator-property-description 'localKeySignatureChanges list? "Experimental.
[DOCME]")
-(translator-property-description 'measureLength moment? "Length of one
+(translator-property-description 'majorSevenSymbol markup? "How should
+the major7 be formatted in a chord name?")
+(translator-property-description 'measureLength ly:moment? "Length of one
measure in the current time signature last?")
-(translator-property-description 'measurePosition 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 @ref{(lilypond)melismaBusy}. This is set automatically.")
+(translator-property-description 'melismaEngraverBusy boolean? "See melismaBusy. This is set automatically.")
(translator-property-description 'midiInstrument string? "Name of the
MIDI instrument to use ")
(translator-property-description 'midiMinimumVolume number? "[DOCUMENT-ME]")
(translator-property-description 'minimumFret number? "The tablature
auto string-selecting mechanism selects the highest string with a fret
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 moment? " How long does one beat in the current time signature last?")
+(translator-property-description 'oneBeat ly:moment? " How long does one beat in the current time signature last?")
(translator-property-description 'othersolo boolean? "FIXME")
(translator-property-description 'pedalSustainStrings list? "List of string to print for sustain-pedal. Format is
(UP UPDOWN DOWN), where each of the three is the string to print when
(translator-property-description 'phrasingPunctuation string? "")
(translator-property-description 'rehearsalMark number-or-string? "")
-(translator-property-description 'regularSpacingDelta moment? "TODO")
+(translator-property-description 'regularSpacingDelta ly:moment? "TODO")
(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
")
+(translator-property-description 'restNumberThreshold number?
+ "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
skip the empty bars that are produced by multimeasure notes and rests.
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 '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.
.")
(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.")
pair of numbers, signifying the time signature. For example #'(4 . 4) is a 4/4time 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?
+ "The tonic of the current scale")
(translator-property-description 'transposing integer? "Transpose the MIDI output. Set this property to the number of half-steps to transpose by.")
(translator-property-description 'tremoloFlags integer? "Number of tremolo flags to add if none is specified.")
(translator-property-description 'tupletNumberFormatFunction procedure?
@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 moment? "
+(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
property, you can make brackets last shorter. Example
@example
@@lilypond[verbatim,fragment]
context Voice imes 2/3 @{
- property Voice.tupletSpannerDuration = #(make-moment 1 4)
+ property Voice.tupletSpannerDuration = #(ly:make-moment 1 4)
[c8 c c] [c c c]
@}
@@end lilypond
procedure? "what callback to add to children of a vertical alignment.
It determines what alignment procedure is used on the alignment
itself. .")
-(translator-property-description
- 'voltaOnThisStaff boolean?
+(translator-property-description 'verticalExtent number-pair? "hard
+coded vertical extent. The format is a pair of dimensions, for
+example, this sets the sizes of a staff to 10 (5+5) staffspaces high.
+
+@example
+property Staff.verticalExtent = #(-5.0 . 5.0)
+@end example
+
+VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are
+predefined in all relevant contexts to @code{#f}, so they will not
+inherit values.
+
+Note that these VerticalExtents can only operate on vertical groups,
+and therefore only work in contexts which contain an
+@code{Axis_group_engraver}.
+")
+
+(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.")
-(translator-property-description 'voltaSpannerDuration moment? "maximum duration of the volta bracket.
+(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
@code{\\alternative}. It specifies the number of whole notes duration
have odd effects if the specified duration is longer than the music
given in an @code{\\alternative}.
.")
-(translator-property-description 'weAreGraceContext boolean? ".")
(translator-property-description 'whichBar string?
"This property is read to determine what type of barline to create.
Valid values are described in @ref{(lilypond-internals)bar-line-interface}.
.")
-(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).")
-
projects / lilypond.git / blobdiff