-;;;; translator-property-description.scm -- part of backend documentation
+;;;; define-context-properties.scm -- part of backend documentation
;;;;
;;;; source file of the GNU LilyPond music typesetter
;;;;
-;;;; (c) 1998--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-;;;; Jan Nieuwenhuizen <janneke@gnu.org>
+;;;; (c) 1998--2005 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 "Redefining ~S " symbol)
- (exit 2)
- ))
+ (ly:warn "Redefining ~S " symbol)
+ (exit 2)))
(set-object-property! symbol 'translation-type? type?)
(set-object-property! symbol 'translation-doc description)
(set! all-translation-properties (cons symbol all-translation-properties))
- symbol
- )
+ symbol)
(define-public all-user-translation-properties
(map
(alignBassFigureAccidentals ,boolean?
"If true, then the accidentals are aligned in bass figure context.")
- (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")
+ (allowBeamBreak ,boolean? "If true allow line breaks for beams over bar lines.")
(associatedVoice ,string? "Name of the
@code{Voice} that has the melody for this @code{Lyrics} line.")
(autoBeamSettings ,list? "Specifies
@item laziness
Over how many bar lines the accidental lasts.
-If @var{laziness} is @code{-1} then the accidental is forget
+If @var{laziness} is @code{-1} then the accidental is forgotten
immediately, and if @var{laziness} is @code{#t} then the accidental
lasts forever.
@end table
(barNumberVisibility ,procedure? "Procedure that takes an int and
returns whether the corresponding bar number should be printed")
+ (bassStaffProperties ,list? "Alist of property settings to apply
+for the down staff of PianoStaff. Used by @code{\\autochange}")
+ (trebleStaffProperties ,list? "Alist of property settings to apply
+for the up staff of PianoStaff. Used by @code{\\autochange}")
(bassFigureFormatFunction ,procedure? "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 format.")
(chordRootNamer ,procedure?
"Function that converts from a pitch object to a text markup. Used for chords.")
(chordNameExceptions ,list?
- "Alist of chord exceptions.
+ "An alist of chord exceptions.
Contains (@var{chord} . @var{markup}) entries.")
(chordNameExceptionsFull ,list?
- "Alist of chord exceptions.
+ "An alist of chord exceptions.
Contains (@var{chord} . @var{markup}) entries.")
(chordNameExceptionsPartial
,list?
- "Alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
+ "An alist of partial chord exceptions. Contains (@var{chord} . (@var{prefix-markup} @var{suffix-markup})) entries.")
(chordNameSeparator ,markup?
"The markup object used to separate
(connectArpeggios ,boolean? " If set, connect arpeggios across
piano staff.")
(createKeyOnClefChange ,boolean? "Print a key signature whenever the clef is changed.")
- (createSpacing ,boolean? "Create StaffSpacing objects? Should be set for staves.")
+ (createSpacing ,boolean? "Create @code{StaffSpacing} objects?
+Should be set for staves.")
(crescendoText ,markup? "Text to print at start of non-hairpin crescendo, i.e.: @samp{cresc.}")
(crescendoSpanner ,symbol? "Type of spanner to be used for crescendi.
One of: @samp{hairpin}, @samp{line}, @samp{dashed-line},
")
(decrescendoSpanner ,symbol? "See @code{crescendoSpanner}.")
-
+ (doubleSlurs ,boolean?
+ "When set, two slurs are created for every slurred
+note, one above and one below the chord.")
(explicitClefVisibility ,procedure? "@samp{break-visibility} function for clef changes.")
(explicitKeySignatureVisibility ,procedure?
"@samp{break-visibility} function for explicit key
-changes. @samp{\\override} of @samp{#'break-visibility} will set the
+changes. @samp{\\override} of the @code{break-visibility} property will set the
visibility for normal (i.e. at the start of the line) key signatures.")
(extraNatural ,boolean? "Whether to typeset an
"extra vertical extent, same format as @var{minimumVerticalExtent}")
- (followVoice ,boolean? "if set, note heads are tracked across staff
+ (followVoice ,boolean? "If set, note heads are tracked across staff
switches by a thin line")
(fontSize ,number?
(instrumentEqualizer ,procedure? "
Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument.
")
- (instrumentTransposition ,ly:pitch? "Define the transposition of the instrument. This is used to transpose the MIDI output, and @code{\\quote}s.")
+ (instrumentTransposition ,ly:pitch? "Defines the transposition of
+the instrument. Its value is the pitch that sounds like middle C. This
+is used to transpose the MIDI output, and @code{\\quote}s.")
(keyAccidentalOrder ,list? " Alist that defines in what order
alterations should be printed. The format is (@var{name}
-. @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from -1, 1.
+. @var{alter}), where @var{name} is from 0 .. 6 and @var{alter} from
+-2 (sharp) and 2 (flat).
")
(keySignature ,list? "The current key signature. This is an alist
(midiMinimumVolume ,number? "Sets the minimum loudness for MIDI. Ranges from 0 to 1.")
(midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.")
(minimumFret ,number? "The tablature auto string-selecting mechanism
-selects the highest string with a fret at least @var{minimumFret}")
+selects the highest string with a fret at least @code{minimumFret}")
(minimumVerticalExtent ,number-pair? "minimum vertical extent, same
format as @var{verticalExtent}")
(ottavation ,string? "If set, the text for an ottava spanner. Changing
(rehearsalMark ,integer? "The last rehearsal mark printed.")
(repeatCommands ,list? "This property is read to find any command of the form @code{(volta . @var{x})}, where @var{x} is a string or @code{#f}")
(restNumberThreshold ,number?
- "If a multimeasure rest takes less
-than this number of measures, no number is printed. ")
-
+ "If a multimeasure rest has more measures
+than this, a number is printed. ")
+ (shapeNoteStyles ,vector? "Vector of symbols, listing style for each note
+head relative to the tonic (qv.) of the scale.")
(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
@example
@@lilypond[fragment,verbatim,center]
-r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
+r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3
@@end lilypond
@end example
")
(skipTypesetting ,boolean?
"When true, all no typesetting is done, speeding
-up the interpretation phase. This speeds up debugging large scores.")
+up the interpretation phase. This speeds up debugging large scores.")
(soloIIText ,string? "text for begin of solo for voice ``two'' when part-combining.")
(soloText ,string? "text for begin of solo when part-combining.")
(squashedPosition ,integer? " Vertical position of
(tupletSpannerDuration ,ly:moment? "
Normally a tuplet bracket is as wide as the
-@code{\\times} expression that gave rise to it. By setting this
-property, you can make brackets last shorter. Example
+@code{\\times} expression that gave rise to it. By setting this
+property, you can make brackets last shorter. Example
@example
@@lilypond[verbatim,fragment]
@end example
-This does not work for Voice or any other context that doesn't form a
+This does not work for Voice or any other context that doesn't form a
vertical group.")
-
+
+ (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.")
(vocNam ,markup? "Name of a vocal line, short version.")
(melismaBusy ,boolean? "Signifies
whether a melisma is active. This can be used to signal melismas on
top of those automatically detected. ")
- (graceSettings ,vector?
+ (graceSettings ,list?
"Overrides for grace notes. This property should
be manipulated through the @code{add-grace-property} function.")
(currentCommandColumn ,ly:grob? "Grob that is X-parent to all
(localKeySignature ,list? "the key signature at this point in the
measure. The format is the same as for keySignature, but can also
contain ((@var{octave} . @var{name}) . (@var{alter} . @var{barnumber}))
-pairs. It is reset at every bar line." )
+pairs. It is reset at every bar line.")
(localKeySignatureChanges ,list? "Experimental. [DOCME]")
conses. This is for internal (C++) use only. This property contains
the grobs which are still busy (e.g. note heads, spanners, etc.)
")
- (barCheckLastFail ,ly:moment? "Where in the measure did the last barcheck fail?")
+ (barCheckLastFail ,ly:moment? "Where in the measure did the last barcheck fail?")
(associatedVoiceContext ,ly:context? "The context object of the Voice that has the melody for this Lyrics.")
(acceptHashTable ,vector? "Internal
variable: store table with MusicName to Engraver entries.")
Script_engraver for typesetting note-super/subscripts. See
@file{scm/script.scm} for more information
")
- (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
+ (quotedEventTypes ,list? "List of symbols, representing the
+event types that should be duplicated for @code{\\quote} commands.")
+
+; (quotes ,hash-table? "Hash table, mapping names to music-event vectors.")
(stavesFound ,grob-list? "list of all staff-symbols found.")
(instrumentSupport ,grob-list? "list of grobs to attach instrument name
to.")
(tieMelismaBusy ,boolean? "Signal whether a tie is present.")
- )
- ))
+ (tweakCount ,number? "Number of otherwise unique Contexts.")
+ (tweakRank ,number? "Identify otherwise unique Contexts.")
+ )))
(define-public all-translation-properties
(append all-user-translation-properties
projects / lilypond.git / blobdiff