X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Ftranslator-property-description.scm;h=97abc27d8d842975ef3b731bae4e07629e887a3d;hb=736bfdaea194aade5d20d9f749f009c96d41b953;hp=0747c4b9d9451d9d14e81a399817136735b4150a;hpb=00acdf404c52c1a510738c1969daa964d252a05d;p=lilypond.git diff --git a/scm/translator-property-description.scm b/scm/translator-property-description.scm index 0747c4b9d9..97abc27d8d 100644 --- a/scm/translator-property-description.scm +++ b/scm/translator-property-description.scm @@ -15,25 +15,36 @@ -(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 '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 +than can be plugged into the backend directly. See the init file +@file{generic-property.scm} for details. For internal use only, +deprecated. +") +(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]") -(translator-property-description 'Generic_property_list list? "description of the conversion. +VerticalExtent, MinimumVerticalExtent and ExtraVerticalExtent are +predefined in all relevant contexts to @code{#f}, so they will not +inherit values. -Defines names and types for generic properties. These are properties -than can be plugged into the backend directly. See the init file -@file{generic-property.scm} for details. For internal use only, -deprecated. +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 '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? " @@ -79,6 +90,9 @@ set, \addlyrics will assume that beams, slurs and ties signal melismata, and align lyrics accordingly. ") +(translator-property-description 'autoReminders symbol? "If set to @samp{accidental} or @samp{cautionary}, +a (reminder) accidental automatically is inserted whenever an accidental is reverted - even after a bar.") + (translator-property-description 'barAlways boolean? " If set to true a bar line is drawn after each note. ") (translator-property-description 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This @@ -90,6 +104,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,17 +126,16 @@ 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 string? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}") +(translator-property-description 'crescendoText markup? "Text to print at start of non-hairpin crecscendo, ie: @samp{cresc.}") (translator-property-description 'crescendoSpanner symbol? "Type of spanner to be used for crescendi. One of: @samp{hairpin}, @samp{line}, @samp{dashed-line}, @samp{dotted-line}. If unset, hairpin type is used.") -(translator-property-description 'decrescendoText string? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}") +(translator-property-description 'decrescendoText markup? "Text to print at start of non-hairpin decrecscendo, ie: @samp{dim.}") (translator-property-description 'currentBarNumber integer? "Contains the current barnumber. This property is incremented at every barline. ") @@ -165,8 +179,12 @@ procedure? "visibility-lambda function for explicit Key changes; (ie. at the start of the line) key signatures.") -(translator-property-description 'followThread boolean? +(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 +204,20 @@ 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 'lastKeySignature list? "Last key +signature before a key signature change.") (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,11 +248,12 @@ 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? "") (translator-property-description 'rehearsalMark number-or-string? "") +(translator-property-description 'regularSpacingDelta 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 @@ -259,6 +280,11 @@ r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3 @end example ") +(translator-property-description 'skipTypesetting boolean? + "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 'slurBeginAttachment symbol? "translates to the car of grob-property 'attachment of NoteColumn. See @ref{Slur}.") @@ -274,7 +300,7 @@ r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3 (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.") @@ -285,6 +311,8 @@ is erased. .") (translator-property-description 'stemRightBeamCount integer? "idem, for the right side.") (translator-property-description 'stz string? "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 '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 @@ -351,7 +379,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}. .")