Issue 5064 Let analysis brackets support text

[lilypond.git] / Documentation / notation / fretted-strings.itely

diff --git a/Documentation/notation/fretted-strings.itely b/Documentation/notation/fretted-strings.itely
index e1ccd070a670f50d60352bf036a2fd07d1bf75f7..5a7676d64640576125f313f1930d57c55a50bd54 100644 (file)
--- a/Documentation/notation/fretted-strings.itely
+++ b/Documentation/notation/fretted-strings.itely
@@ -7,7 +7,7 @@
     Guide, node Updating translation committishes..
 @end ignore
 
     Guide, node Updating translation committishes..
 @end ignore
 

-@c \version "2.19.21"
+@c \version "2.19.28"

 
 @node Fretted string instruments
 @section Fretted string instruments
 
 @node Fretted string instruments
 @section Fretted string instruments


@@ -27,6 +27,7 @@ to fretted string instruments.
 * Common notation for fretted strings::
 * Guitar::
 * Banjo::
 * Common notation for fretted strings::
 * Guitar::
 * Banjo::

+* Lute::

 @end menu
 
 @node Common notation for fretted strings
 @end menu
 
 @node Common notation for fretted strings


@@ -99,10 +100,10 @@ Notation Reference:
 The string on which a note should be played may be indicated by
 appending @code{\@var{number}} to a note.
 
 The string on which a note should be played may be indicated by
 appending @code{\@var{number}} to a note.
 

-@lilypond[verbatim,quote,relative=0]
+@lilypond[verbatim,quote,fragment]

 \clef "treble_8"
 c4\5 e\4 g2\3
 \clef "treble_8"
 c4\5 e\4 g2\3

-<c,\5 e\4 g\3>1
+<c\5 e\4 g\3>1

 @end lilypond
 
 When fingerings and string indications are used together, their
 @end lilypond
 
 When fingerings and string indications are used together, their


@@ -111,7 +112,7 @@ in the code @emph{only} if they appear inside of an explicit chord:
 applied to whole chords or single notes @emph{outside} of chords,
 fingerings are placed using a different mechanism.
 
 applied to whole chords or single notes @emph{outside} of chords,
 fingerings are placed using a different mechanism.
 

-@lilypond[verbatim,quote,relative=1]
+@lilypond[verbatim,quote,fragment]

 \clef "treble_8"
 g4\3-0
 g-0\3
 \clef "treble_8"
 g4\3-0
 g-0\3


@@ -123,11 +124,12 @@ String numbers may also, as is customary with unfretted strings,
 be printed in Roman numerals and placed below the staff rather
 than above.
 
 be printed in Roman numerals and placed below the staff rather
 than above.
 

-@lilypond[verbatim,quote,relative=2]
-c2\2
+@lilypond[verbatim,quote,fragment]
+\clef "treble_8"
+c'2\2

 a\3
 \romanStringNumbers
 a\3
 \romanStringNumbers

-c\2
+c'\2

 \set stringNumberOrientations = #'(down)
 a\3
 \arabicStringNumbers
 \set stringNumberOrientations = #'(down)
 a\3
 \arabicStringNumbers


@@ -192,7 +194,7 @@ calligraphic tablature clef is added automatically.
 @end lilypond
 
 Default tablatures do not contain any symbols for tone duration nor any
 @end lilypond
 
 Default tablatures do not contain any symbols for tone duration nor any

-other musical symbols such as e.g. expressive marks.
+other musical symbols such as expressive marks, for example.

 
 @lilypond[quote,ragged-right,verbatim]
 symbols = {
 
 @lilypond[quote,ragged-right,verbatim]
 symbols = {


@@ -595,7 +597,6 @@ is the standard EADGBE tuning.  Some other predefined tunings are
 @code{banjo-open-g-tuning}.  The predefined string tunings
 are found in @file{ly/string-tunings-init.ly}.
 
 @code{banjo-open-g-tuning}.  The predefined string tunings
 are found in @file{ly/string-tunings-init.ly}.
 

-@funindex stringTuning

 @funindex \stringTuning
 @cindex tablature, custom string tunings
 @cindex custom string tunings
 @funindex \stringTuning
 @cindex tablature, custom string tunings
 @cindex custom string tunings


@@ -667,7 +668,7 @@ one for each string, ordered by string number from 1 to N,
 where string 1 is at the top of the tablature staff and
 string N is at the bottom.  This ordinarily results in ordering
 from highest pitch to lowest pitch, but some instruments
 where string 1 is at the top of the tablature staff and
 string N is at the bottom.  This ordinarily results in ordering
 from highest pitch to lowest pitch, but some instruments

-(e.g. ukulele) do not have strings ordered by pitch.
+(e.g., ukulele) do not have strings ordered by pitch.

 
 A string pitch in a string tuning list is a LilyPond pitch
 object.  Pitch objects are created with the Scheme function
 
 A string pitch in a string tuning list is a LilyPond pitch
 object.  Pitch objects are created with the Scheme function


@@ -712,6 +713,44 @@ A modern tab clef can also be used.
 
 The modern tab clef supports tablatures from 4 to 7 strings.
 
 
 The modern tab clef supports tablatures from 4 to 7 strings.
 

+@cindex micro-tones, tab
+@cindex quarter-tones, tab
+@cindex tab micro-tones
+@cindex tab quarter-tones
+
+@code{TabStaff} may support micro-tones like quarter-tones, which
+can be played using bendings.
+@code{supportNonIntegerFret = ##t} needs to be set in
+Score-context.  However, micro-tones are not supported in @code{FretBoards}.
+
+@lilypond[quote,ragged-right,verbatim]
+\layout {
+  \context {
+    \Score
+    supportNonIntegerFret = ##t
+  }
+}
+
+custom-tuning = \stringTuning <e, a, d ges beh eeh'>
+
+mus = \relative {
+  eeses'4
+  eeseh
+  ees
+  eeh
+  e
+  eih
+  eis
+  eisih
+  eisis
+}
+
+<<
+  \new Staff << \clef "G_8" \mus >>
+  \new TabStaff \with { stringTunings = \custom-tuning } \mus
+>>
+@end lilypond
+

 @seealso
 Notation Reference:
 @ref{Absolute octave entry},
 @seealso
 Notation Reference:
 @ref{Absolute octave entry},


@@ -803,7 +842,6 @@ the fret-diagram markup string.
 @cindex fret-diagram markup
 @cindex ukulele
 
 @cindex fret-diagram markup
 @cindex ukulele
 

-@funindex fret-diagram

 @funindex \fret-diagram
 
 The size of the fret diagram, and the number of frets in the diagram
 @funindex \fret-diagram
 
 The size of the fret diagram, and the number of frets in the diagram


@@ -894,7 +932,6 @@ markup string.
 
 @cindex fret-diagram-terse markup
 
 
 @cindex fret-diagram-terse markup
 

-@funindex fret-diagram-terse

 @funindex \fret-diagram-terse
 
 The fret-diagram-terse markup string omits string numbers; the string
 @funindex \fret-diagram-terse
 
 The fret-diagram-terse markup string omits string numbers; the string


@@ -972,7 +1009,6 @@ Other fret diagram properties must be adjusted using
 @cindex fret-diagram-verbose markup
 @cindex capo
 
 @cindex fret-diagram-verbose markup
 @cindex capo
 

-@funindex fret-diagram-verbose

 @funindex \fret-diagram-verbose
 
 The fret-diagram-verbose markup string is in the format of a Scheme list.  Each
 @funindex \fret-diagram-verbose
 
 The fret-diagram-verbose markup string is in the format of a Scheme list.  Each


@@ -1021,12 +1057,14 @@ capo will be the lowest fret in the fret diagram.
 Fingering indication dots can be colored as well as parenthesized;
 the parenthesis's color can also be altered independently.
 
 Fingering indication dots can be colored as well as parenthesized;
 the parenthesis's color can also be altered independently.
 

+Markups can be placed into the dots as well.
+

 @c \override is necessary to make fingering visible
 @lilypond[quote, verbatim]
 <<
     \new ChordNames {
       \chordmode {
 @c \override is necessary to make fingering visible
 @lilypond[quote, verbatim]
 <<
     \new ChordNames {
       \chordmode {

-        f1 g c c
+        f1 g c c b

       }
     }
   \new Staff {
       }
     }
   \new Staff {


@@ -1062,7 +1100,7 @@ the parenthesis's color can also be altered independently.
         (place-fret 2 5 3)
       )
     }
         (place-fret 2 5 3)
       )
     }

-    \override Voice.TextScript.size = 1.5
+    \override Voice.TextScript.size = 1.4

     <c g c' e' g'>1^\markup {
       \fret-diagram-verbose #'(
         (place-fret 6 3 1 red parenthesized default-paren-color)
     <c g c' e' g'>1^\markup {
       \fret-diagram-verbose #'(
         (place-fret 6 3 1 red parenthesized default-paren-color)


@@ -1073,6 +1111,24 @@ the parenthesis's color can also be altered independently.
         (place-fret 1 3 1 inverted)
       )
     }
         (place-fret 1 3 1 inverted)
       )
     }

+    \override Voice.TextScript.size = 1.5
+    <b, fis b dis' fis'>1^\markup {
+      \override #'(fret-diagram-details . ((finger-code . in-dot)))
+      \fret-diagram-verbose #`(
+        (place-fret 5 2 1)
+        (place-fret 4 4 "fis" red)
+        (place-fret 3 4 "b" red)
+        (place-fret
+          2 4
+          ,#{ \markup
+                \concat {
+                  \vcenter "d"
+                  \fontsize #-5
+                  \musicglyph #"accidentals.sharp"} #}
+          red)
+        (place-fret 1 2 1)
+      )
+    }

   }
 >>
 @end lilypond
   }
 >>
 @end lilypond


@@ -1239,7 +1295,6 @@ either as simultaneous music or using chord mode (see
 @cindex fret diagrams with chord names
 
 @funindex ChordNames
 @cindex fret diagrams with chord names
 
 @funindex ChordNames

-@funindex chordmode

 @funindex \chordmode
 
 It is common that both chord names and fret diagrams are displayed together.
 @funindex \chordmode
 
 It is common that both chord names and fret diagrams are displayed together.


@@ -1383,8 +1438,6 @@ mychords = \chordmode {
 @cindex chord shapes for fretted instruments
 
 @funindex \addChordShape
 @cindex chord shapes for fretted instruments
 
 @funindex \addChordShape

-@funindex addChordShape
-@funindex storePredefinedDiagram

 @funindex \storePredefinedDiagram
 
 In addition to fret diagrams, LilyPond stores an internal list of chord
 @funindex \storePredefinedDiagram
 
 In addition to fret diagrams, LilyPond stores an internal list of chord


@@ -1501,9 +1554,7 @@ calculates strings and frets that can be used to play the notes.
 >>
 @end lilypond
 
 >>
 @end lilypond
 

-@funindex predefinedFretboardsOff

 @funindex \predefinedFretboardsOff
 @funindex \predefinedFretboardsOff

-@funindex predefinedFretboardsOn

 @funindex \predefinedFretboardsOn
 
 As no predefined diagrams are loaded by default, automatic calculation
 @funindex \predefinedFretboardsOn
 
 As no predefined diagrams are loaded by default, automatic calculation


@@ -1638,7 +1689,6 @@ with non-monotonic tunings.
 @cindex fingerings, right hand for fretted instruments
 @cindex right hand fingerings for fretted instruments
 
 @cindex fingerings, right hand for fretted instruments
 @cindex right hand fingerings for fretted instruments
 

-@funindex rightHandFinger

 @funindex \rightHandFinger
 
 Right-hand fingerings @var{p-i-m-a} must be entered using
 @funindex \rightHandFinger
 
 Right-hand fingerings @var{p-i-m-a} must be entered using


@@ -1647,14 +1697,14 @@ Right-hand fingerings @var{p-i-m-a} must be entered using
 @warning{If the number is entered in Scheme notation, remember to append
 a space before following it with a closing @code{>} or similar.}
 
 @warning{If the number is entered in Scheme notation, remember to append
 a space before following it with a closing @code{>} or similar.}
 

-@lilypond[quote,verbatim,relative=0]
+@lilypond[quote,verbatim,fragment]

 \clef "treble_8"
 c4\rightHandFinger #1
 e\rightHandFinger #2
 g\rightHandFinger #3
 \clef "treble_8"
 c4\rightHandFinger #1
 e\rightHandFinger #2
 g\rightHandFinger #3

-c\rightHandFinger #4
-<c,\rightHandFinger #1 e\rightHandFinger #2
- g\rightHandFinger #3 c\rightHandFinger #4 >1
+c'\rightHandFinger #4
+<c\rightHandFinger #1 e\rightHandFinger #2
+ g\rightHandFinger #3 c'\rightHandFinger #4 >1

 @end lilypond
 
 For convenience, you can abbreviate @code{\rightHandFinger} to something
 @end lilypond
 
 For convenience, you can abbreviate @code{\rightHandFinger} to something


@@ -1708,14 +1758,16 @@ or, for experienced users, a typesetter like GuitarTeX.
 This example demonstrates how to include guitar position and
 barring indications.
 
 This example demonstrates how to include guitar position and
 barring indications.
 

-@lilypond[quote,ragged-right,verbatim,relative=0]
-\clef "treble_8"
-b16 d g b e
-\textSpannerDown
-\override TextSpanner.bound-details.left.text = #"XII "
-g16\startTextSpan
-b16 e g e b g\stopTextSpan
-e16 b g d
+@lilypond[quote,ragged-right,verbatim,fragment]
+\relative {
+  \clef "treble_8"
+  b,16 d g b e
+  \textSpannerDown
+  \override TextSpanner.bound-details.left.text = #"XII "
+  g16\startTextSpan
+  b16 e g e b g\stopTextSpan
+  e16 b g d
+}

 @end lilypond
 
 @seealso
 @end lilypond
 
 @seealso


@@ -1773,7 +1825,7 @@ music = \relative {
 
 Another playing technique (especially used on electric guitars) is
 called @notation{palm mute}.  The string is hereby partly muted by the
 
 Another playing technique (especially used on electric guitars) is
 called @notation{palm mute}.  The string is hereby partly muted by the

-palm of the striking hand (hence the name).  Lilypond supports
+palm of the striking hand (hence the name).  LilyPond supports

 the notation of palm mute-style notes by changing the note head to a
 triangle shape.
 
 the notation of palm mute-style notes by changing the note head to a
 triangle shape.
 


@@ -1807,7 +1859,6 @@ Notation Reference:
 @node Indicating power chords
 @unnumberedsubsubsec Indicating power chords
 
 @node Indicating power chords
 @unnumberedsubsubsec Indicating power chords
 

-@funindex powerChords

 @funindex \powerChords
 
 @cindex power chords
 @funindex \powerChords
 
 @cindex power chords


@@ -1820,11 +1871,11 @@ constructs:
 ChordsAndSymbols = {
   \chordmode {
     \powerChords
 ChordsAndSymbols = {
   \chordmode {
     \powerChords

-    e,,1:1.5
-    a,,1:1.5.8
+    e,,1:5
+    a,,1:5.8

     \set minimumFret = #8
     \set minimumFret = #8

-    c,1:1.5
-    f,1:1.5.8
+    c,1:5
+    f,1:5.8

   }
   \set minimumFret = #5
   <a, e>1
   }
   \set minimumFret = #5
   <a, e>1


@@ -1853,8 +1904,8 @@ other common chord modifier is used:
 mixedChords = \chordmode {
   c,1
   \powerChords
 mixedChords = \chordmode {
   c,1
   \powerChords

-  b,,1:1.5
-  fis,,1:1.5.8
+  b,,1:5
+  fis,,1:5.8

   g,,1:m
 }
 \score {
   g,,1:m
 }
 \score {


@@ -1949,3 +2000,56 @@ Installed Files:
 
 Snippets:
 @rlsr{Fretted strings}.
 
 Snippets:
 @rlsr{Fretted strings}.

+
+
+@node Lute
+@subsection Lute
+
+@menu
+* Lute tablatures::
+@end menu
+
+@node Lute tablatures
+@unnumberedsubsubsec Lute tablatures
+
+@cindex lute tablatures
+@cindex tablature, lute
+
+LilyPond supports tablature for lute.
+
+To get additional bass strings use @code{additionalBassStrings}, where the
+pitches of those strings are set. They will be printed below lowest line as:
+a, /a, //a, ///a, 4, 5, etc.
+
+@code{fret-letter-tablature-format} for @code{tablatureFormat} should be used,
+probably @code{fretLabels} for further customizing.
+
+@lilypond[quote,ragged-right,verbatim]
+m = { f'4 d' a f d a, g, fis, e, d, c,  \bar "|." }
+
+\score {
+  <<
+    \new Staff { \clef bass \cadenzaOn  \m }
+    \new TabStaff \m
+  >>
+  \layout {
+    \context {
+      \Score
+      tablatureFormat = #fret-letter-tablature-format
+    }
+    \context {
+      \TabStaff
+      stringTunings = \stringTuning <a, d f a d' f'>
+      additionalBassStrings = \stringTuning <c, d, e, fis, g,>
+      fretLabels = #'("a" "b" "r" "d" "e" "f" "g" "h" "i" "k")
+    }
+  }
+}
+@end lilypond
+
+@cindex lute tunings
+@cindex tunings, lute
+
+@knownissues
+Using @code{FretBoards} with @code{additionalBassStrings} is not supported and
+will yield unsatisfying results.