X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=scm%2Fdefine-context-properties.scm;h=43a738d6ae25a2a6241aaad830af50a63785d91e;hb=a1741dc78d0f4a71cd6790b4306fdcd618e5c40a;hp=99206f78691c378597c130a9f86065ba6b8cd6c6;hpb=7ee90e0fec6786b1e2c6b23fb1d31bad604fa28b;p=lilypond.git diff --git a/scm/define-context-properties.scm b/scm/define-context-properties.scm index 99206f7869..43a738d6ae 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--2006 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) @@ -180,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. @@ -205,11 +210,7 @@ visibility for normal (i.e. at the start of the line) key signatures.") extra natural sign before accidentals changing from a non-natural to another non-natural.") - (extraVerticalExtent ,number-pair? - "extra vertical extent, same format as @var{minimumVerticalExtent}") - - - (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines.") + (figuredBassCenterContinuations ,boolean? "Whether to vertically center pairs of extender lines. This does not work with three or more lines") (figuredBassPlusDirection ,ly:dir? "Where to put plus signs relative to the the main figure.") (figuredBassAlterationDirection ,ly:dir? "Where to put @@ -220,6 +221,8 @@ 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 @@ -234,30 +237,39 @@ 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.") (implicitBassFigures ,list? "List of bass figures that are not printed as numbers, but only as extender lines.") - (instr ,markup? "See @code{instrument}") - (instrument ,markup? "The name to print left of a staff. The + (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? " Function taking a string (instrument name), and returning a (@var{min} . @var{max}) pair of numbers for the loudness range of the instrument. ") + + ;; the definition is reversed wrt traditional transposition + ;; this because \transpose { \transposition .. } won't work + ;; otherwise. (instrumentTransposition ,ly:pitch? "Defines the transposition of 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 an staff with @code{remove-empty} set around for.") (keyAlterationOrder ,list? " Alist that defines in what order @@ -300,10 +312,14 @@ 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}") - (minimumVerticalExtent ,number-pair? "minimum vertical extent, same -format as @var{verticalExtent}") + (maximumFretStretch ,number? "Don't allocate frets further than this from specified frets.") + (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") + (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. ") + (noteToFretFunction ,procedure? "How to produce a fret diagram. Parameters: list of note events and list of tabstring events.") (pedalSustainStrings ,list? "List of string to print for sustain-pedal. Format is (@var{up} @var{updown} @var{down}), where each of the three is the string to print when this is done with the @@ -334,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 @@ -343,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? @@ -357,6 +377,7 @@ up the interpretation phase. This speeds up debugging large scores.") squashing for @internalsref{Pitch_squash_engraver}.") (stringNumberOrientations ,list? "See @code{fingeringOrientations}") + (strokeFingerOrientations ,list? "See @code{fingeringOrientations}") (stringOneTopmost ,boolean? "Whether the 1st string is printed on the top line of the tablature.") @@ -401,13 +422,9 @@ 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 @@ -415,9 +432,8 @@ property, you can make brackets last shorter. Example @example @{ -\\times 2/3 @{ \\set tupletSpannerDuration = #(ly:make-moment 1 4) -\times 2/3 { c8 c c c c c } +\\times 2/3 @{ c8 c c c c c @} @} @end example .") @@ -425,24 +441,11 @@ property, you can make brackets last shorter. Example (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) staff-spaces high. - -@example -\\set Staff.verticalExtent = #'(-5.0 . 5.0) -@end example - - -This does not work for Voice or any other context that doesn't form a -vertical group.") - (verticallySpacedContexts ,list? "List of symbols, containing 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 @@ -466,6 +469,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