X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Ftranslator-property-description.scm;h=22c77623d3913965a0fb9087b9bdc70745bd0e7e;hb=20091095d3ac112fa0d0c55c8e2b8092584be4b2;hp=cf2bd96fa50592920ef63dafe64332e991bb9261;hpb=1e0b328b0eaf62dc57c6f60463864f2e5cb0e659;p=lilypond.git diff --git a/scm/translator-property-description.scm b/scm/translator-property-description.scm index cf2bd96fa5..22c77623d3 100644 --- a/scm/translator-property-description.scm +++ b/scm/translator-property-description.scm @@ -15,18 +15,30 @@ -(translator-property-description 'CONTEXTNAMEMinimumVerticalExtent number-pair? "minimum vertical extent, same format as CONTEXTNAMEVerticalExtent [fixme, naming]") -(translator-property-description 'CONTEXTNAMEVerticalExtent number-pair? "hard coded vertical extent. +(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.StaffVerticalExtent = #(-5.0 . 5.0) +property Staff.VerticalExtent = #(-5.0 . 5.0) @end example - [fixme, naming]") -(translator-property-description 'CONTEXTNAMExtraVerticalExtent number-pair? "extra vertical extent, same format -CONTEXTNAMEMinimumVerticalExtent [fixme, naming]") +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 'ExtraVerticalExtent + number-pair? "extra vertical extent, same format as MinimumVerticalExtent") + (translator-property-description 'Generic_property_list list? "description of the conversion. Defines names and types for generic properties. These are properties @@ -90,6 +102,7 @@ makes bar-checks for polyphonic music easier.") count if this property is set to zero. ") (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 'breakAlignOrder list? "Defines the order in which prefatory matter (clefs, key signatures) appears, eg. this puts the key signatures after the bar lines: @@ -111,12 +124,11 @@ key signatures after the bar lines: (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 'clefPitches list? "an alist mapping GLYPHNAME to the position of the central C for that symbol") (translator-property-description 'clefPosition number? "Where should the center of the symbol go?") (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 staffs. +arpeggios that cross staves. ") (translator-property-description 'createKeyOnClefChange boolean? "Print a key signature whenever the clef is changed.") (translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}") @@ -167,6 +179,10 @@ procedure? "visibility-lambda function for explicit Key changes; (translator-property-description 'followVoice boolean? "if set, note heads are tracked across staff switches by a thin line") +(translator-property-description 'fontSize integer? + "Used to set the relative size of all grobs +in a context. This is done using the @code{Font_size_engraver}.") + (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 'forgetAccidentals boolean? "do not set localKeySignature when a note alterated differently from @@ -186,18 +202,17 @@ remembered for the duration of a measure. property is used to label subsequent lines. If the @code{midiInstrument} property is not set, then @code{instrument} is used to determine the instrument for MIDI output.") + +(translator-property-description 'instrumentEqualizer procedure? "[DOCUMENT-ME]") + (translator-property-description 'keyAccidentalOrder list? " Alist that defines in what order alterations should be printed. The format is (NAME . ALTER), where NAME is from 0 .. 6 and ALTER from -1, 1. ") -(translator-property-description 'keyOctaviation boolean? "") -(translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2 ") +(translator-property-description 'keySignature list? "The current key signature. This is an alist containing (NAME . ALTER) or ((OCTAVE . NAME) . ALTER) pairs, where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2 ") (translator-property-description 'localKeySignature list? "the key -signature at this point in the measure. The format is an alist with -entries of the form (NAME . ALTER) -or ((OCTAVE . NAME) . ALTER), -where NAME is from 0.. 6 and ALTER from -2,-1,0,1,2" +signature at this point in the measure. The format is the same as for keySignature. " ) (translator-property-description 'measureLength moment? "Length of one @@ -228,7 +243,7 @@ measures later. (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 this is done with the pedal.") -(translator-property-description 'pedalUnaChordaStrings string? "see pedalSustainStrings.") +(translator-property-description 'pedalUnaCordaStrings string? "see pedalSustainStrings.") (translator-property-description 'pedalSostenutoStrings string? "see pedalSustainStrings.") (translator-property-description 'phrasingPunctuation string? "") @@ -279,7 +294,7 @@ help with debugging large scores.") (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 'staffsFound list? "list of all staff-symbols found.") +(translator-property-description 'stavesFound list? "list of all staff-symbols found.") (translator-property-description 'stanza string? "Stanza `number' to print at start of a verse. Use in LyricsVoice context.") @@ -356,7 +371,7 @@ 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}. -Legal values are described in @ref{(lilypond-internals)bar-line-interface}. +Valid values are described in @ref{(lilypond-internals)bar-line-interface}. .")