]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/instrument-notation.itely
Replace @cindex @code => @funindex
[lilypond.git] / Documentation / user / instrument-notation.itely
index e1e848632a76d0458467dea73bab44f2e4de768d..a59988ddd5bf46d11dcb801e243b8c7ab893c8ee 100644 (file)
@@ -1,7 +1,7 @@
 @c -*- coding: utf-8; mode: texinfo; -*-
 @c This file is part of lilypond.tely
 
-@c A menu is needed before every deeper *section nesting of @node's; run 
+@c A menu is needed before every deeper *section nesting of @node's; run
 @c     M-x texinfo-all-menus-update
 @c to automatically fill in these menus before saving changes
 
@@ -229,7 +229,7 @@ In this manual: @ref{Laissez vibrer ties}
 @cindex staff switching
 @cindex cross staff
 
-@cindex @code{followVoice}
+@funindex followVoice
 
 Whenever a voice switches to another staff, a line connecting the notes
 can be printed automatically.  This is switched on by setting
@@ -253,9 +253,9 @@ Program reference: @internalsref{VoiceFollower}.
 
 @refcommands
 
-@cindex @code{\showStaffSwitch}
+@funindex \showStaffSwitch
 @code{\showStaffSwitch},
-@cindex @code{\hideStaffSwitch}
+@funindex \hideStaffSwitch
 @code{\hideStaffSwitch}.
 
 
@@ -413,11 +413,11 @@ Modifiers can be mixed with additions
 @end lilypond
 
 @cindex modifiers, in chords.
-@cindex @code{aug}
-@cindex @code{dim}
-@cindex @code{maj}
-@cindex @code{sus}
-@cindex @code{m}
+@funindex aug
+@funindex dim
+@funindex maj
+@funindex sus
+@funindex m
 
 Since an unaltered 11 does not sound good when combined with an
 unaltered 3, the 11 is removed in this case (unless it is added
@@ -426,7 +426,7 @@ explicitly)
 \chordmode { c:13 c:13.11 c:m13 }
 @end lilypond
 
-@cindex @code{/}
+@funindex /
 
 An inversion (putting one pitch of the chord on the bottom), as well
 as bass notes, can be specified by appending
@@ -434,7 +434,7 @@ as bass notes, can be specified by appending
 @lilypond[quote,ragged-right,fragment,verbatim]
 \chordmode { c1 c/g c/f }
 @end lilypond
-@cindex @code{/+}
+@funindex /+
 
 A bass note can be added instead transposed out of the chord,
 by using @code{/+}@var{pitch}.
@@ -526,7 +526,7 @@ Klaus Ignatzek (see @ref{Literature list}).  It can be tuned through the
 following properties
 
 @table @code
-@cindex @code{chordNameExceptions}
+@funindex chordNameExceptions
 @item chordNameExceptions
 This is a list that contains the chords that have special formatting.
 
@@ -555,14 +555,14 @@ For an example of tuning this property, see also
 @cindex exceptions, chord names.
 
 
-@cindex @code{majorSevenSymbol}
+@funindex majorSevenSymbol
 @item majorSevenSymbol
 This property contains the markup object used for the 7th step, when
 it is major.  Predefined options are @code{whiteTriangleMarkup} and
 @code{blackTriangleMarkup}.  See
 @inputfileref{input/@/regression,chord@/-name@/-major7@/.ly} for an example.
 
-@cindex @code{chordNameSeparator}
+@funindex chordNameSeparator
 @item chordNameSeparator
 Different parts of a chord name are normally separated by a
 slash.  By setting @code{chordNameSeparator}, you can specify other
@@ -576,31 +576,31 @@ separators, e.g.,
 }
 @end lilypond
 
-@cindex @code{chordRootNamer}
+@funindex chordRootNamer
 @item chordRootNamer
 The root of a chord is usually printed as a letter with an optional
 alteration.  The transformation from pitch to letter is done by this
 function.  Special note names (for example, the German ``H'' for a
 B-chord) can be produced by storing a new function in this property.
 
-@cindex @code{chordNoteNamer}
+@funindex chordNoteNamer
 @item chordNoteNamer
 The default is to print single pitch, e.g., the bass note, using the
 @code{chordRootNamer}.  The @code{chordNoteNamer} property can be set
 to a specialized function to change this behavior.  For example, the
 base can be printed in lower case.
 
-@cindex @code{chordPrefixSpacer}
+@funindex chordPrefixSpacer
 @item chordPrefixSpacer
-The ``m'' for minor chords is usually printed right after the root of 
-the chord. By setting @code{chordPrefixSpacer}, you can fix a spacer 
+The ``m'' for minor chords is usually printed right after the root of
+the chord. By setting @code{chordPrefixSpacer}, you can fix a spacer
 between the root and ``m''. The spacer is not used when the root
 is altered.
 
 @end table
 
 The predefined variables @code{\germanChords},
-@code{\semiGermanChords}, @code{\italianChords} and @code{\frenchChords} 
+@code{\semiGermanChords}, @code{\italianChords} and @code{\frenchChords}
 set these variables.  The effect is
 demonstrated here,
 
@@ -619,13 +619,13 @@ chart}.  Turning on these styles is described in the input file
 
 @refcommands
 
-@cindex @code{\germanChords}
+@funindex \germanChords
 @code{\germanChords},
-@cindex @code{\semiGermanChords}
+@funindex \semiGermanChords
 @code{\semiGermanChords}.
-@cindex @code{\italianChords}
+@funindex \italianChords
 @code{\italianChords}.
-@cindex @code{\frenchChords}
+@funindex \frenchChords
 @code{\frenchChords}.
 
 
@@ -687,10 +687,12 @@ way is to use the @code{\addlyrics} function.
 
 @commonprop
 
-Checking to make sure that text scripts and lyrics are within the margins is a relatively large computational task.  To speed up processing, lilypond does not perform such calculations by default; to enable it, use
+Checking to make sure that text scripts and lyrics are within the margins is
+a relatively large computational task.  To speed up processing, lilypond does
+not perform such calculations by default; to enable it, use
 
 @example
-\override Score.PaperColumn #'keep-inside-line = ##t 
+\override Score.PaperColumn #'keep-inside-line = ##t
 @end example
 
 To make lyrics avoid barlines as well, use
@@ -735,7 +737,8 @@ More stanzas can be added by adding more
 \addlyrics { joue le jeu }
 @end lilypond
 
-The command @code{\addlyrics} cannot handle polyphony settings.  For these cases you should use @code{\lyricsto} and @code{\lyricmode}.
+The command @code{\addlyrics} cannot handle polyphony settings.  For these
+cases you should use @code{\lyricsto} and @code{\lyricmode}.
 
 
 
@@ -743,7 +746,7 @@ The command @code{\addlyrics} cannot handle polyphony settings.  For these cases
 @subsection Entering lyrics
 
 @cindex lyrics
-@cindex @code{\lyricmode}
+@funindex \lyricmode
 @cindex punctuation
 
 Lyrics are entered in a special input mode.  This mode is introduced
@@ -762,17 +765,19 @@ explicitly, like in the example above, or by automatically aligning
 the lyrics to a melody or other voice of music, using @code{\addlyrics}
 or @code{\lyricsto}.  For more details see @ref{The Lyrics context}.
 
-A word or syllable of lyrics begins with an alphabetic character, and ends with
+A word or syllable of lyrics begins with an alphabetic character, and ends
+with
 any space or digit.  The following characters can be any character
 that is not a digit or white space.  One important consequence of this
 is that a word can end with @code{@}}.  The following example is
-usually a mistake in the input file.  The syllable includes a @code{@}}, so the
+usually a mistake in the input file.  The syllable includes a @code{@}}, so
+the
 opening brace is not balanced
 @example
 \lyricmode @{ twinkle@}
 @end example
 
-@cindex @code{\property}, in @code{\lyricmode}
+@funindex \property, in @code{\lyricmode
 @noindent
 Similarly, a period which follows an alphabetic sequence is included in
 the resulting string.  As a consequence, spaces must be inserted around
@@ -781,7 +786,7 @@ property commands
 \override Score . LyricText #'font-shape = #'italic
 @end example
 
-@cindex @code{_}
+@funindex _
 @cindex spaces, in lyrics
 @cindex quotes, in lyrics
 
@@ -860,14 +865,15 @@ Program reference: @internalsref{LyricHyphen}, @internalsref{LyricExtender}.
 @node The Lyrics context
 @subsection The Lyrics context
 
-Lyrics are printed by interpreting them in the context caleld @internalsref{Lyrics}.
+Lyrics are printed by interpreting them in the context caleld
+@internalsref{Lyrics}.
 
 @example
 \new Lyrics \lyricmode @dots{}
 @end example
 
 @cindex automatic syllable durations
-@cindex @code{\lyricsto}
+@funindex \lyricsto
 @cindex lyrics and melodies
 
 This will place the lyrics according to the durations that were
@@ -890,11 +896,11 @@ then the lyrics are specified with @code{\lyricsto}.  The command
 The following example uses different commands for entering lyrics.
 
 @lilypond[quote,fragment,ragged-right,verbatim]
-<< 
+<<
   \new Voice = "one" \relative c'' {
     \autoBeamOff
     \time 2/4
-    c4 b8. a16 g4. f8 e4 d c2 
+    c4 b8. a16 g4. f8 e4 d c2
   }
   \new Lyrics \lyricmode { Joy4 to8. the16 world!4. the8 Lord4 is come.2 }
   \new Lyrics \lyricmode { Joy to the earth! the Sav -- our reigns. }
@@ -916,11 +922,11 @@ must be used.
 @example
 verseOne = \lyricmode @{ Joy to the world the Lord is come @}
 \score @{
-  << 
+  <<
     \new Voice = "one" \relative c'' @{
       \autoBeamOff
       \time 2/4
-      c4 b8. a16 g4. f8 e4 d c2 
+      c4 b8. a16 g4. f8 e4 d c2
     @}
     \addlyrics @{ \verseOne @}
   >>
@@ -929,7 +935,7 @@ verseOne = \lyricmode @{ Joy to the world the Lord is come @}
 
 The @code{\addlyrics} command is actually just a convenient way
 to write a more complicated LilyPond structure that sets up the
-lyrics. 
+lyrics.
 
 @example
 @{ MUSIC @}
@@ -1018,8 +1024,8 @@ A complete example of a SATB score setup is in section
 @refcommands
 
 @code{\melisma}, @code{\melismaEnd}
-@cindex @code{\melismaEnd}
-@cindex @code{\melisma}
+@funindex \melismaEnd
+@funindex \melisma
 
 @seealso
 
@@ -1088,7 +1094,7 @@ differing ways.  Such variations can still be captured with
 @end menu
 
 @node Lyrics to multiple notes of a melisma
-@subsubsection Lyrics to multiple notes of a melisma 
+@subsubsection Lyrics to multiple notes of a melisma
 
 
 One possibility is that the text has a melisma in one stanza, but
@@ -1273,9 +1279,9 @@ The underlay is switched back to the starting situation by assigning
 
 It is also possible to define melismata entirely in the lyrics. This
 can be done by entering @code{_} for every note that is part of the
-melisma. 
+melisma.
 
-@lilypond[relative=1,verbatim,fragment] 
+@lilypond[relative=1,verbatim,fragment]
 { \set melismaBusyProperties = #'()
   c d( e) f f( e) e e  }
 \addlyrics
@@ -1305,7 +1311,7 @@ To increase the spacing between lyrics, set the minimum-distance property of
 LyricSpace.
 
 @lilypond[relative,verbatim,fragment,quote,ragged-right]
-{ 
+{
   c c c c
   \override Lyrics.LyricSpace #'minimum-distance = #1.0
   c c c c
@@ -1316,7 +1322,8 @@ LyricSpace.
 }
 @end lilypond
 
-To make this change for all lyrics in the score, set the property in the layout.
+To make this change for all lyrics in the score, set the property in the
+layout.
 
 @lilypond[relative,verbatim,quote,ragged-right]
 \score {
@@ -1428,7 +1435,8 @@ the line, just like instrument names.  They are created by setting
 
 @seealso
 
-Program reference: @internalsref{LyricText}, @internalsref{StanzaNumber}, @internalsref{VocalName}.
+Program reference: @internalsref{LyricText}, @internalsref{StanzaNumber},
+@internalsref{VocalName}.
 
 
 
@@ -1842,7 +1850,7 @@ for this purpose instead.
 @cindex String numbers
 
 String numbers can be added to chords, by indicating the string number
-with @code{\}@var{number}, 
+with @code{\}@var{number},
 
 @lilypond[relative,relative=1,ragged-right,fragment]
 <c\1 e\2 g\3>
@@ -1879,7 +1887,7 @@ are printed as tablature, by using @internalsref{TabStaff} and
 }
 @end lilypond
 
-@cindex @code{minimumFret}
+@funindex minimumFret
 @cindex fret
 
 When no string is specified, the first string that does not give a
@@ -1958,13 +1966,15 @@ and bass guitar.
 \set TabStaff.stringTunings = #bass-tuning
 @end example
 
-The default string tuning is @code{guitar-tuning} (the standard EADGBE tuning).
+The default string tuning is @code{guitar-tuning} (the standard EADGBE
+tuning).
 Some other predefined tunings are @code{guitar-open-g-tuning},
 @code{mandolin-tuning} and @code{banjo-open-g-tuning}.
 
 @seealso
 
-The file @file{scm/@/output@/-lib@/.scm} contains the predefined string tunings.
+The file @file{scm/@/output@/-lib@/.scm} contains the predefined string
+tunings.
 Program reference: @internalsref{Tab_note_heads_engraver}.
 
 @refbugs
@@ -1978,7 +1988,8 @@ No guitar special effects have been implemented.
 @cindex Banjo tablatures
 
 LilyPond has basic support for five stringed banjo.  When making tablatures
-for five stringed banjo, use the banjo tablature format function to get correct
+for five stringed banjo, use the banjo tablature format function to get
+correct
 fret numbers for the fifth string:
 
 @lilypond[quote,ragged-right,fragment,verbatim]
@@ -2077,9 +2088,9 @@ e16 b16 g16 d16
 @end lilypond
 
 
-Stopped (X) note heads are used in guitar music to signal a place where the 
-guitarist must play a certain note or chord, with its fingers just 
-touching the strings instead of fully pressing them.  This gives the sound a 
+Stopped (X) note heads are used in guitar music to signal a place where the
+guitarist must play a certain note or chord, with its fingers just
+touching the strings instead of fully pressing them.  This gives the sound a
 percussive noise-like sound that still maintains part of the original
 pitch.  It is notated with cross noteheads; this is
 demonstrated in @ref{Special noteheads}.
@@ -2124,16 +2135,16 @@ notes in the appropiate octaves, so you do not need to worry about
 { \grg G4 \grg a \grg b \grg c \grg d \grg e \grg f \grA g A }
 @end lilypond
 
-Bagpipe music nominally uses the key of D Major (even though that 
-isn't really true). However, since that is the only key that can be used, 
-the key signature is normally not written out. To set this up correctly, 
-always start your music with @code{\hideKeySignature}. If you for some 
+Bagpipe music nominally uses the key of D Major (even though that
+isn't really true). However, since that is the only key that can be used,
+the key signature is normally not written out. To set this up correctly,
+always start your music with @code{\hideKeySignature}. If you for some
 reason want to show the key signature, you can use @code{\showKeySignature}
 instead.
 
 Some modern music use cross fingering on c and f to flatten those notes.
 This can be indicated by @code{cflat} or @code{fflat}. Similarly, the
-piobaireachd high g can be written @code{gflat} when it occurs in light 
+piobaireachd high g can be written @code{gflat} when it occurs in light
 music.
 
 
@@ -2159,7 +2170,7 @@ notation.
 {
   \hideKeySignature
   \time 3/4
-  \grg \partial 4 a8. d16 
+  \grg \partial 4 a8. d16
   \slurd d2 \grg f8[ e32 d16.]
   \grg f2 \grg f8 e
   \thrwd d2 \grg b4
@@ -2426,7 +2437,8 @@ There are no rests in Gregorian Chant notation; instead, it uses
 
 @seealso
 
-In this manual: @ref{Rests} gives a general introduction into the use of rests.
+In this manual: @ref{Rests} gives a general introduction into the use of
+rests.
 
 
 @node Ancient clefs
@@ -2731,25 +2743,35 @@ following table
 {
   \set Score.timing = ##f
   \set Score.barAlways = ##t
-  s_\markup { "\\time 4/4" }^\markup { "       " \musicglyph #"timesig.neomensural44" }
+  s_\markup { "\\time 4/4" }^\markup { "       " \musicglyph
+#"timesig.neomensural44" }
   s
-  s_\markup { "\\time 2/2" }^\markup { "       " \musicglyph #"timesig.neomensural22" }
+  s_\markup { "\\time 2/2" }^\markup { "       " \musicglyph
+#"timesig.neomensural22" }
   s
-  s_\markup { "\\time 6/4" }^\markup { "       " \musicglyph #"timesig.neomensural64" }
+  s_\markup { "\\time 6/4" }^\markup { "       " \musicglyph
+#"timesig.neomensural64" }
   s
-  s_\markup { "\\time 6/8" }^\markup { "       " \musicglyph #"timesig.neomensural68" }
+  s_\markup { "\\time 6/8" }^\markup { "       " \musicglyph
+#"timesig.neomensural68" }
   \break
-  s_\markup { "\\time 3/2" }^\markup { "       " \musicglyph #"timesig.neomensural32" }
+  s_\markup { "\\time 3/2" }^\markup { "       " \musicglyph
+#"timesig.neomensural32" }
   s
-  s_\markup { "\\time 3/4" }^\markup { "       " \musicglyph #"timesig.neomensural34" }
+  s_\markup { "\\time 3/4" }^\markup { "       " \musicglyph
+#"timesig.neomensural34" }
   s
-  s_\markup { "\\time 9/4" }^\markup { "       " \musicglyph #"timesig.neomensural94" }
+  s_\markup { "\\time 9/4" }^\markup { "       " \musicglyph
+#"timesig.neomensural94" }
   s
-  s_\markup { "\\time 9/8" }^\markup { "       " \musicglyph #"timesig.neomensural98" }
+  s_\markup { "\\time 9/8" }^\markup { "       " \musicglyph
+#"timesig.neomensural98" }
   \break
-  s_\markup { "\\time 4/8" }^\markup { "       " \musicglyph #"timesig.neomensural48" }
+  s_\markup { "\\time 4/8" }^\markup { "       " \musicglyph
+#"timesig.neomensural48" }
   s
-  s_\markup { "\\time 2/4" }^\markup { "       " \musicglyph #"timesig.neomensural24" }
+  s_\markup { "\\time 2/4" }^\markup { "       " \musicglyph
+#"timesig.neomensural24" }
 }
 @end lilypond
 
@@ -2950,17 +2972,17 @@ Therefore, @file{gregorian@/-init@/.ly} also defines @code{\virgula} and
 
 @refcommands
 
-@cindex @code{\virgula}
+@funindex \virgula
 @code{\virgula},
-@cindex @code{\caesura}
+@funindex \caesura
 @code{\caesura},
-@cindex @code{\divisioMinima}
+@funindex \divisioMinima
 @code{\divisioMinima},
-@cindex @code{\divisioMaior}
+@funindex \divisioMaior
 @code{\divisioMaior},
-@cindex @code{\divisioMaxima}
+@funindex \divisioMaxima
 @code{\divisioMaxima},
-@cindex @code{\finalis}
+@funindex \finalis
 @code{\finalis}.
 
 @seealso
@@ -4020,35 +4042,35 @@ ligatures can be created.
 
 The following head prefixes are supported
 
-@cindex @code{\virga}
+@funindex \virga
 @code{\virga},
-@cindex @code{\stropha}
+@funindex \stropha
 @code{\stropha},
-@cindex @code{\inclinatum}
+@funindex \inclinatum
 @code{\inclinatum},
-@cindex @code{\auctum}
+@funindex \auctum
 @code{\auctum},
-@cindex @code{\descendens}
+@funindex \descendens
 @code{\descendens},
-@cindex @code{\ascendens}
+@funindex \ascendens
 @code{\ascendens},
-@cindex @code{\oriscus}
+@funindex \oriscus
 @code{\oriscus},
-@cindex @code{\quilisma}
+@funindex \quilisma
 @code{\quilisma},
-@cindex @code{\deminutum}
+@funindex \deminutum
 @code{\deminutum},
-@cindex @code{\cavum}
+@funindex \cavum
 @code{\cavum},
-@cindex @code{\linea}
+@funindex \linea
 @code{\linea}.
 
 Head prefixes can be accumulated, though restrictions apply.  For
 example, either @code{\descendens} or @code{\ascendens} can be applied
 to a head, but not both to the same head.
 
-@cindex @code{\pes}
-@cindex @code{\flexa}
+@funindex \pes
+@funindex \flexa
 Two adjacent heads can be tied together with the @code{\pes} and
 @code{\flexa} infix commands for a rising and falling line of melody,
 respectively.
@@ -4138,13 +4160,13 @@ usually printed over the note.
 Support for such suggested accidentals is included, and can be
 switched on by setting @code{suggestAccidentals} to true.
 
-@cindex @code{suggestAccidentals}
+@funindex suggestAccidentals
 
 @lilypond[verbatim,fragment,relative=1]
 fis gis
 \set suggestAccidentals = ##t
 ais bis
-@end lilypond 
+@end lilypond
 
 @seealso
 
@@ -4220,7 +4242,7 @@ It is also possible to use continuation lines for repeated figures,
     c4 c c
   }
   \figures {
-    \set useBassFigureExtenders = ##t 
+    \set useBassFigureExtenders = ##t
     <4 6> <3 6> <3 7>
   }
 >>
@@ -4228,7 +4250,7 @@ It is also possible to use continuation lines for repeated figures,
 
 @noindent
 In this case, the extender lines always replace existing figures.
+
 The @code{FiguredBass} context doesn't pay attention to the actual
 bass line. As a consequence, you may have to insert extra figures to
 get extender lines below all notes, and you may have to add @code{\!}
@@ -4236,9 +4258,9 @@ to avoid getting an extender line, e.g.
 
 @lilypond[relative=1]
 <<
-  \new Voice 
+  \new Voice
   \figures {
-    \set useBassFigureExtenders = ##t 
+    \set useBassFigureExtenders = ##t
     <6 4->4. <6 4->16. <6 4->32 <5>8. r16 <6>8 <6\! 5->
   }
   {
@@ -4251,20 +4273,21 @@ to avoid getting an extender line, e.g.
 When using continuation lines, common figures are always put in the
 same vertical position. When this is unwanted, you can insert a rest
 with @code{r}. The rest will clear any previous alignment.  For
-example, you can write 
+example, you can write
 
 @example
   <4 6>8 r8
 @end example
 
 @noindent
-instead of 
+instead of
 @example
   <4 6>4
 @end example
 
 Accidentals and plus signs can appear before or after the numbers,
-depending on the @code{figuredBassAlterationDirection} and @code{figuredBassPlusDirection}
+depending on the @code{figuredBassAlterationDirection} and
+@code{figuredBassPlusDirection}
 properties
 
 @lilypond