X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-context-properties.scm;h=20d77ea72f5d100dbc5705f64b27a5023e74e057;hb=b7d54752c51584d7df85a24a2b29b9a527f9ff4c;hp=16a1b21b1ead90d461c8671c8ee9716d47819b71;hpb=e48715dc917b0e1c8382dc47e2b5e193d3184000;p=lilypond.git diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm index 16a1b21b1e..20d77ea72f 100644 --- a/scm/define-context-properties.scm +++ b/scm/define-context-properties.scm @@ -21,9 +21,9 @@ (define (translator-property-description symbol type? description) (if (not (and - (symbol? symbol) - (procedure? type?) - (string? description))) + (symbol? symbol) + (procedure? type?) + (string? description))) (throw 'init-format-error)) @@ -44,6 +44,9 @@ ;; TODO FIXME + (accidentalGrouping ,symbol? "If set to @code{'voice}, accidentals +on the same note in different octaves may be horizontally staggered +if in different voices.") (aDueText ,markup? "Text to print at a unisono passage.") (additionalPitchPrefix ,string? "Text with which to prefix additional pitches within a chord name.") @@ -129,7 +132,38 @@ number, measure position, and alternative number and returns a markup of the bar number to print.") (barNumberVisibility ,procedure? "A procedure that takes a bar number and a measure position and returns whether the corresponding -bar number should be printed.") +bar number should be printed. Note that the actual print-out of +bar numbers is controlled with the @code{break-visibility} property. + +The following procedures are predefined: + +@table @code +@item all-bar-numbers-visible +Enable bar numbers for all bars, including the first one and broken +bars (which get bar numbers in parentheses). + +@item first-bar-number-invisible +Enable bar numbers for all bars (including broken bars) except the +first one. If the first bar is broken, it doesn't get a bar number +either. + +@item first-bar-number-invisible-save-broken-bars +Enable bar numbers for all bars (including broken bars) except the +first one. A broken first bar gets a bar number. + +@item first-bar-number-invisible-and-no-parenthesized-bar-numbers +Enable bar numbers for all bars except the first bar and broken bars. +This is the default. + +@item (every-nth-bar-number-visible @var{n}) +Assuming @var{n} is value@tie{}2, for example, this enables bar numbers +for bars 2, 4, 6, etc. + +@item (modulo-bar-number-visible @var{n} @var{m}) +If bar numbers 1, 4, 7, etc., should be enabled, @var{n}@tie{}(the modulo) +must be set to@tie{}3 and @var{m}@tie{}(the division remainder) to@tie{}1. +@end table") + (baseMoment ,ly:moment? "Smallest unit of time that will stand on its own as a subdivided section.") (bassFigureFormatFunction ,procedure? "A procedure that is @@ -169,8 +203,14 @@ symbol and the prefix of a chord name.") (chordRootNamer ,procedure? "A function that converts from a pitch object to a text markup. Used for chords.") (clefGlyph ,string? "Name of the symbol within the music font.") - (clefOctavation ,integer? "Add this much extra octavation. + (clefTransposition ,integer? "Add this much extra transposition. Values of 7 and -7 are common.") + (clefTranspositionFormatter ,procedure? "A procedure that takes the +Transposition number as a string and the style as a symbol and returns a +markup.") + (clefTranspositionStyle ,symbol? "Determines the way the ClefModifier +grob is displayed. Possible values are @samp{default}, @samp{parenthesized} +and @samp{bracketed}.") (clefPosition ,number? "Where should the center of the clef symbol go, measured in half staff spaces from the center of the staff.") @@ -190,8 +230,14 @@ a hairpin crescendo is used.") (crescendoText ,markup? "The text to print at start of non-hairpin crescendo, i.e., @samp{cresc.}.") (cueClefGlyph ,string? "Name of the symbol within the music font.") - (cueClefOctavation ,integer? "Add this much extra octavation. + (cueClefTransposition ,integer? "Add this much extra transposition. Values of 7 and -7 are common.") + (cueClefTranspositionFormatter ,procedure? "A procedure that +takes the Transposition number as a string and the style as a symbol +and returns a markup.") + (cueClefTranspositionStyle ,symbol? "Determines the way the ClefModifier +grob is displayed. Possible values are @samp{default}, @samp{parenthesized} +and @samp{bracketed}.") (cueClefPosition ,number? "Where should the center of the clef symbol go, measured in half staff spaces from the center of the staff.") @@ -213,7 +259,7 @@ This variable is read by @rinternals{Timing_translator} at frets for tablatures and fretboards if no strings are provided in the notes for the current moment.") (doubleRepeatSegnoType ,string? "Set the default bar line for -the combinations double repeat with segno. Default is @samp{:|S|:}.") +the combinations double repeat with segno. Default is @samp{:|.S.|:}.") (doubleRepeatType ,string? "Set the default bar line for double repeats.") (doubleSlurs ,boolean? "If set, two slurs are created for every @@ -231,7 +277,7 @@ the symbol @samp{hihat}) as keys, and a list values.") (endRepeatSegnoType ,string? "Set the default bar line for the -combinations ending of repeat with segno. Default is @samp{:|S}.") +combinations ending of repeat with segno. Default is @samp{:|.S}.") (endRepeatType ,string? "Set the default bar line for the ending of repeats.") (explicitClefVisibility ,vector? "@samp{break-visibility} @@ -240,8 +286,8 @@ function for clef changes.") function for cue clef changes.") (explicitKeySignatureVisibility ,vector? "@samp{break-visibility} function for explicit key 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.") +@code{break-visibility} property will set the visibility for +normal (i.e., at the start of the line) key signatures.") (extendersOverRests ,boolean? "Whether to continue extenders as they cross a rest.") (extraNatural ,boolean? "Whether to typeset an extra natural sign @@ -276,10 +322,12 @@ containing, in the correct order, the labels to be used for lettered frets in tablature.") - (glissandoMap ,list? "A map in the form of '((source1 . target1) -(source2 . target2) (sourcen . targetn)) showing the glissandi to -be drawn for note columns. The value '() will default to '((0 . 0) -(1 . 1) (n . n)), where n is the minimal number of note-heads in + (glissandoMap ,list? "A map in the form of +'((source1 . target1) (source2 . target2) (sourcen . targetn)) +showing the glissandi to be drawn for note columns. +The value '() will default to +'((0 . 0) (1 . 1) (n . n)), +where n is the minimal number of note-heads in the two note columns between which the glissandi occur.") (gridInterval ,ly:moment? "Interval for which to generate @code{GridPoint}s.") @@ -311,17 +359,16 @@ the default time signature.") @rinternals{Lyrics}.") (instrumentCueName ,markup? "The name to print if another instrument is to be taken.") - (instrumentEqualizer ,procedure? "A function taking a string -(instrument name), and returning a @code{(@var{min} . @var{max})} pair -of numbers for the loudness range of the instrument.") + (instrumentEqualizer ,procedure? "A function taking a +string (instrument name), and returning a @code{(@var{min} . @var{max})} +pair of numbers for the loudness range of the instrument.") (instrumentName ,markup? "The name to print left of a staff. The @code{instrumentName} property labels the staff in the first system, and the @code{shortInstrumentName} property labels following lines.") - ;; the definition is reversed wrt traditional transposition - ;; otherwise \transpose { \transposition .. } won't work (instrumentTransposition ,ly:pitch? "Define the transposition of -the instrument. Its value is the pitch that sounds like middle@tie{}C. -This is used to transpose the MIDI output, and @code{\\quote}s.") +the instrument. Its value is the pitch that sounds when the instrument +plays written middle C. This is used to transpose the MIDI output, +and @code{\\quote}s.") (internalBarNumber ,integer? "Contains the current barnumber. This property is used for internal timekeeping, among others by the @code{Accidental_engraver}.") @@ -331,14 +378,16 @@ This property is used for internal timekeeping, among others by the interfaces that are worth keeping a staff with @code{remove-empty} set around for.") (keyAlterationOrder ,list? "An alist that defines in what order -alterations should be printed. The format is @code{(@var{step} -. @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and +alterations should be printed. The format is +@code{(@var{step} . @var{alter})}, +where @var{step} is a number from 0 to@tie{}6 and @var{alter} from -2 (sharp) to 2 (flat).") (keySignature ,list? "The current key signature. This is an alist -containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} . -@var{step}) . @var{alter})}, where @var{step} is a number in the range -0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For -alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.") +containing @code{(@var{step} . @var{alter})} or +@code{((@var{octave} . @var{step}) . @var{alter})}, where @var{step} +is a number in the range 0 to@tie{}6 and @var{alter} a fraction, +denoting alteration. For alterations, use symbols, e.g. +@code{keySignature = #`((6 . ,FLAT))}.") (lyricMelismaAlignment ,number? "Alignment to use for a melisma syllable.") @@ -383,7 +432,24 @@ event when notes with the same pitch, in the same MIDI-file track, overlap.") @code{midiMinimumVolume}.") (midiMinimumVolume ,number? "Set the minimum loudness for MIDI. Ranges from 0 to@tie{}1.") - (midiChannelMapping ,symbol? "How to map MIDI channels: per @code{instrument} (default), @code{staff} or @code{voice}.") + (midiChannelMapping ,symbol? "How to map MIDI channels: per +@code{staff} (default), @code{instrument} or @code{voice}.") + (midiBalance ,number? "Stereo balance for the MIDI channel +associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1, +where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER}) +and@tie{}1 (@code{#RIGHT}) correspond to leftmost emphasis, center +balance, and rightmost emphasis, respectively.") + (midiPanPosition ,number? "Pan position for the MIDI channel +associated with the current context. Ranges from@tie{}@w{-1} to@tie{}1, +where the values@tie{}@w{-1} (@code{#LEFT}),@tie{}0 (@code{#CENTER}) +and@tie{}1 (@code{#RIGHT}) correspond to hard left, center, and hard +right, respectively.") + (midiReverbLevel ,number? "Reverb effect level for the MIDI channel +associated with the current context. Ranges from 0 to@tie{}1 +(0=off,@tie{}1=full effect).") + (midiChorusLevel ,number? "Chorus effect level for the MIDI channel +associated with the current context. Ranges from 0 to@tie{}1 +(0=off,@tie{}1=full effect).") (minimumFret ,number? "The tablature auto string-selecting mechanism selects the highest string with a fret at least @code{minimumFret}.") @@ -485,7 +551,7 @@ part-combining.") (stanza ,markup? "Stanza @q{number} to print before the start of a verse. Use in @code{Lyrics} context.") (startRepeatSegnoType ,string? "Set the default bar line for the -combinations beginning of repeat with segno. Default is @samp{.S|:}.") +combinations beginning of repeat with segno. Default is @samp{S.|:}.") (startRepeatType ,string? "Set the default bar line for the beginning of repeats.") (stemLeftBeamCount ,integer? "Specify the number of beams to draw @@ -576,12 +642,12 @@ of bar line to create. Example: @example -\\set Staff.whichBar = \"|:\" +\\set Staff.whichBar = \".|:\" @end example @noindent This will create a start-repeat bar in this staff only. Valid values -are described in @rinternals{bar-line-interface}.") +are described in @file{scm/bar-line.scm}.") ))) @@ -592,7 +658,6 @@ are described in @rinternals{bar-line-interface}.") (apply translator-property-description x)) `( - (EventClasses ,cheap-list? "The initial list of event classes.") (associatedVoiceContext ,ly:context? "The context object of the @code{Voice} that has the melody for this @code{Lyrics}.") @@ -626,6 +691,8 @@ proceeding to next time step. This is an internal variable.") should be manipulated through the @code{add-grace-property} function.") + (hasAxisGroup ,boolean? "True if the current context is contained +in an axis group.") (hasStaffSpacing ,boolean? "True if the current @code{CommandColumn} contains items that will affect spacing.") @@ -666,7 +733,7 @@ and subscripts. See @file{scm/@/script.scm} for more information.") (define-public all-translation-properties (append all-user-translation-properties - all-internal-translation-properties)) + all-internal-translation-properties)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;