From 50840d0a9b8be36209d823d47bfcfd73860b2a5e Mon Sep 17 00:00:00 2001 From: Carl Sorensen Date: Wed, 10 Dec 2008 22:00:52 -0700 Subject: [PATCH] DOC -- Indexing for editorial and pitches -- Ralph Palmer's work --- Documentation/user/editorial.itely | 38 +++++++---- Documentation/user/pitches.itely | 105 +++++++++++++++++++++++------ 2 files changed, 111 insertions(+), 32 deletions(-) diff --git a/Documentation/user/editorial.itely b/Documentation/user/editorial.itely index c8d021a84a..568356bef9 100644 --- a/Documentation/user/editorial.itely +++ b/Documentation/user/editorial.itely @@ -45,6 +45,7 @@ inside the staff. @cindex selecting font size (notation) @cindex notation font size @cindex note heads + @funindex fontSize @funindex font-size @funindex magstep @@ -105,6 +106,7 @@ c4.-> d8---3 @cindex standard font size (notation) @cindex font size (notation), standard + @funindex font-interface @funindex font-size @@ -119,17 +121,11 @@ that use fonts. These are the ones supporting the @predefined -@funindex \teeny @code{\teeny}, -@funindex \tiny @code{\tiny}, -@funindex \small @code{\small}, -@funindex \normalsize @code{\normalsize}, -@funindex \large @code{\large}, -@funindex \huge @code{\huge}. @endpredefined @@ -147,6 +143,7 @@ Internals Reference: @cindex fingering @cindex finger change + @funindex \finger @funindex finger @@ -164,6 +161,7 @@ c4-1 d-2 f-4 c^\markup { \finger "2 - 3" } @end lilypond @cindex thumb-script + @funindex \thumb @funindex thumb @@ -224,6 +222,7 @@ Internals Reference: @cindex notes, hidden @cindex notes, invisible @cindex notes, transparent + @funindex \hideNotes @funindex hideNotes @funindex \unHideNotes @@ -273,6 +272,7 @@ Internals Reference: @unnumberedsubsubsec Coloring objects @cindex colored objects +@cindex objects, colored @cindex colors @cindex coloring objects @cindex colored notes @@ -281,6 +281,7 @@ Internals Reference: @cindex x11 color @cindex x11-color @cindex with-color + @funindex color @funindex \with-color @funindex with-color @@ -330,6 +331,7 @@ b2 cis @cindex rgb-color @cindex color, rgb @cindex rgb color + @funindex rgb-color Exact RGB colors can be specified using the Scheme function @@ -363,6 +365,7 @@ Snippets: @cindex colored notes in chords @cindex notes, colored in chords @cindex color in chords + @funindex x11-color @knownissues @@ -386,6 +389,7 @@ Notes in a chord cannot be colored with @code{\override}; use @cindex notes, ghost @cindex notes, parenthesized @cindex parentheses + @funindex \parenthesize @funindex parenthesize @@ -431,17 +435,21 @@ chord. @cindex stem, invisible @cindex invisible stem +@funindex \stemUp +@funindex stemUp +@funindex \stemDown +@funindex stemDown +@funindex \stemNeutral +@funindex stemNeutral + Whenever a note is found, a @code{Stem} object is created automatically. For whole notes and rests, they are also created but made invisible. @predefined -@funindex \stemUp @code{\stemUp}, -@funindex \stemDown @code{\stemDown}, -@funindex \stemNeutral @code{\stemNeutral}. @endpredefined @@ -489,11 +497,16 @@ from outside of the staff. @cindex notation, explaining @cindex balloon help @cindex help, balloon + @funindex \balloonGrobText @funindex \balloonText @funindex Balloon_engraver @funindex balloonGrobText @funindex balloonText +@funindex \balloonLengthOn +@funindex balloonLengthOn +@funindex \balloonLengthOff +@funindex balloonLengthOff Elements of notation can be marked and named with the help of a square balloon. The primary purpose of this feature is to explain @@ -535,11 +548,7 @@ altered: @predefined -@funindex balloonLengthOn -@funindex \balloonLengthOn @code{\balloonLengthOn}, -@funindex \balloonLengthOff -@funindex balloonLengthOff @code{\balloonLengthOff}. @endpredefined @@ -561,6 +570,7 @@ Internals Reference: @cindex lines, grid @cindex vertical lines between staves @cindex lines, vertical between staves + @funindex Grid_point_engraver @funindex Grid_line_span_engraver @funindex gridInterval @@ -630,9 +640,11 @@ Internals Reference: @cindex bracket, phrasing @cindex phrasing bracket @cindex musicological analysis +@cindex analysis, musicological @cindex note grouping bracket @cindex horizontal bracket @cindex bracket, horizontal + @funindex Horizontal_bracket_engraver @funindex \startGroup @funindex startGroup diff --git a/Documentation/user/pitches.itely b/Documentation/user/pitches.itely index 977ac59fe3..9224f8e1bb 100644 --- a/Documentation/user/pitches.itely +++ b/Documentation/user/pitches.itely @@ -47,7 +47,9 @@ mode. In most cases, relative mode will be more convenient. @cindex pitches @cindex absolute @cindex absolute octave specification +@cindex octave specification, absolute @cindex absolute octave entry +@cindex octave entry, absolute A pitch name is specified using lowercase letters@tie{}@code{a} through@tie{}@code{g}. The note names @code{c} to @code{b} are @@ -62,6 +64,7 @@ d e f g @end lilypond @cindex octave changing mark + @funindex ' @funindex , @@ -93,7 +96,11 @@ Snippets: @cindex relative @cindex relative octave entry +@cindex octave entry, relative @cindex relative octave specification +@cindex ocatve specification, relative + +@funindex relative @funindex \relative When octaves are specified in absolute mode it is easy to @@ -168,6 +175,9 @@ large intervals: } @end lilypond +@cindex chords and relative octave entry +@cindex relative octave entry and chords + If the preceding item is a chord, the first note of the chord is used as the reference point for the octave placement of a following note or chord. Inside chords, the next note is always @@ -219,9 +229,13 @@ Internals Reference: @cindex relative octave entry and transposition @cindex transposition and relative octave entry + @funindex \transpose +@funindex transpose @funindex \chordmode +@funindex chordmode @funindex \relative +@funindex relative @knownissues @@ -256,6 +270,7 @@ see @rlearning{Accidentals and key signatures}.} @cindex note names, Dutch @cindex note names, default +@cindex default note names @cindex sharp @cindex flat @cindex double sharp @@ -286,7 +301,8 @@ a4 aes a2 @end lilypond @cindex quarter tones -@cindex semi-flats, semi-sharps +@cindex semi-flats +@cindex semi-sharps Quarter tones may be added; the following is a series of Cs with increasing pitches: @@ -301,11 +317,13 @@ ceseh1 ces ceh c cih cis cisih @cindex accidental, cautionary @cindex accidental, parenthesized @cindex reminder accidental -@funindex ? @cindex cautionary accidental @cindex parenthesized accidental + +@funindex ? @funindex ! + Normally accidentals are printed automatically, but you may also print them manually. A reminder accidental can be forced by adding an exclamation mark@tie{}@code{!} after the pitch. A @@ -530,8 +548,10 @@ This section discusses how to modify pitches. @cindex octave correction @cindex octave check @cindex control pitch + @funindex = @funindex \octaveCheck +@funindex octaveCheck @funindex controlpitch In relative mode, it is easy to forget an octave changing mark. @@ -605,7 +625,9 @@ Internals Reference: @cindex transposition of notes @cindex pitches, transposition of @cindex notes, transposition of + @funindex \transpose +@funindex transpose A music expression can be transposed with @code{\transpose}. The syntax is @@ -670,8 +692,6 @@ music = \relative c' { c d e f } } @end lilypond -@cindex transposing instruments -@cindex instruments, transposing @code{\transpose} may also be used in a different way, to input written notes for a transposing instrument. The previous examples @@ -719,8 +739,11 @@ Internals Reference: @funindex \transpose +@funindex transpose @funindex \chordmode +@funindex chordmode @funindex \relative +@funindex relative @knownissues @@ -748,7 +771,6 @@ This section discusses how to alter the output of pitches. @node Clef @unnumberedsubsubsec Clef -@funindex \clef @cindex G clef @cindex C clef @cindex F clef @@ -781,6 +803,9 @@ This section discusses how to alter the output of pitches. @cindex clef, varbaritone @cindex subbass clef, subbass +@funindex \clef +@funindex clef + The clef may be altered. Middle C is shown in every example. @lilypond[verbatim,quote,relative=1] @@ -825,6 +850,7 @@ and @ref{Gregorian clefs}. @cindex clef, transposing @cindex octave transposition @cindex choral tenor clef +@cindex tenor clef, choral By adding@tie{}@code{_8} or@tie{}@code{^8} to the clef name, the clef is transposed one octave down or up, respectively, @@ -866,7 +892,9 @@ Internals Reference: @unnumberedsubsubsec Key signature @cindex key signature + @funindex \key +@funindex key @c duplicated in Key signature and Accidentals @warning{New users are sometimes confused about accidentals and @@ -885,14 +913,24 @@ at the start of the staff. The key signature may be altered: @end example @funindex \major +@funindex major @funindex \minor +@funindex minor @funindex \ionian +@funindex ionian @funindex \locrian +@funindex locrian @funindex \aeolian +@funindex aeolian @funindex \mixolydian +@funindex mixolydian @funindex \lydian +@funindex lydian @funindex \phrygian +@funindex phrygian @funindex \dorian +@funindex dorian + @cindex church modes @cindex modes @cindex major @@ -958,7 +996,10 @@ Internals Reference: @cindex 8va @cindex 8ve @cindex octavation + @funindex set-octavation +@funindex \ottava +@funindex ottava @notation{Ottava brackets} introduce an extra transposition of an octave for the staff: @@ -1002,7 +1043,9 @@ Internals Reference: @cindex transposing instrument @cindex MIDI @cindex MIDI transposition + @funindex \transposition +@funindex transposition When typesetting scores that involve transposing instruments, some parts can be typeset in a different pitch than the @@ -1096,8 +1139,10 @@ Snippets: @cindex accidentals, automatic @cindex automatic accidentals @cindex default accidental style + @funindex set-accidental-style @funindex voice +@funindex default There are many different conventions on how to typeset accidentals. LilyPond provides a function to specify which @@ -1124,7 +1169,6 @@ style in all staves of the current @code{StaffGroup}, use: The following accidental styles are supported. To demonstrate each style, we use the following example: -@funindex default @lilypond[verbatim,quote] musicA = { @@ -1198,6 +1242,7 @@ both staves. @cindex default accidental style @cindex accidental style, default + @funindex default This is the default typesetting behavior. It corresponds to @@ -1261,6 +1306,7 @@ musicB = { @cindex modern accidental style @cindex accidental style, modern-cautionary @cindex modern-cautionary accidental style + @funindex voice The normal behavior is to remember the accidentals at @@ -1328,6 +1374,7 @@ musicB = { @cindex accidentals, modern style @cindex modern style accidentals + @funindex modern This rule corresponds to the common practice in the twentieth @@ -1392,6 +1439,7 @@ musicB = { @cindex modern cautionary accidental style @cindex modern style accidentals @cindex modern style cautionary accidentals + @funindex modern-cautionary This rule is similar to @code{modern}, but the @q{extra} @@ -1455,6 +1503,7 @@ musicB = { @cindex modern accidental style @cindex modern accidentals @cindex multivoice accidentals + @funindex modern-voice This rule is used for multivoice accidentals to be read both by @@ -1515,6 +1564,7 @@ musicB = { @cindex accidental style, cautionary, modern voice @cindex accidental style, modern voice cautionary @cindex accidental style, voice, modern cautionary + @funindex modern-voice-cautionary @item modern-voice-cautionary @@ -1577,6 +1627,7 @@ musicB = { @cindex accidentals, piano @cindex piano accidental style @cindex piano accidentals + @funindex piano This rule reflects twentieth-century practice for piano notation. @@ -1635,7 +1686,6 @@ musicB = { @item piano-cautionary -@funindex piano-cautionary @cindex accidentals, piano cautionary @cindex cautionary accidentals, piano @cindex piano cautionary accidentals @@ -1643,6 +1693,8 @@ musicB = { @cindex cautionary accidental style, piano @cindex piano cautionary accidental style +@funindex piano-cautionary + This is the same as @code{piano} but with the extra accidentals typeset as cautionaries. @@ -1694,10 +1746,11 @@ musicB = { @item neo-modern -@funindex neo-modern @cindex neo-modern accidental style @cindex accidental style, neo-modern +@funindex neo-modern + This rule reproduces a common practice in contemporary music: accidentals are printed like with @code{modern}, but they are printed again if the same note appears later in the same measure -- except @@ -1751,10 +1804,11 @@ musicB = { @item neo-modern-cautionary -@funindex neo-modern-cautionary @cindex neo-modern-cautionary accidental style @cindex accidental style, neo-modern-cautionary +@funindex neo-modern-cautionary + This rule is similar to @code{neo-modern}, but the extra accidentals are printed as cautionary accidentals. @@ -1807,10 +1861,11 @@ musicB = { @item dodecaphonic -@funindex dodecaphonic @cindex dodecaphonic accidental style @cindex dodecaphonic style, neo-modern +@funindex dodecaphonic + This rule reflects a practice introduced by composers at the beginning of the 20th century, in an attempt to abolish the hierarchy between natural and non-natural notes. @@ -1866,10 +1921,11 @@ musicB = { @item teaching -@funindex teaching @cindex teaching accidental style @cindex accidental style, teaching +@funindex teaching + This rule is intended for students, and makes it easy to create scale sheets with automagically created cautionary accidentals. Accidentals are printed like with @code{modern}, but cautionary @@ -1928,10 +1984,11 @@ musicB = { @item no-reset -@funindex no-reset @cindex accidental style, no reset @cindex no reset accidental style +@funindex no-reset + This is the same as @code{default} but with accidentals lasting @q{forever} and not only within the same measure: @@ -1983,10 +2040,11 @@ musicB = { @item forget -@funindex forget @cindex forget accidental style @cindex accidental style, forget +@funindex forget + This is the opposite of @code{no-reset}: Accidentals are not remembered at all -- and hence all accidentals are typeset relative to the key signature, regardless of what came before in @@ -2173,6 +2231,7 @@ This section suggests ways of altering note heads. @cindex guitar note heads @cindex note head styles @cindex styles, note heads + @funindex cross Note heads may be altered: @@ -2227,6 +2286,11 @@ Internals Reference: @cindex easy play note heads @cindex note heads, easy play +@funindex \easyHeadsOn +@funindex easyHeadsOn +@funindex \easyHeadsOff +@funindex easyHeadsOff + The @q{easy play} note head includes a note name inside the head. It is used in music for beginners. To make the letters readable, it should be printed in a large font size. To print with a larger @@ -2245,9 +2309,7 @@ font, see @ref{Setting the staff size}. @predefined -@funindex \easyHeadsOn @code{\easyHeadsOn}, -@funindex \easyHeadsOff @code{\easyHeadsOff}. @endpredefined @@ -2275,9 +2337,13 @@ Internals Reference: @cindex shape notes @cindex Aiken shape note heads @cindex sacred harp note heads + @funindex \key +@funindex key @funindex \aikenHeads +@funindex aikenHeads @funindex \sacredHarpHeads +@funindex sacredHarpHeads In shape note head notation, the shape of the note head corresponds to the harmonic function of a note in the scale. This @@ -2296,9 +2362,7 @@ base of the scale is determined by the @code{\key} command. @predefined -@funindex \aikenHeads @code{\aikenHeads}, -@funindex \sacredHarpHeads @code{\sacredHarpHeads}. @endpredefined @@ -2334,6 +2398,11 @@ Internals Reference: @cindex note heads, improvisation @cindex note heads, slashed +@funindex \improvisationOn +@funindex improvisationOn +@funindex \improvisationOff +@funindex improvisationOff + Improvisation is sometimes denoted with slashed note heads, where the performer may choose any pitch but should play the specified rhythm. Such note heads can be created: @@ -2354,9 +2423,7 @@ rhythm. Such note heads can be created: @predefined -@funindex \improvisationOn @code{\improvisationOn}, -@funindex \improvisationOff @code{\improvisationOff}. @endpredefined -- 2.39.2