LEFT | RIGHT |
1 ;;;; define-context-properties.scm -- part of backend documentation | 1 ;;;; define-context-properties.scm -- part of backend documentation |
2 ;;;; | 2 ;;;; |
3 ;;;; source file of the GNU LilyPond music typesetter | 3 ;;;; source file of the GNU LilyPond music typesetter |
4 ;;;; | 4 ;;;; |
5 ;;;; (c) 1998--2009 Han-Wen Nienhuys <hanwen@xs4all.nl> | 5 ;;;; (c) 1998--2009 Han-Wen Nienhuys <hanwen@xs4all.nl> |
6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> | 6 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> |
7 | 7 |
8 | 8 |
9 (define-public all-translation-properties '()) | 9 (define-public all-translation-properties '()) |
10 | 10 |
11 (define (translator-property-description symbol type? description) | 11 (define (translator-property-description symbol type? description) |
12 (if (not (and | 12 (if (not (and |
13 (symbol? symbol) | 13 (symbol? symbol) |
14 (procedure? type?) | 14 (procedure? type?) |
15 (string? description))) | 15 (string? description))) |
16 (throw 'init-format-error)) | 16 (throw 'init-format-error)) |
17 » | 17 |
18 | 18 |
19 (if (not (equal? #f (object-property symbol 'translation-doc))) | 19 (if (not (equal? #f (object-property symbol 'translation-doc))) |
20 (ly:error (_ "symbol ~S redefined" symbol))) | 20 (ly:error (_ "symbol ~S redefined" symbol))) |
21 | 21 |
22 (set-object-property! symbol 'translation-type? type?) | 22 (set-object-property! symbol 'translation-type? type?) |
23 (set-object-property! symbol 'translation-doc description) | 23 (set-object-property! symbol 'translation-doc description) |
24 (set! all-translation-properties (cons symbol all-translation-properties)) | 24 (set! all-translation-properties (cons symbol all-translation-properties)) |
25 symbol) | 25 symbol) |
26 | 26 |
27 | 27 |
28 (define-public all-user-translation-properties | 28 (define-public all-user-translation-properties |
29 (map | 29 (map |
30 (lambda (x) | 30 (lambda (x) |
31 (apply translator-property-description x)) | 31 (apply translator-property-description x)) |
32 `( | 32 `( |
33 | 33 |
34 ;; TODO FIXME | 34 ;; TODO FIXME |
35 | 35 |
36 (aDueText ,markup? "Text to print at a unisono passage.") | 36 (aDueText ,markup? "Text to print at a unisono passage.") |
37 (alignBelowContext ,string? "Where to insert newly created context in | 37 (alignBelowContext ,string? "Where to insert newly created context in |
38 vertical alignment.") | 38 vertical alignment.") |
39 (alignAboveContext ,string? "Where to insert newly created context in | 39 (alignAboveContext ,string? "Where to insert newly created context in |
40 vertical alignment.") | 40 vertical alignment.") |
41 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals | 41 (alignBassFigureAccidentals ,boolean? "If true, then the accidentals |
42 are aligned in bass figure context.") | 42 are aligned in bass figure context.") |
43 (associatedVoice ,string? "Name of the @code{Voice} that has the | 43 (associatedVoice ,string? "Name of the @code{Voice} that has the |
44 melody for this @code{Lyrics} line.") | 44 melody for this @code{Lyrics} line.") |
45 (autoAccidentals ,list? "List of different ways to typeset an | 45 (autoAccidentals ,list? "List of different ways to typeset an |
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
95 (autoCautionaries ,list? "List similar to @code{autoAccidentals}, | 95 (autoCautionaries ,list? "List similar to @code{autoAccidentals}, |
96 but it controls cautionary accidentals rather than normal ones. Both | 96 but it controls cautionary accidentals rather than normal ones. Both |
97 lists are tried, and the one giving the most accidentals wins. In | 97 lists are tried, and the one giving the most accidentals wins. In |
98 case of draw, a normal accidental is typeset.") | 98 case of draw, a normal accidental is typeset.") |
99 (automaticBars ,boolean? "If set to false then bar lines will not | 99 (automaticBars ,boolean? "If set to false then bar lines will not |
100 be printed automatically; they must be explicitly created with a | 100 be printed automatically; they must be explicitly created with a |
101 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures | 101 @code{\\bar} command. Unlike the @code{\\cadenzaOn} keyword, measures |
102 are still counted. Bar line generation will resume according to that | 102 are still counted. Bar line generation will resume according to that |
103 count if this property is unset.") | 103 count if this property is unset.") |
104 | 104 |
105 | 105 |
106 (barAlways ,boolean? "If set to true a bar line is drawn after | 106 (barAlways ,boolean? "If set to true a bar line is drawn after |
107 each note.") | 107 each note.") |
108 (barCheckSynchronize ,boolean? "If true then reset | 108 (barCheckSynchronize ,boolean? "If true then reset |
109 @code{measurePosition} when finding a bar check.") | 109 @code{measurePosition} when finding a bar check.") |
110 (barNumberVisibility ,procedure? "A Procedure that takes an | 110 (barNumberVisibility ,procedure? "A Procedure that takes an |
111 integer and returns whether the corresponding bar number should be | 111 integer and returns whether the corresponding bar number should be |
112 printed.") | 112 printed.") |
113 (bassFigureFormatFunction ,procedure? "A procedure that is | 113 (bassFigureFormatFunction ,procedure? "A procedure that is |
114 called to produce the formatting for a @code{BassFigure} grob. It | 114 called to produce the formatting for a @code{BassFigure} grob. It |
115 takes a list of @code{BassFigureEvent}s, a context, and the grob to | 115 takes a list of @code{BassFigureEvent}s, a context, and the grob to |
116 format.") | 116 format.") |
117 (bassStaffProperties ,list? "An alist of property settings to | 117 (bassStaffProperties ,list? "An alist of property settings to |
118 apply for the down staff of @code{PianoStaff}. Used by | 118 apply for the down staff of @code{PianoStaff}. Used by |
119 @code{\\autochange}.") | 119 @code{\\autochange}.") |
120 (beamSettings ,list? "Specifies when automatically generated | 120 (beamSettings ,list? "Specifies when automatically generated |
121 beams should begin and end, as well as beam subdivision behavior. | 121 beams should begin and end, as well as beam subdivision behavior. |
122 See @ruser{Setting automatic beam | 122 See @ruser{Setting automatic beam |
123 behavior} for more information.") | 123 behavior} for more information.") |
124 (beatLength ,ly:moment? "The length of one beat in this time | 124 (beatLength ,ly:moment? "The length of one beat in this time |
125 signature.") | 125 signature.") |
126 (beatGrouping ,list? "A list of beatgroups, e.g., in 5/8 time | |
127 @code{'(2 3)}.") | |
128 | 126 |
129 | 127 |
130 (chordChanges ,boolean? "Only show changes in chords scheme?") | 128 (chordChanges ,boolean? "Only show changes in chords scheme?") |
131 (chordNameFunction ,procedure? "The function that converts lists | 129 (chordNameFunction ,procedure? "The function that converts lists |
132 of pitches to chord names.") | 130 of pitches to chord names.") |
133 (chordNameExceptions ,list? "An alist of chord exceptions. | 131 (chordNameExceptions ,list? "An alist of chord exceptions. |
134 Contains @code{(@var{chord} . @var{markup})} entries.") | 132 Contains @code{(@var{chord} . @var{markup})} entries.") |
135 (chordNameExceptionsFull ,list? "An alist of full chord | 133 (chordNameExceptionsFull ,list? "An alist of full chord |
136 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.") | 134 exceptions. Contains @code{(@var{chord} . @var{markup})} entries.") |
137 (chordNameExceptionsPartial ,list? "An alist of partial chord | 135 (chordNameExceptionsPartial ,list? "An alist of partial chord |
(...skipping 126 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
264 (instrument name), and returning a @code{(@var{min} . @var{max})} pair | 262 (instrument name), and returning a @code{(@var{min} . @var{max})} pair |
265 of numbers for the loudness range of the instrument.") | 263 of numbers for the loudness range of the instrument.") |
266 ;; the definition is reversed wrt traditional transposition | 264 ;; the definition is reversed wrt traditional transposition |
267 ;; otherwise \transpose { \transposition .. } won't work | 265 ;; otherwise \transpose { \transposition .. } won't work |
268 (instrumentTransposition ,ly:pitch? "Define the transposition of | 266 (instrumentTransposition ,ly:pitch? "Define the transposition of |
269 the instrument. Its value is the pitch that sounds like middle@tie{}C. | 267 the instrument. Its value is the pitch that sounds like middle@tie{}C. |
270 This is used to transpose the MIDI output, and @code{\\quote}s.") | 268 This is used to transpose the MIDI output, and @code{\\quote}s.") |
271 (internalBarNumber ,integer? "Contains the current barnumber. | 269 (internalBarNumber ,integer? "Contains the current barnumber. |
272 This property is used for internal timekeeping, among others by the | 270 This property is used for internal timekeeping, among others by the |
273 @code{Accidental_engraver}.") | 271 @code{Accidental_engraver}.") |
274 | 272 |
275 | 273 |
276 (keepAliveInterfaces ,list? "A list of symbols, signifying grob | 274 (keepAliveInterfaces ,list? "A list of symbols, signifying grob |
277 interfaces that are worth keeping a staff with @code{remove-empty} set | 275 interfaces that are worth keeping a staff with @code{remove-empty} set |
278 around for.") | 276 around for.") |
279 (keyAlterationOrder ,list? "An alist that defines in what order | 277 (keyAlterationOrder ,list? "An alist that defines in what order |
280 alterations should be printed. The format is @code{(@var{step} | 278 alterations should be printed. The format is @code{(@var{step} |
281 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and | 279 . @var{alter})}, where @var{step} is a number from 0 to@tie{}6 and |
282 @var{alter} from -2 (sharp) to 2 (flat).") | 280 @var{alter} from -2 (sharp) to 2 (flat).") |
283 (keySignature ,list? "The current key signature. This is an alist | 281 (keySignature ,list? "The current key signature. This is an alist |
284 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} . | 282 containing @code{(@var{step} . @var{alter})} or @code{((@var{octave} . |
285 @var{step}) . @var{alter})}, where @var{step} is a number in the range | 283 @var{step}) . @var{alter})}, where @var{step} is a number in the range |
286 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For | 284 0 to@tie{}6 and @var{alter} a fraction, denoting alteration. For |
287 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.") | 285 alterations, use symbols, e.g. @code{keySignature = #`((6 . ,FLAT))}.") |
288 | 286 |
(...skipping 142 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
431 (strokeFingerOrientations ,list? "See | 429 (strokeFingerOrientations ,list? "See |
432 @code{fingeringOrientations}.") | 430 @code{fingeringOrientations}.") |
433 (subdivideBeams ,boolean? "If set, multiple beams will be | 431 (subdivideBeams ,boolean? "If set, multiple beams will be |
434 subdivided at beat positions by only drawing one beam over the beat.") | 432 subdivided at beat positions by only drawing one beam over the beat.") |
435 (suggestAccidentals ,boolean? "If set, accidentals are typeset as | 433 (suggestAccidentals ,boolean? "If set, accidentals are typeset as |
436 cautionary suggestions over the note.") | 434 cautionary suggestions over the note.") |
437 (systemStartDelimiter ,symbol? "Which grob to make for the start | 435 (systemStartDelimiter ,symbol? "Which grob to make for the start |
438 of the system/staff? Set to @code{SystemStartBrace}, | 436 of the system/staff? Set to @code{SystemStartBrace}, |
439 @code{SystemStartBracket} or @code{SystemStartBar}.") | 437 @code{SystemStartBracket} or @code{SystemStartBar}.") |
440 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating | 438 (systemStartDelimiterHierarchy ,pair? "A nested list, indicating |
441 the nesting of a start delimiters.") | 439 the nesting of a start delimiters.") |
442 | 440 |
443 | 441 |
444 (tablatureFormat ,procedure? "A function formatting a tablature | 442 (tablatureFormat ,procedure? "A function formatting a tablature |
445 note head. Called with three arguments: string number, context and event. | 443 note head. Called with three arguments: string number, context and event. |
446 It returns the text as a string.") | 444 It returns the text as a string.") |
447 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per | 445 (tempoWholesPerMinute ,ly:moment? "The tempo in whole notes per |
448 minute.") | 446 minute.") |
449 (tempoUnitCount ,number? "Count for specifying tempo.") | 447 (tempoUnitCount ,number? "Count for specifying tempo.") |
450 (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.") | 448 (tempoUnitDuration ,ly:duration? "Unit for specifying tempo.") |
451 (tempoText ,markup? "Text for tempo marks.") | 449 (tempoText ,markup? "Text for tempo marks.") |
(...skipping 23 matching lines...) Expand all Loading... |
475 @example | 473 @example |
476 @{ | 474 @{ |
477 \\set tupletSpannerDuration = #(ly:make-moment 1 4) | 475 \\set tupletSpannerDuration = #(ly:make-moment 1 4) |
478 \\times 2/3 @{ c8 c c c c c @} | 476 \\times 2/3 @{ c8 c c c c c @} |
479 @} | 477 @} |
480 @end example") | 478 @end example") |
481 | 479 |
482 | 480 |
483 (useBassFigureExtenders ,boolean? "Whether to use extender lines | 481 (useBassFigureExtenders ,boolean? "Whether to use extender lines |
484 for repeated bass figures.") | 482 for repeated bass figures.") |
485 | 483 |
486 (verticallySpacedContexts ,list? "List of symbols, containing | 484 (verticallySpacedContexts ,list? "List of symbols, containing |
487 context names whose vertical axis groups should be taken into account | 485 context names whose vertical axis groups should be taken into account |
488 for vertical spacing of systems.") | 486 for vertical spacing of systems.") |
489 (vocalName ,markup? "Name of a vocal line.") | 487 (vocalName ,markup? "Name of a vocal line.") |
490 (voltaSpannerDuration ,ly:moment? "This specifies the maximum | 488 (voltaSpannerDuration ,ly:moment? "This specifies the maximum |
491 duration to use for the brackets printed for @code{\\alternative}. | 489 duration to use for the brackets printed for @code{\\alternative}. |
492 This can be used to shrink the length of brackets in the situation | 490 This can be used to shrink the length of brackets in the situation |
493 where one alternative is very large.") | 491 where one alternative is very large.") |
494 | 492 |
495 | 493 |
(...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
593 ))) | 591 ))) |
594 | 592 |
595 (define-public all-translation-properties | 593 (define-public all-translation-properties |
596 (append all-user-translation-properties | 594 (append all-user-translation-properties |
597 all-internal-translation-properties)) | 595 all-internal-translation-properties)) |
598 | 596 |
599 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; | 597 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; |
600 | 598 |
601 (define-public default-melisma-properties | 599 (define-public default-melisma-properties |
602 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy)) | 600 '(melismaBusy slurMelismaBusy tieMelismaBusy beamMelismaBusy completionBusy)) |
LEFT | RIGHT |