LEFT | RIGHT |
1 ;;;; This file is part of LilyPond, the GNU music typesetter. | 1 ;;;; This file is part of LilyPond, the GNU music typesetter. |
2 ;;;; | 2 ;;;; |
3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl> | 3 ;;;; Copyright (C) 1998--2011 Han-Wen Nienhuys <hanwen@xs4all.nl> |
4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> | 4 ;;;; Jan Nieuwenhuizen <janneke@gnu.org> |
5 ;;;; | 5 ;;;; |
6 ;;;; LilyPond is free software: you can redistribute it and/or modify | 6 ;;;; LilyPond is free software: you can redistribute it and/or modify |
7 ;;;; it under the terms of the GNU General Public License as published by | 7 ;;;; it under the terms of the GNU General Public License as published by |
8 ;;;; the Free Software Foundation, either version 3 of the License, or | 8 ;;;; the Free Software Foundation, either version 3 of the License, or |
9 ;;;; (at your option) any later version. | 9 ;;;; (at your option) any later version. |
10 ;;;; | 10 ;;;; |
(...skipping 211 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
222 @code{#CENTER}=@code{0}.") | 222 @code{#CENTER}=@code{0}.") |
223 (dot-count ,integer? "The number of dots.") | 223 (dot-count ,integer? "The number of dots.") |
224 (dot-negative-kern ,number? "The space to remove between a dot | 224 (dot-negative-kern ,number? "The space to remove between a dot |
225 and a slash in percent repeat glyphs. Larger values bring the two | 225 and a slash in percent repeat glyphs. Larger values bring the two |
226 elements closer together.") | 226 elements closer together.") |
227 (dot-placement-list ,list? "List consisting of | 227 (dot-placement-list ,list? "List consisting of |
228 @code{(@var{description} @var{string-number} @var{fret-number} | 228 @code{(@var{description} @var{string-number} @var{fret-number} |
229 @var{finger-number})} entries used to define fret diagrams.") | 229 @var{finger-number})} entries used to define fret diagrams.") |
230 (duration-log ,integer? "The 2-log of the note head duration, | 230 (duration-log ,integer? "The 2-log of the note head duration, |
231 i.e., @code{0} = whole note, @code{1} = half note, etc.") | 231 i.e., @code{0} = whole note, @code{1} = half note, etc.") |
232 (duration-log-list ,list? "List of @code{duration-log}.") | |
233 | 232 |
234 | 233 |
235 ;; | 234 ;; |
236 ;; e | 235 ;; e |
237 ;; | 236 ;; |
238 (eccentricity ,number? "How asymmetrical to make a slur. | 237 (eccentricity ,number? "How asymmetrical to make a slur. |
239 Positive means move the center to the right.") | 238 Positive means move the center to the right.") |
240 (edge-height ,pair? "A pair of numbers specifying the heights of | 239 (edge-height ,pair? "A pair of numbers specifying the heights of |
241 the vertical edges: @code{(@var{left-height} . @var{right-height})}.") | 240 the vertical edges: @code{(@var{left-height} . @var{right-height})}.") |
242 (edge-text ,pair? "A pair specifying the texts to be set at the | 241 (edge-text ,pair? "A pair specifying the texts to be set at the |
243 edges: @code{(@var{left-text} . @var{right-text})}.") | 242 edges: @code{(@var{left-text} . @var{right-text})}.") |
| 243 (round-up-exceptions ,list? "A list of pairs where car is the numerator |
| 244 and cdr the denominator of a moment. Each pair in this list means that |
| 245 the multi-measure rests of the corresponding length will be rounded up to |
| 246 the longer rest. See @var{round-up-to-longer-rest}.") |
244 (expand-limit ,integer? "Maximum number of measures expanded in | 247 (expand-limit ,integer? "Maximum number of measures expanded in |
245 church rests.") | 248 church rests.") |
246 ;; remove me? | 249 ;; remove me? |
247 (extra-dy ,number? "Slope glissandi this much extra.") | 250 (extra-dy ,number? "Slope glissandi this much extra.") |
248 (extra-offset ,number-pair? "A pair representing an offset. This | 251 (extra-offset ,number-pair? "A pair representing an offset. This |
249 offset is added just before outputting the symbol, so the typesetting | 252 offset is added just before outputting the symbol, so the typesetting |
250 engine is completely oblivious to it. The values are measured in | 253 engine is completely oblivious to it. The values are measured in |
251 @code{staff-space} units of the staff's @code{StaffSymbol}.") | 254 @code{staff-space} units of the staff's @code{StaffSymbol}.") |
252 (extra-spacing-height ,number-pair? "In the horizontal spacing | 255 (extra-spacing-height ,number-pair? "In the horizontal spacing |
253 problem, we increase the height of each item by this amount (by adding | 256 problem, we increase the height of each item by this amount (by adding |
(...skipping 268 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
522 (line-break-permission ,symbol? "Instructs the line breaker on | 525 (line-break-permission ,symbol? "Instructs the line breaker on |
523 whether to put a line break at this column. Can be @code{force} or | 526 whether to put a line break at this column. Can be @code{force} or |
524 @code{allow}.") | 527 @code{allow}.") |
525 (line-break-system-details ,list? "An alist of properties to use | 528 (line-break-system-details ,list? "An alist of properties to use |
526 if this column is the start of a system.") | 529 if this column is the start of a system.") |
527 (line-count ,integer? "The number of staff lines.") | 530 (line-count ,integer? "The number of staff lines.") |
528 (line-positions ,list? "Vertical positions of staff lines.") | 531 (line-positions ,list? "Vertical positions of staff lines.") |
529 (line-thickness ,number? "The thickness of the tie or slur | 532 (line-thickness ,number? "The thickness of the tie or slur |
530 contour.") | 533 contour.") |
531 (long-text ,markup? "Text markup. See @ruser{Formatting text}.") | 534 (long-text ,markup? "Text markup. See @ruser{Formatting text}.") |
532 (longest-church-rest ,integer? "@code{duration-log} of the longest | |
533 rest displayed in church rests.") | |
534 | 535 |
535 | 536 |
536 ;; | 537 ;; |
537 ;; m | 538 ;; m |
538 ;; | 539 ;; |
539 (max-beam-connect ,integer? "Maximum number of beams to connect | 540 (max-beam-connect ,integer? "Maximum number of beams to connect |
540 to beams from this stem. Further beams are typeset as beamlets.") | 541 to beams from this stem. Further beams are typeset as beamlets.") |
541 (max-stretch ,number? "The maximum amount that this | 542 (max-stretch ,number? "The maximum amount that this |
542 @code{VerticalAxisGroup} can be vertically stretched (for example, in | 543 @code{VerticalAxisGroup} can be vertically stretched (for example, in |
543 order to better fill a page).") | 544 order to better fill a page).") |
544 (measure-count ,integer? "The number of measures for a | 545 (measure-count ,integer? "The number of measures for a |
545 multi-measure rest.") | 546 multi-measure rest.") |
546 (measure-duration-log ,integer? "@code{duration-log} of a full measure.") | |
547 (measure-length ,ly:moment? "Length of a measure. Used in some | 547 (measure-length ,ly:moment? "Length of a measure. Used in some |
548 spacing situations.") | 548 spacing situations.") |
549 (merge-differently-dotted ,boolean? "Merge note heads in | 549 (merge-differently-dotted ,boolean? "Merge note heads in |
550 collisions, even if they have a different number of dots. This is | 550 collisions, even if they have a different number of dots. This is |
551 normal notation for some types of polyphonic music. | 551 normal notation for some types of polyphonic music. |
552 | 552 |
553 @code{merge-differently-dotted} only applies to opposing stem | 553 @code{merge-differently-dotted} only applies to opposing stem |
554 directions (i.e., voice 1 &@tie{}2).") | 554 directions (i.e., voice 1 &@tie{}2).") |
555 (merge-differently-headed ,boolean? "Merge note heads in | 555 (merge-differently-headed ,boolean? "Merge note heads in |
556 collisions, even if they have different note heads. The smaller of | 556 collisions, even if they have different note heads. The smaller of |
(...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
682 | 682 |
683 ;; | 683 ;; |
684 ;; r | 684 ;; r |
685 ;; | 685 ;; |
686 (ratio ,number? "Parameter for slur shape. The higher this | 686 (ratio ,number? "Parameter for slur shape. The higher this |
687 number, the quicker the slur attains its @code{height-limit}.") | 687 number, the quicker the slur attains its @code{height-limit}.") |
688 (remove-empty ,boolean? "If set, remove group if it contains no | 688 (remove-empty ,boolean? "If set, remove group if it contains no |
689 interesting items.") | 689 interesting items.") |
690 (remove-first ,boolean? "Remove the first staff of an orchestral | 690 (remove-first ,boolean? "Remove the first staff of an orchestral |
691 score?") | 691 score?") |
| 692 (replacement-alist ,list? "Alist of strings or characters. |
| 693 The key is a string of the pattern to be replaced. The value is a |
| 694 string of what should be displayed. Useful for ligatures.") |
692 (restore-first ,boolean? "Print a natural before the | 695 (restore-first ,boolean? "Print a natural before the |
693 accidental.") | 696 accidental.") |
694 (rhythmic-location ,rhythmic-location? "Where (bar number, | 697 (rhythmic-location ,rhythmic-location? "Where (bar number, |
695 measure position) in the score.") | 698 measure position) in the score.") |
696 (right-bound-info ,list? "An alist of properties for determining | 699 (right-bound-info ,list? "An alist of properties for determining |
697 attachments of spanners to edges.") | 700 attachments of spanners to edges.") |
698 (right-padding ,ly:dimension? "Space to insert on the right side | 701 (right-padding ,ly:dimension? "Space to insert on the right side |
699 of an object (e.g., between note and its accidentals).") | 702 of an object (e.g., between note and its accidentals).") |
700 (rotation ,list? "Number of degrees to rotate this object, and | 703 (rotation ,list? "Number of degrees to rotate this object, and |
701 what point to rotate around. For example, @code{#'(45 0 0)} rotates | 704 what point to rotate around. For example, @code{#'(45 0 0)} rotates |
702 by 45 degrees around the center of this object.") | 705 by 45 degrees around the center of this object.") |
703 (round-to-longer-rest ,boolean? "Displays the longer multi-measure | 706 (round-up-to-longer-rest ,boolean? "Displays the longer multi-measure |
704 rest when the length of a measure is between two values of | 707 rest when the length of a measure is between two values of |
705 @code{duration-log-list}. For example, displays a breve instead of a whole | 708 @code{usable-duration-logs}. For example, displays a breve instead of a whole |
706 in a 3/2 measure.") | 709 in a 3/2 measure.") |
707 | 710 |
708 | 711 |
709 ;; | 712 ;; |
710 ;; s | 713 ;; s |
711 ;; | 714 ;; |
712 (same-direction-correction ,number? "Optical correction amount | 715 (same-direction-correction ,number? "Optical correction amount |
713 for stems that are placed in tight configurations. This amount is | 716 for stems that are placed in tight configurations. This amount is |
714 used for stems with the same direction to compensate for note head to | 717 used for stems with the same direction to compensate for note head to |
715 stem distance.") | 718 stem distance.") |
(...skipping 16 matching lines...) Expand all Loading... |
732 shortest note playing here.") | 735 shortest note playing here.") |
733 (shortest-starter-duration ,ly:moment? "The duration of the | 736 (shortest-starter-duration ,ly:moment? "The duration of the |
734 shortest note that starts here.") | 737 shortest note that starts here.") |
735 (side-axis ,number? "If the value is @code{#X} (or | 738 (side-axis ,number? "If the value is @code{#X} (or |
736 equivalently@tie{}@code{0}), the object is placed horizontally next to | 739 equivalently@tie{}@code{0}), the object is placed horizontally next to |
737 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is | 740 the other object. If the value is @code{#Y} or@tie{}@code{1}, it is |
738 placed vertically.") | 741 placed vertically.") |
739 (side-relative-direction ,ly:dir? "Multiply direction of | 742 (side-relative-direction ,ly:dir? "Multiply direction of |
740 @code{direction-source} with this to get the direction of this | 743 @code{direction-source} with this to get the direction of this |
741 object.") | 744 object.") |
| 745 (simple-Y ,boolean? "Should the Y placement of a spanner |
| 746 disregard changes in system heights?") |
742 (size ,number? "Size of object, relative to standard size.") | 747 (size ,number? "Size of object, relative to standard size.") |
743 (skyline-horizontal-padding ,number? "For determining the | 748 (skyline-horizontal-padding ,number? "For determining the |
744 vertical distance between two staves, it is possible to have a | 749 vertical distance between two staves, it is possible to have a |
745 configuration which would result in a tight interleaving of grobs from | 750 configuration which would result in a tight interleaving of grobs from |
746 the top staff and the bottom staff. The larger this parameter is, the | 751 the top staff and the bottom staff. The larger this parameter is, the |
747 farther apart the staves are placed in such a configuration.") | 752 farther apart the staves are placed in such a configuration.") |
748 (skyline-vertical-padding ,number? "The amount by which the left | 753 (skyline-vertical-padding ,number? "The amount by which the left |
749 and right skylines of a column are padded vertically, beyond the | 754 and right skylines of a column are padded vertically, beyond the |
750 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent | 755 @code{Y-extent}s and @code{extra-spacing-height}s of the constituent |
751 grobs in the column. Increase this to prevent interleaving of grobs | 756 grobs in the column. Increase this to prevent interleaving of grobs |
(...skipping 20 matching lines...) Expand all Loading... |
772 (spacing-pair ,pair? "A pair of alignment symbols which set an object's | 777 (spacing-pair ,pair? "A pair of alignment symbols which set an object's |
773 spacing relative to its left and right @code{BreakAlignment}s. | 778 spacing relative to its left and right @code{BreakAlignment}s. |
774 | 779 |
775 For example, a @code{MultiMeasureRest} will ignore prefatory items at its | 780 For example, a @code{MultiMeasureRest} will ignore prefatory items at its |
776 bounds (i.e., clefs, key signatures and time signatures) using the following | 781 bounds (i.e., clefs, key signatures and time signatures) using the following |
777 override: | 782 override: |
778 | 783 |
779 @example | 784 @example |
780 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar) | 785 \\override MultiMeasureRest #'spacing-pair = #'(staff-bar . staff-bar) |
781 @end example") | 786 @end example") |
| 787 (spanner-id ,string? "An identifier to distinguish concurrent spanners.") |
782 (springs-and-rods ,boolean? "Dummy variable for triggering | 788 (springs-and-rods ,boolean? "Dummy variable for triggering |
783 spacing routines.") | 789 spacing routines.") |
784 (stacking-dir ,ly:dir? "Stack objects in which direction?") | 790 (stacking-dir ,ly:dir? "Stack objects in which direction?") |
785 (staff-affinity ,ly:dir? "The direction of the staff to use | 791 (staff-affinity ,ly:dir? "The direction of the staff to use |
786 for spacing the current non-staff line. Choices are @code{UP}, | 792 for spacing the current non-staff line. Choices are @code{UP}, |
787 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff | 793 @code{DOWN}, and @code{CENTER}. If @code{CENTER}, the non-staff |
788 line will be placed equidistant between the two nearest staves on | 794 line will be placed equidistant between the two nearest staves on |
789 either side, unless collisions or other spacing constraints | 795 either side, unless collisions or other spacing constraints |
790 prevent this. Setting @code{staff-affinity} for a staff causes it | 796 prevent this. Setting @code{staff-affinity} for a staff causes it |
791 to be treated as a non-staff line. Setting @code{staff-affinity} | 797 to be treated as a non-staff line. Setting @code{staff-affinity} |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
835 (staffgroup-staff-spacing ,list? "The spacing alist | 841 (staffgroup-staff-spacing ,list? "The spacing alist |
836 controlling the distance between the last staff of the current | 842 controlling the distance between the last staff of the current |
837 staff-group and the staff just below it in the same system, even | 843 staff-group and the staff just below it in the same system, even |
838 if one or more non-staff lines exist between the two staves. If | 844 if one or more non-staff lines exist between the two staves. If |
839 the @code{staff-staff-spacing} property of the staff's | 845 the @code{staff-staff-spacing} property of the staff's |
840 @code{VerticalAxisGroup} grob is set, that is used instead. See | 846 @code{VerticalAxisGroup} grob is set, that is used instead. See |
841 @code{staff-staff-spacing} for a description of the alist | 847 @code{staff-staff-spacing} for a description of the alist |
842 structure.") | 848 structure.") |
843 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} | 849 (stem-attachment ,number-pair? "An @code{(@var{x} . @var{y})} |
844 pair where the stem attaches to the notehead.") | 850 pair where the stem attaches to the notehead.") |
| 851 (stem-begin-position ,number? "Where does the stem begin (the |
| 852 position of the support-head)?") |
845 (stem-end-position ,number? "Where does the stem end (the end is | 853 (stem-end-position ,number? "Where does the stem end (the end is |
846 opposite to the support-head)?") | 854 opposite to the support-head)?") |
847 ;;[TODO: doco] | 855 ;;[TODO: doco] |
848 (stem-spacing-correction ,number? "Optical correction amount for | 856 (stem-spacing-correction ,number? "Optical correction amount for |
849 stems that are placed in tight configurations. For opposite | 857 stems that are placed in tight configurations. For opposite |
850 directions, this amount is the correction for two normal sized stems | 858 directions, this amount is the correction for two normal sized stems |
851 that overlap completely.") | 859 that overlap completely.") |
852 (stemlet-length ,number? "How long should be a stem over a | 860 (stemlet-length ,number? "How long should be a stem over a |
853 rest?") | 861 rest?") |
854 (stencil ,ly:stencil? "The symbol to print.") | 862 (stencil ,ly:stencil? "The symbol to print.") |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
898 | 906 |
899 | 907 |
900 ;; | 908 ;; |
901 ;; u | 909 ;; u |
902 ;; | 910 ;; |
903 (uniform-stretching ,boolean? "If set, items stretch | 911 (uniform-stretching ,boolean? "If set, items stretch |
904 proportionally to their durations. This looks better in complex | 912 proportionally to their durations. This looks better in complex |
905 polyphonic patterns.") | 913 polyphonic patterns.") |
906 (used ,boolean? "If set, this spacing column is kept in the | 914 (used ,boolean? "If set, this spacing column is kept in the |
907 spacing problem.") | 915 spacing problem.") |
| 916 (usable-duration-logs ,list? "List of @code{duration-log}s that |
| 917 can be used in typesetting the grob.") |
908 | 918 |
909 | 919 |
910 ;; | 920 ;; |
911 ;; v | 921 ;; v |
912 ;; | 922 ;; |
913 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and | 923 (vertical-skylines ,ly:skyline-pair? "Two skylines, one above and |
914 one below this grob.") | 924 one below this grob.") |
915 | 925 |
916 | 926 |
917 ;; | 927 ;; |
(...skipping 130 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1048 (right-items ,ly:grob-array? "DOCME") | 1058 (right-items ,ly:grob-array? "DOCME") |
1049 (right-neighbor ,ly:grob? "See @code{left-neighbor}.") | 1059 (right-neighbor ,ly:grob? "See @code{left-neighbor}.") |
1050 | 1060 |
1051 (side-support-elements ,ly:grob-array? "The side support, an array of | 1061 (side-support-elements ,ly:grob-array? "The side support, an array of |
1052 grobs.") | 1062 grobs.") |
1053 (slur ,ly:grob? "A pointer to a @code{Slur} object.") | 1063 (slur ,ly:grob? "A pointer to a @code{Slur} object.") |
1054 (spacing ,ly:grob? "The spacing spanner governing this section.") | 1064 (spacing ,ly:grob? "The spacing spanner governing this section.") |
1055 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing | 1065 (spacing-wishes ,ly:grob-array? "An array of note spacing or staff spacing |
1056 objects.") | 1066 objects.") |
1057 (span-start ,boolean? "Is the note head at the start of a spanner?") | 1067 (span-start ,boolean? "Is the note head at the start of a spanner?") |
| 1068 (spanner-broken ,boolean? "Indicates whether spanner |
| 1069 alignment should be broken after the current spanner.") |
1058 (spanner-placement ,ly:dir? "The place of an annotation on a spanner. | 1070 (spanner-placement ,ly:dir? "The place of an annotation on a spanner. |
1059 LEFT is for the first spanner, and RIGHT is for the last. CENTER will | 1071 LEFT is for the first spanner, and RIGHT is for the last. CENTER will |
1060 place it on the broken spanner that falls closest to the center of the length | 1072 place it on the broken spanner that falls closest to the center of the length |
1061 of the entire spanner, although this behavior is unpredictable in situations | 1073 of the entire spanner, although this behavior is unpredictable in situations |
1062 with lots of rhythmic diversity. For predictable results, use LEFT and RIGHT.") | 1074 with lots of rhythmic diversity. For predictable results, use LEFT and RIGHT.") |
1063 (staff-grouper ,ly:grob? "The staff grouper we belong to.") | 1075 (staff-grouper ,ly:grob? "The staff grouper we belong to.") |
1064 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.") | 1076 (staff-symbol ,ly:grob? "The staff symbol grob that we are in.") |
1065 (stem ,ly:grob? "A pointer to a @code{Stem} object.") | 1077 (stem ,ly:grob? "A pointer to a @code{Stem} object.") |
1066 (stems ,ly:grob-array? "An array of stem objects.") | 1078 (stems ,ly:grob-array? "An array of stem objects.") |
1067 | 1079 |
(...skipping 125 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1193 (virga ,boolean? "Is this neume a virga?") | 1205 (virga ,boolean? "Is this neume a virga?") |
1194 | 1206 |
1195 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") | 1207 (x-offset ,ly:dimension? "Extra horizontal offset for ligature heads.") |
1196 | 1208 |
1197 ))) | 1209 ))) |
1198 | 1210 |
1199 (define-public all-backend-properties | 1211 (define-public all-backend-properties |
1200 (append | 1212 (append |
1201 all-internal-grob-properties | 1213 all-internal-grob-properties |
1202 all-user-grob-properties)) | 1214 all-user-grob-properties)) |
LEFT | RIGHT |