X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Feditorial.itely;h=5964720b9f2a6e5c205b13ff7ad15e04b4e8a57c;hb=1d4e8083422321e7e4a6d92d1ed99980a4cbf5f6;hp=96bae8f3cd313afa4aa9190cbda91535053a0adf;hpb=aaba12ab37f85486fd3432f7ab7dbdec1dd14639;p=lilypond.git diff --git a/Documentation/user/editorial.itely b/Documentation/user/editorial.itely index 96bae8f3cd..5964720b9f 100644 --- a/Documentation/user/editorial.itely +++ b/Documentation/user/editorial.itely @@ -6,48 +6,68 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c \version "2.11.38" +@c \version "2.11.61" @node Editorial annotations @section Editorial annotations @lilypondfile[quote]{editorial-headword.ly} -This section discusses the various ways to change the appearance of +This section discusses the various ways to change the appearance of notes and add analysis or educational emphasis. @menu -* Inside the staff:: -* Outside the staff:: +* Inside the staff:: +* Outside the staff:: @end menu @node Inside the staff @subsection Inside the staff -This section discusses how to add emphasis to elements that are +This section discusses how to add emphasis to elements that are inside the staff. @menu -* Selecting notation font size:: -* Fingering instructions:: -* Hidden notes:: -* Coloring objects:: -* Parentheses:: -* Stems:: +* Selecting notation font size:: +* Fingering instructions:: +* Hidden notes:: +* Coloring objects:: +* Parentheses:: +* Stems:: @end menu @node Selecting notation font size @unnumberedsubsubsec Selecting notation font size -@cindex font size -@cindex font size, selecting -@cindex selecting font size +@cindex font size (notation) scaling +@cindex font size (notation) +@cindex selecting font size (notation) +@cindex notation font size +@cindex note heads +@funindex fontSize +@funindex font-size +@funindex magstep +@funindex \huge +@funindex \large +@funindex \normalsize +@funindex \small +@funindex \tiny +@funindex \teeny +@funindex huge +@funindex large +@funindex normalsize +@funindex small +@funindex tiny +@funindex teeny The font size of notation elements may be altered. It does not change the size of variable symbols, such as beams or slurs. -@lilypond[quote,fragment,relative=2,verbatim,ragged-right] +@warning{For font sizes of text, see +@ref{Selecting font and font size}.} + +@lilypond[verbatim,quote,relative=2] \huge c4.-> d8---3 \large @@ -62,8 +82,6 @@ c4.-> d8---3 c4.-> d8---3 @end lilypond -@cindex font size scaling - Internally, this sets the @code{fontSize} property. This in turn causes the @code{font-size} property to be set in all layout objects. The value of @code{font-size} is a number indicating the @@ -74,7 +92,7 @@ Six steps is exactly a factor of two. The Scheme function factor. The @code{font-size} property can also be set directly, so that only certain layout objects are affected. -@lilypond[quote,fragment,relative=2,verbatim,ragged-right] +@lilypond[verbatim,quote,relative=2] \set fontSize = #3 c4.-> d8---3 \override NoteHead #'font-size = #-4 @@ -85,12 +103,14 @@ c4.-> d8---3 c4.-> d8---3 @end lilypond -@cindex standard font size -@cindex font size, standard +@cindex standard font size (notation) +@cindex font size (notation), standard +@funindex font-interface +@funindex font-size Font size changes are achieved by scaling the design size that is closest to the desired size. The standard font size (for -@code{font-size = #0}), depends on the standard staff height. +@w{@code{font-size = #0}}) depends on the standard staff height. For a 20pt staff, a 10pt font is selected. The @code{font-size} property can only be set on layout objects @@ -115,10 +135,10 @@ that use fonts. These are the ones supporting the @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{font-interface}. +@rinternals{font-interface}. @node Fingering instructions @@ -126,88 +146,111 @@ Internals Reference: @cindex fingering @cindex finger change +@funindex \finger +@funindex finger Fingering instructions can be entered using @var{note}-@var{digit}: -@lilypond[quote,verbatim,ragged-right,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] c4-1 d-2 f-4 e-3 @end lilypond -Markup texts may be used for finger changes. +Markup texts may be used for finger changes. -@lilypond[quote,verbatim,ragged-right,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] c4-1 d-2 f-4 c^\markup { \finger "2 - 3" } @end lilypond @cindex thumb-script +@funindex \thumb +@funindex thumb -You can use the thumb-script (e.g., in cello music) to indicate that a -note should be played with the thumb. +A thumb-script can be added (e.g., in cello music) to indicate +that a note should be played with the thumb. -@lilypond[quote,verbatim,ragged-right,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] 2 @end lilypond @cindex fingering chords +@cindex fingering instructions for chords @cindex chords, fingering Fingerings for chords can also be added to individual notes of the chord by adding them after the pitches. -@lilypond[quote,verbatim,ragged-right,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] 2 @end lilypond Fingering instructions may be manually placed above or below the -staff, see @ref{Controlling direction and placement}. +staff, see @ref{Direction and placement}. @snippets -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc] +@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] {controlling-the-placement-of-chord-fingerings.ly} +@lilypondfile[verbatim,lilyquote,texidoc,doctitle] +{allowing-fingerings-to-be-printed-inside-the-staff.ly} + @seealso Notation Reference: -@ref{Controlling direction and placement} +@ref{Direction and placement} Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{FingeringEvent}, -@internalsref{fingering-event}, -@internalsref{Fingering_engraver}, -@internalsref{New_fingering_engraver}, -@internalsref{Fingering}. +@rinternals{FingeringEvent}, +@rinternals{fingering-event}, +@rinternals{Fingering_engraver}, +@rinternals{New_fingering_engraver}, +@rinternals{Fingering}. @node Hidden notes @unnumberedsubsubsec Hidden notes -@cindex Hidden notes -@cindex Invisible notes -@cindex Transparent notes +@cindex hidden notes +@cindex invisible notes +@cindex transparent notes +@cindex notes, hidden +@cindex notes, invisible +@cindex notes, transparent @funindex \hideNotes +@funindex hideNotes @funindex \unHideNotes +@funindex unHideNotes Hidden (or invisible or transparent) notes can be useful in preparing theory or composition exercises. -@lilypond[quote,ragged-right,verbatim,relative=2,fragment] +@lilypond[verbatim,quote,relative=2] c4 d \hideNotes e4 f \unHideNotes g a -\hideNotes +\hideNotes b \unHideNotes c @end lilypond +Notation objects which are attached to invisible notes are still +visible. + +@lilypond[verbatim,quote,relative=2] +c4( d) +\hideNotes +e4(\p f)-- +@end lilypond + + @predefined @code{\hideNotes}, @code{\unHideNotes} @@ -215,11 +258,11 @@ c @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Note_spacing_engraver}, -@internalsref{NoteSpacing}. +@rinternals{Note_spacing_engraver}, +@rinternals{NoteSpacing}. @node Coloring objects @@ -231,11 +274,18 @@ Internals Reference: @cindex colored notes @cindex coloring notes @cindex notes, colored +@cindex x11 color +@cindex x11-color +@cindex with-color +@funindex color +@funindex \with-color +@funindex with-color +@funindex x11-color Individual objects may be assigned colors. Valid color names are listed in the @ref{List of colors}. -@lilypond[quote,ragged-right,verbatim,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] \override NoteHead #'color = #red c4 c \override NoteHead #'color = #(x11-color 'LimeGreen) @@ -244,7 +294,6 @@ d e @end lilypond -@cindex x11-color The full range of colors defined for X11 can be accessed by using the Scheme function @code{x11-color}. The function takes one @@ -254,9 +303,9 @@ write and is more efficient. However, using the second form it is possible to access X11 colors by the multi-word form of its name. If @code{x11-color} cannot make sense of the parameter then the -color returned defaults to black. +color returned defaults to black. -@lilypond[quote,ragged-right,verbatim,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2) \set Staff.instrumentName = \markup { \with-color #(x11-color 'navy) "Clarinet" @@ -274,38 +323,46 @@ gis a b2 cis @end lilypond +@cindex rgb-color +@cindex color, rgb +@cindex rgb color +@funindex rgb-color + Exact RGB colors can be specified using the Scheme function @code{rgb-color}. -@lilypond[quote,ragged-right,verbatim,fragment,relative=2] +@lilypond[verbatim,quote,relative=2] \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2) \set Staff.instrumentName = \markup { \with-color #(x11-color 'navy) "Clarinet" } - -% black + \override Stem #'color = #(rgb-color 0 0 0) gis8 a -% white \override Stem #'color = #(rgb-color 1 1 1) gis8 a -% dark blue -\override Stem #'color = #(rgb-color 0 0 0.5) +\override Stem #'color = #(rgb-color 0 0 0.5) gis4 a @end lilypond @seealso Notation Reference: -@ref{List of colors}, @ref{Objects connected to -the input}. +@ref{List of colors}, @ref{The +tweak command}. Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. + +@cindex x11 color +@cindex colored notes in chords +@cindex notes, colored in chords +@cindex color in chords +@funindex x11-color @knownissues An X11 color is not necessarily exactly the same shade as a -similarly named normal color. +similarly named normal color. Not all X11 colors are distinguishable in a web browser, i.e., a web browser might not display a difference between @code{'LimeGreen} @@ -314,7 +371,7 @@ and @code{'ForestGreen}. For web use normal colors are recommended Notes in a chord cannot be colored with @code{\override}; use -@code{\tweak} instead, see @ref{Objects connected to the input}. +@code{\tweak} instead, see @ref{The tweak command}. @node Parentheses @@ -324,19 +381,22 @@ Notes in a chord cannot be colored with @code{\override}; use @cindex notes, ghost @cindex notes, parenthesized @cindex parentheses +@funindex \parenthesize +@funindex parenthesize Objects may be parenthesized by prefixing @code{\parenthesize} to -the music event. When applied to a chord, it parenthesizes every -note. +the music event. When prefixed to a chord, it parenthesizes every +note. Individual notes inside a chord may also be parenthesized. -@lilypond[quote,relative=2,fragment,verbatim,ragged-right] +@lilypond[verbatim,quote,relative=2] c2 \parenthesize d c2 \parenthesize +c2 @end lilypond Non-note objects may be parenthesized as well. -@lilypond[quote,relative=2,fragment,verbatim,ragged-right] +@lilypond[verbatim,quote,relative=2] c2-\parenthesize -. d c2 \parenthesize r @end lilypond @@ -344,18 +404,26 @@ c2 \parenthesize r @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Parenthesis_engraver}, -@internalsref{ParenthesesItem}, -@internalsref{parentheses-interface}. +@rinternals{Parenthesis_engraver}, +@rinternals{ParenthesesItem}, +@rinternals{parentheses-interface}. + +@knownissues + +Parenthesizing a chord prints parentheses around each individual +note, instead of a single large parenthesis around the entire +chord. @node Stems @unnumberedsubsubsec Stems @cindex stem +@cindex stem, invisible +@cindex invisible stem Whenever a note is found, a @code{Stem} object is created automatically. For whole notes and rests, they are also created but @@ -378,91 +446,137 @@ made invisible. @cindex stem, down @cindex stem, neutral -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc] +@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] {default-direction-of-stems-on-the-center-line-of-the-staff.ly} @seealso Notation Reference: -@ref{Controlling direction and placement}. +@ref{Direction and placement}. Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Stem_engraver}, -@internalsref{Stem}, -@internalsref{stem-interface}. +@rinternals{Stem_engraver}, +@rinternals{Stem}, +@rinternals{stem-interface}. @node Outside the staff @subsection Outside the staff -This section discusses how to add emphasis to elements in the staff -from outside of the staff. +This section discusses how to add emphasis to elements in the staff +from outside of the staff. @menu -* Balloon help:: -* Grid lines:: -* Analysis brackets:: +* Balloon help:: +* Grid lines:: +* Analysis brackets:: @end menu @node Balloon help @unnumberedsubsubsec Balloon help +@cindex balloon +@cindex notation, explaining +@cindex balloon help +@cindex help, balloon +@funindex \balloonGrobText +@funindex \balloonText +@funindex Balloon_engraver +@funindex balloonGrobText +@funindex balloonText + Elements of notation can be marked and named with the help of a square balloon. The primary purpose of this feature is to explain notation. -@lilypond[quote,verbatim,fragment,ragged-right,relative=2] +@lilypond[verbatim,quote,relative=2] \new Voice \with { \consists "Balloon_engraver" } { \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" } - a8 + a8 \balloonGrobText #'Rest #'(-4 . -4) \markup { "I'm a rest" } r - 2. + 2. } @end lilypond + There are two music functions, @code{balloonGrobText} and -@code{balloonText}; the former is used like @code{\once \override} to -attach text to any grob, and the latter is used like @code{\tweak}, -typically within chords, to attach text to an individual note. +@code{balloonText}; the former is used like +@w{@code{\once \override}} to attach text to any grob, and the +latter is used like @code{\tweak}, typically within chords, to +attach text to an individual note. -@cindex balloon -@cindex notation, explaining +Balloon text normally influences note spacing, but this can be +altered: + +@lilypond[verbatim,quote,relative=2] +\new Voice \with { \consists "Balloon_engraver" } +{ + \balloonLengthOff + \balloonGrobText #'Stem #'(3 . 4) \markup { "I'm a Stem" } + a8 + \balloonGrobText #'Rest #'(-4 . -4) \markup { "I'm a rest" } + r + \balloonLengthOn + 2. +} +@end lilypond + + +@predefined + +@funindex balloonLengthOn +@funindex balloonLengthOff +@funindex \balloonLengthOn +@funindex \balloonLengthOff + +@code{\balloonLengthOn}, @code{\balloonLengthOff} @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Balloon_engraver}, -@internalsref{BalloonTextItem}, -@internalsref{balloon-interface}. +@rinternals{Balloon_engraver}, +@rinternals{BalloonTextItem}, +@rinternals{balloon-interface}. @node Grid lines @unnumberedsubsubsec Grid lines +@cindex grid lines +@cindex lines, grid +@cindex vertical lines between staves +@cindex lines, vertical between staves +@funindex Grid_point_engraver +@funindex Grid_line_span_engraver +@funindex gridInterval + Vertical lines can be drawn between staves synchronized with the notes. -@lilypond[quote,verbatim,ragged-right] +The @code{Grid_point_engraver} must be used to create the end +points of the lines, while the @code{Grid_line_span_engraver} must +be used to actually draw the lines. By default this centers grid +lines horizontally below and to the left side of each note head. +Grid lines extend from the middle lines of each staff. The +@code{gridInterval} must specify the duration between the grid +lines. + +@lilypond[verbatim,quote] \layout { \context { \Staff - % set up grids - \consists "Grid_point_engraver" - % set the grid interval to one quarter note + \consists "Grid_point_engraver" gridInterval = #(ly:make-moment 1 4) } \context { \Score - % by default this centers grid lines horizontally below - % and to the left side of the note head, the grid lines - % extending from the middle lines of each staff \consists "Grid_line_span_engraver" } } @@ -484,39 +598,47 @@ notes. @snippets -@lilypondfile[verbatim,lilyquote,ragged-right,texidoc] -{grid-lines-changing-their-appearance.ly} +@lilypondfile[verbatim,lilyquote,ragged-right,texidoc,doctitle] +{grid-lines--changing-their-appearance.ly} @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Grid_line_span_engraver}, -@internalsref{Grid_point_engraver}, -@internalsref{GridLine}, -@internalsref{GridPoint}, -@internalsref{grid-line-interface}, -@internalsref{grid-point-interface}. +@rinternals{Grid_line_span_engraver}, +@rinternals{Grid_point_engraver}, +@rinternals{GridLine}, +@rinternals{GridPoint}, +@rinternals{grid-line-interface}, +@rinternals{grid-point-interface}. @node Analysis brackets @unnumberedsubsubsec Analysis brackets @cindex brackets -@cindex phrasing brackets +@cindex bracket, phrasing +@cindex phrasing bracket @cindex musicological analysis @cindex note grouping bracket +@cindex horizontal bracket +@cindex bracket, horizontal +@funindex Horizontal_bracket_engraver +@funindex \startGroup +@funindex startGroup +@funindex \stopGroup +@funindex stopGroup Brackets are used in musical analysis to indicate structure in musical pieces. Simple horizontal brackets are supported. -@lilypond[quote,verbatim,ragged-right] +@lilypond[verbatim,quote] \layout { \context { - \Staff + \Voice \consists "Horizontal_bracket_engraver" } } @@ -528,10 +650,10 @@ pieces. Simple horizontal brackets are supported. Analysis brackets may be nested. -@lilypond[quote,verbatim,ragged-right] +@lilypond[verbatim,quote] \layout { \context { - \Staff + \Voice \consists "Horizontal_bracket_engraver" } } @@ -546,11 +668,11 @@ Analysis brackets may be nested. @seealso Snippets: -@lsrdir{Editorial,Editorial-annotations}. +@rlsr{Editorial annotations}. Internals Reference: -@internalsref{Horizontal_bracket_engraver}, -@internalsref{HorizontalBracket}, -@internalsref{horizontal-bracket-interface}, -@internalsref{Staff}. +@rinternals{Horizontal_bracket_engraver}, +@rinternals{HorizontalBracket}, +@rinternals{horizontal-bracket-interface}, +@rinternals{Staff}.