X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Ftranslator-property-description.scm;h=3d9982067c027d32309b72142e62e61230e159dd;hb=0afbca9d16e35aaa0602d088ec7d57ed25008870;hp=27012b0df76c9e8a0e8a7e51802ba84a7877c2cd;hpb=d35271961e34da635524a2246bb1061091242a3b;p=lilypond.git diff --git a/scm/translator-property-description.scm b/scm/translator-property-description.scm index 27012b0df7..3d9982067c 100644 --- a/scm/translator-property-description.scm +++ b/scm/translator-property-description.scm @@ -1,10 +1,10 @@ -(define all-translation-properties '()) +(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) )) @@ -42,6 +42,8 @@ and therefore only work in contexts which contain an "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 '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? " @@ -63,13 +65,13 @@ are given by * * 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)) ... ) @@ -112,34 +114,36 @@ file @file{lyrics-multi-stanza.ly}. ") (translator-property-description 'automaticMelismata boolean? " If -set, \addlyrics will assume that beams, slurs and ties signal +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 'barCheckNoSynchronize boolean? "If set, don't reset measurePosition when finding a bbarcheck. This -makes bar-checks for polyphonic music easier.") +(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 '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 'breakAlignOrder list? "Defines the order in which prefatory matter (clefs, key signatures) appears, eg. this puts the key signatures after the bar lines: @example \\property Score.breakAlignOrder = #'( - Span_bar - Breathing_sign - Clef_item - Staff_bar - Key_item - Time_signature + span-bar + breathing-sign + clef + staff-bar + key + time-signature ) @end example ") @@ -147,13 +151,29 @@ 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 '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 '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 +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 '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 @@ -166,8 +186,8 @@ arpeggios that cross staves. (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 @@ -178,7 +198,7 @@ Staff.defaultBarType will have no effect. @table @samp @item (), or unset Behave in normal way: remove one set of grobs when in unisolo. -@item allways: +@item always: Remove any grob that comes along. @item never: Do nothing. @@ -188,7 +208,7 @@ Do nothing. @table @samp @item (), or unset Behave in normal way: remove spanners when in unisolo. -@item allways: +@item always: Remove any spanners that come along. @item never: Do nothing. @@ -212,6 +232,8 @@ procedure? "visibility-lambda function for explicit Key changes; extra natural sign before accidentals changing from a non-natural to another non-natural. ") + +(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? @@ -220,7 +242,9 @@ 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 '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 'instrument markup? " If @code{Instrument_name_engraver} @cindex Instrument_name_engraver @@ -247,10 +271,11 @@ signature before a key signature change.") (translator-property-description 'localKeySignature list? "the key signature at this point in the measure. The format is the same as for keySignature. Is reset at every bar line." ) - -(translator-property-description 'measureLength moment? "Length of one +(translator-property-description 'localKeySignatureChanges list? "Experimental. + [DOCME]") +(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. @@ -258,15 +283,19 @@ 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 'midiMaximumVolume 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 '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 this is done with the pedal.") @@ -275,16 +304,22 @@ this is done with the pedal.") (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 'fingersHorizontal boolean? "Put the middle fingerings to the +right side of the note head.") (translator-property-description 'skipBars boolean? " Set to true to skip the empty bars that are produced by multimeasure notes and rests. @@ -306,12 +341,6 @@ r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3 "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}.") - -(translator-property-description 'slurEndAttachment symbol? "translates to the cdr of grob-property 'attachment of NoteColumn. See @ref{Slur}.") (translator-property-description 'slurMelismaBusy boolean? "Signal a slur if automaticMelismata is set.") (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?.") @@ -322,6 +351,8 @@ 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 '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.") @@ -337,6 +368,10 @@ is erased. (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 '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 @@ -358,7 +393,7 @@ 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 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 @@ -366,7 +401,7 @@ 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 @@ -379,7 +414,10 @@ context Voice imes 2/3 @{ 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 'voltaSpannerDuration moment? "maximum duration of the volta bracket. +(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 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 @@ -388,7 +426,6 @@ brackets in the situation where one alternative is very large. It may 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.