X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-context-properties.scm;h=e55c2fb8c0958420101d12db9c43278c67a83f0c;hb=8b4c9e2622a4b643d91fdb856fc57967d18e719d;hp=d357dc92d8a0b3a8b5d97c49b13a7505ec32901d;hpb=e3083e01ee49567d2ef3e7215423e6188d31fc6d;p=lilypond.git diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm index d357dc92d8..e55c2fb8c0 100644 --- a/scm/define-context-properties.scm +++ b/scm/define-context-properties.scm @@ -2,15 +2,22 @@ ;;;; ;;;; source file of the GNU LilyPond music typesetter ;;;; -;;;; (c) 1998--2005 Han-Wen Nienhuys +;;;; (c) 1998--2006 Han-Wen Nienhuys ;;;; Jan Nieuwenhuizen (define-public all-translation-properties '()) (define (translator-property-description symbol type? description) - (if (not (equal? #f (object-property symbol 'translation-doc))) - (ly:error (_ "symbol ~S redefined" symbol))) + (if (not (and + (symbol? symbol) + (procedure? type?) + (string? description))) + (throw 'init-format-error)) + + + (if (not (equal? #f (object-property symbol 'translation-doc))) + (ly:error (_ "symbol ~S redefined" symbol))) (set-object-property! symbol 'translation-type? type?) (set-object-property! symbol 'translation-doc description) @@ -22,6 +29,9 @@ (lambda (x) (apply translator-property-description x)) `( + + ;; TODO FIXME + (aDueText ,string? "Text to print at a unisono passage.") (alignBelowContext ,string? "Where to insert newly created context in vertiical alignment.") (alignAboveContext ,string? "Where to insert newly created context in vertiical alignment.") @@ -104,9 +114,13 @@ returns whether the corresponding bar number should be printed") 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}") + + (figuredBassFormatter ,procedure? "Routine generating a markup +for a bass figure.") (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.") + (beatLength ,ly:moment? "The length of one beat in this time signature.") (beatGrouping ,list? "List of beatgroups, e.g., in 5/8 time @code{'(2 @@ -115,7 +129,7 @@ list of @code{BassFigureEvent}s, a context, and the grob to format.") (middleCPosition ,number? "Place of the middle C, measured in half -staffspaces. Usually determined by looking at @code{clefPosition} and +staff-spaces. Usually determined by looking at @code{clefPosition} and @code{clefGlyph}.") (chordNameFunction ,procedure? @@ -173,9 +187,7 @@ The layout style is a hash table, containing the drum-pitches (e.g. the symbol @samp{hihat}) as key, and a list (@var{notehead-style} @var{script} @var{vertical-position}) as values. ") - (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at -every bar line. -") + (currentBarNumber ,integer? "Contains the current barnumber. This property is incremented at every bar line. ") (defaultBarType ,string? "Sets the default type of bar line. See @code{whichBar} for information on available bar types. @@ -202,12 +214,19 @@ another non-natural.") "extra vertical extent, same format as @var{minimumVerticalExtent}") + (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.") + (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the the main figure.") + + (figuredBassAlterationDirection ,ly:dir? "Where to put +alterations relative to the main figure.") (followVoice ,boolean? "If set, note heads are tracked across staff switches by a thin line") (fontSize ,number? "The relative size of all grobs in a context. ") + (forbidBreak ,boolean? "If set to ##t, prevent a line break at this point.") + (fingeringOrientations ,list? "List of symbols, containing @samp{left}, @samp{right}, @samp{up} and/or @samp{down}. This list @@ -222,17 +241,24 @@ for the full staff.") (gridInterval ,ly:moment? "Interval for which to generate @ref{GridPoint}s") + (hairpinToBarline ,boolean? "If set, end a hairpin at the barline before the ending note.") + (harmonicAccidentals ,boolean? "If set, harmonic notes in chords get accidentals.") (highStringOne ,boolean? "Whether the 1st string is the string with highest pitch on the instrument. This used by the automatic string selector for tab notation.") + (ignoreFiguredBassRest ,boolean? "Don't swallow rest events.") (ignoreBarChecks ,boolean? "Ignore bar checks") (ignoreMelismata ,boolean? "Ignore melismata for this @internalsref{Lyrics} line.") - (instr ,markup? "See @code{instrument}") - (instrument ,markup? "The name to print left of a staff. The + (implicitBassFigures ,list? "List of bass figures that are not +printed as numbers, but only as extender lines.") + + + (instrumentCueName ,markup? "Name to print if another instrument is to be taken.") + (instrumentName ,markup? "The name to print left of a staff. The @code{instrument} property labels the staff in the first system, and the @code{instr} property labels following lines.") (instrumentEqualizer ,procedure? " @@ -242,8 +268,10 @@ Function taking a string (instrument name), and returning a (@var{min} . @var{ma the instrument. Its value is the pitch that sounds like 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}.") + (keepAliveInterfaces ,list? "List of symbols, signifying grob interfaces that -are worth keeping a RemoveEmptyStaff staff around for.") +are worth keeping an staff with @code{remove-empty} set around for.") (keyAlterationOrder ,list? " Alist that defines in what order alterations should be printed. The format is (@var{step} . @var{alter}), where @var{step} is from 0 .. 6 and @var{alter} from @@ -255,7 +283,6 @@ containing (@var{name} . @var{alter}) or ((@var{octave} . @var{name}) . @var{alt where @var{name} is from 0.. 6 and @var{alter} from -4 (double flat) to 4 (double sharp). ") - (majorSevenSymbol ,markup? "How should the major 7th be formatted in a chord name?") (markFormatter ,procedure? "Procedure @@ -285,8 +312,12 @@ markup. Called with 2 arguments, event and context.") (midiMaximumVolume ,number? "Analogous to @code{midiMinimumVolume}.") (minimumFret ,number? "The tablature auto string-selecting mechanism selects the highest string with a fret at least @code{minimumFret}") + (minimumPageTurnLength ,ly:moment? "Minimum length of a rest for a page turn to be allowed") + (minimumRepeatLengthForPageTurn ,ly:moment? "Minimum length of a repeated section for a page +turn to be allowed within that section") (minimumVerticalExtent ,number-pair? "minimum vertical extent, same format as @var{verticalExtent}") + (output ,ly:music-output? "The output produced by a score-level translator during music interpretation") (ottavation ,string? "If set, the text for an ottava spanner. Changing this creates a new text spanner. ") (pedalSustainStrings ,list? "List of string to print for @@ -319,6 +350,8 @@ whether they are processed in this context.") 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.") + (shortInstrumentName ,markup? "See @code{instrument}") + (shortVocalName ,markup? "Name of a vocal line, short version.") (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 @@ -328,9 +361,11 @@ with other voices is preserved. @example -@@lilypond[fragment,verbatim,center] -r1 r1*3 R1*3 \\\\property Score.skipBars= ##t r1*3 R1*3 -@@end lilypond +@{ +r1 r1*3 R1*3 +\\set Score.skipBars= ##t +r1*3 R1*3 +@} @end example ") (skipTypesetting ,boolean? @@ -362,6 +397,8 @@ one).") at beat positions by only drawing one beam over the beat.") (suggestAccidentals ,boolean? "If set, accidentals are typeset as cautionary suggestions over the note.") + (systemStartDelimiterHierarchy ,pair? "A nested list, indicating the nesting of a start delimiters.") + (systemStartDelimiter ,symbol? "Which grob to make for the start of the system/staff? Set to @code{SystemStartBrace}, @code{SystemStartBracket} or @code{SystemStartBar}.") @@ -384,33 +421,28 @@ Switch off for cadenzas.") (tremoloFlags ,integer? "Number of tremolo flags to add if no number is specified.") - (tupletFullLength ,boolean? "If set, the tuplet is printed upto + (tupletFullLength ,boolean? "If set, the tuplet is printed up to the start of the next note.") - (tupletNumberFormatFunction - ,procedure? - "Function taking a music as input, producing a string. This function -is called to determine the text to print on a tuplet bracket.") - + (tupletFullLengthNote ,boolean? "If set, end at the next note, otherwise end on the matter (time sigs, etc.) before the note.") (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 @example -@@lilypond[verbatim,fragment] -context Voice \\times 2/3 @{ - property Voice.tupletSpannerDuration = #(ly:make-moment 1 4) - c-[8 c c-] c-[ c c-] +@{ +\\set tupletSpannerDuration = #(ly:make-moment 1 4) +\\times 2/3 @{ c8 c c c c c @} @} -@@end lilypond @end example .") - (verticalAlignmentChildCallback ,procedure? "What callback to add -to children of a vertical alignment. It determines what -procedure is used on the alignment itself.") + + (useBassFigureExtenders ,boolean? "Whether to use extender lines +for repeated bass figures") + (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. +to 10 (5+5) staff-spaces high. @example \\set Staff.verticalExtent = #'(-5.0 . 5.0) @@ -425,7 +457,6 @@ 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.") (voltaOnThisStaff ,boolean? "Normally, volta brackets are put only on the @@ -449,6 +480,10 @@ Example: This will create a start-repeat bar in this staff only. Valid values are described in @internalsref{bar-line-interface}. ") + (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per minute.") + (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.") + (tempoUnitCount ,number? "Count for specifying tempo.") + ))) (define-public all-internal-translation-properties