]> git.donarmstrong.com Git - lilypond.git/commitdiff
Beautify texinfo doc strings. Some formatting (also avoiding tabs).
authorWerner Lemberg <wl@gnu.org>
Fri, 9 Feb 2007 10:00:04 +0000 (11:00 +0100)
committerWerner Lemberg <wl@gnu.org>
Fri, 9 Feb 2007 10:00:04 +0000 (11:00 +0100)
18 files changed:
input/lsr/chords/Chord-name-exceptions.ly
input/lsr/chords/chord-name-major7.ly
input/lsr/connecting/Laissez-vibrer-ties.ly
input/lsr/contemporary/Clusters.ly
input/lsr/guitar/guitar-string-number.ly
input/lsr/parts/Rehearsal-mark-numbers.ly
input/lsr/parts/Tag-filter.ly
input/lsr/repeats/Volta-multi-staff.ly
input/lsr/spacing/Page-layout-twopass.ly
input/lsr/spacing/Page-spacing.ly
input/lsr/spacing/Proportional-spacing.ly
input/lsr/spacing/Proportional-strict-grace-notes.ly
input/lsr/spacing/Proportional-strict-notespacing.ly
input/lsr/spacing/alignment-vertical-spacing.ly
input/lsr/staff/Staff-line-positions.ly
input/lsr/text/font-family-override.ly
input/lsr/vocal/Ambitus.ly
input/lsr/vocal/lyric-combine.ly

index b8f25b877910ba44c51543431fe71cfb0309cee4..855214e5c7d28d1846fe3abdc0fdf426f4f16dbb 100644 (file)
@@ -1,27 +1,30 @@
 \version "2.10.12"
 
 \header { texidoc = "
-The property @{chordNameExceptions@} can used to store a list of special notations for specific chords.
+The property @code{chordNameExceptions} can used to store a list of special
+notations for specific chords.
 " }
 
 % 7sus4 denoted with ^7 wahh
-chExceptionMusic =  {
-    <c f g bes>1-\markup { \super "7" "wahh" }}
+chExceptionMusic = {
+  <c f g bes>1-\markup { \super "7" "wahh" }
+}
 
-                               % add to existing exceptions.
+% add to existing exceptions.
 chExceptions = #(append
-                (sequential-music-to-chord-exceptions chExceptionMusic #t)
-                ignatzekExceptions)
+  (sequential-music-to-chord-exceptions chExceptionMusic #t)
+  ignatzekExceptions)
 
 theMusic = \chordmode {
-    c:7sus4 c:dim7/+f
-    \set chordNameExceptions = #chExceptions
-    c:7sus4 c:dim7/+f
+  c:7sus4 c:dim7/+f
+  \set chordNameExceptions = #chExceptions
+  c:7sus4 c:dim7/+f
 }
 
-\layout { ragged-right = ##t }
+\layout {
+  ragged-right = ##t
+}
 
 << \context ChordNames \theMusic
    \context Voice \theMusic
 >>  
-
index 4c8785a6388af6285e5bbb0f76835329b561c131..9c670722de67c3a4350419bf2a919a9fa307fc26 100644 (file)
@@ -1,11 +1,11 @@
 \version "2.10.12"
 
 \header { texidoc = "
-The layout of the major 7 can be tuned with @{majorSevenSymbol@}
+The layout of the major 7 can be tuned with @code{majorSevenSymbol}.
 " }
 
 \chords {
-    c:7+
-    \set majorSevenSymbol = \markup { "j7" }
-    c:7+
+  c:7+
+  \set majorSevenSymbol = \markup { "j7" }
+  c:7+
 }
index a589c6e8fe982c57a699e0fc7bca9ccccc2e7cd6..71ce663edc6283108c6462b25aa3eb8221ecb14e 100644 (file)
@@ -1,8 +1,9 @@
 \version "2.10.12"
 
 \header { texidoc = "
-l.v. ties should avoid dots and staff lines, similar to normal ties.  They have fixed size. Their formatting can be tuned with
-@code{tie-configuration}
+l.v.@: ties should avoid dots and staff lines, similar to normal ties.  They
+have fixed size.  Their formatting can be tuned with
+@code{tie-configuration}.
 " }
 
 \paper {
@@ -17,10 +18,9 @@ l.v. ties should avoid dots and staff lines, similar to normal ties.  They have
 
   <c d e f>4\laissezVibrer r
   \override LaissezVibrerTieColumn #'tie-configuration
-  = #'((-7 . -1)
-       (-5 . -1)
-       (-3 . 1)
-       (-1 . 1))
+    = #'((-7 . -1)
+         (-5 . -1)
+         (-3 . 1)
+         (-1 . 1))
   <c d e f>4\laissezVibrer r
 }
-
index ea45a8c05941f24c91ae5b430199bb833c7cf34d..c14108650ec6e381f683aaeda83fb1b64ce8c1ad 100644 (file)
@@ -1,10 +1,13 @@
 \version "2.10.12"
 
 \header { texidoc = "
-Clusters are a device to denote that a complete range of notes is to be played.
+Clusters are a device to denote that a complete range of notes is to be
+played.
 " }
 
-\layout { ragged-right = ##t }
+\layout {
+  ragged-right = ##t
+}
 
 fragment = \relative c' {
   c4 f4 <e d'>4
index 85d9e6b191778a85034822c9432422efd6723255..f93e07eeec464f59dfd7e1c4049939ca72451047 100644 (file)
@@ -1,7 +1,8 @@
 \version "2.10.12"
 
 \header { texidoc = "
-String numbers can be added to chords. They use the same positioning mechanism as finger instructions.
+String numbers can be added to chords.  They use the same positioning
+mechanism as finger instructions.
 " }
 
 \paper {
index 74d2cfeede9c4918a0b9a532f23c3d33f3e055fd..096c80f7e7fbe09cc5a9b2634a2b48b1f1f0106f 100644 (file)
@@ -1,11 +1,14 @@
 \version "2.10.12"
 
 \header { texidoc = "
-Marks can be printed as numbers.  
-By setting @{markFormatter@} we may choose a different style of mark printing. Also, marks can be specified manually, with a markup argument.
+Marks can be printed as numbers.  By setting @code{markFormatter} we may
+choose a different style of mark printing.  Also, marks can be specified
+manually, with a markup argument.
 " }
 
-\paper { ragged-right = ##t } 
+\paper {
+  ragged-right = ##t
+ }
 
 \relative c''{
   \set Score.markFormatter = #format-mark-numbers 
@@ -13,11 +16,11 @@ By setting @{markFormatter@} we may choose a different style of mark printing. A
   c1 | \mark \default
   c1 | \mark \default
   \set Score.markFormatter
-  = #(lambda (mark  context)
-      (make-box-markup (format-mark-numbers mark context)))
+    = #(lambda (mark  context)
+        (make-box-markup (format-mark-numbers mark context)))
   c1 | \mark \default
   \set Score.markFormatter
-  = #(lambda (mark  context)
-      (make-circle-markup (format-mark-numbers mark context)))
+    = #(lambda (mark  context)
+        (make-circle-markup (format-mark-numbers mark context)))
   c1 | \mark \default
 }
index 28491f5ccd5a70c24fc43ac6fa3e3c841973a0e1..ad30b205420616b8ec3c799486d162f2c705db3b 100644 (file)
@@ -1,14 +1,19 @@
 \version "2.10.12"
 
 \header { texidoc = "
-The @{\tag@} command marks music expressions with a name. These tagged expressions can be filtered out later. This mechanism can be used to make different versions of the same music. In this example, the top stave displays the music expression with all tags included. The bottom two staves are filtered: the part has cue notes and fingerings, but the score has not.
+The @code{\tag} command marks music expressions with a name.  These tagged
+expressions can be filtered out later.  This mechanism can be used to make
+different versions of the same music.  In this example, the top stave
+displays the music expression with all tags included.  The bottom two staves
+are filtered: the part has cue notes and fingerings, but the score has not.
 " }
 
-\layout { ragged-right= ##t }
+\layout {
+  ragged-right= ##t
+}
 
 common =
-\relative c''  {
-
+\relative c'' {
   c1
   \relative c' <<
     \tag #'part <<
@@ -23,7 +28,6 @@ common =
 }
 
 
-
 \simultaneous { 
   \new Staff {
     \set Staff.instrumentName = #"both"
@@ -38,5 +42,3 @@ common =
     \keepWithTag #'score \common
   }
 }
-
-
index 3ad1ca9a2758d828e266408f741a1070dfe0c318..bd26d4d44a14c7ae5ccf2f9eb48cd9459f35cf37 100644 (file)
@@ -1,11 +1,17 @@
 \version "2.10.12"
 
 \header { texidoc = "
-By setting voltaOnThisStaff, repeats can be put also over other staves than the topmost one in a score.
+By setting @code{voltaOnThisStaff}, repeats can be put also over other
+staves than the topmost one in a score.
 " }
 
-\layout { ragged-right = ##t }
-vmus =  { \repeat volta 2 c1 \alternative { d e } } 
+\layout {
+  ragged-right = ##t
+}
+
+vmus = {
+  \repeat volta 2 c1 \alternative { d e }
+}
 
 \relative c'' <<
   \new StaffGroup <<
index 2812a66c19c11385abff977d5a102ff986e9bc09..7ef15b42a3727e571ee7a47a1f907edd2677f8a9 100644 (file)
@@ -1,14 +1,15 @@
 \version "2.10.12"
 
 \header { texidoc = "
-Page breaking details can be stored for later reference.
-
-(you should run this snippet on your own computer; we cannot compute the two-pass layout here)
+Page breaking details can be stored for later reference.  (You should run
+this snippet on your own computer; we cannot compute the two-pass layout
+here.)
 " }
 
 \paper  {
   #(define write-page-layout #t)
 }
+
 bla = \new Staff {
   c1 c1
   \break
@@ -31,4 +32,3 @@ tweakFileName = #(format "~a-page-layout.ly" (ly:parser-output-name parser))
 #(newline)
 
 #(ly:progress "Contents of: '~a'" (ly:gulp-file tweakFileName))
-
index dc6a941c08b54617ef2414104b3c91e1601b0d90..84ed1293228524e3690a2944679907c0002fdbd2 100644 (file)
@@ -1,11 +1,14 @@
 \version "2.10.12"
 
 \header { texidoc = "
-By setting properties in NonMusicalPaperColumn, vertical spacing of page layout can be adjusted.
+By setting properties in @code{NonMusicalPaperColumn}, vertical spacing of
+page layout can be adjusted.
 
-For technical reasons, overrideProperty has to be used for setting properties on individual object. \override may still be used for global overrides.
+For technical reasons, @code{\overrideProperty} has to be used for setting
+properties on individual objects.  @code{\override} may still be used for
+global overrides.
 
-By setting annotate-spacing, we can see the effect of each property.
+By setting @code{annotate-spacing}, we can see the effect of each property.
 " }
 
 #(set-global-staff-size 11)
@@ -13,51 +16,58 @@ By setting annotate-spacing, we can see the effect of each property.
 \book {
   \score {
     \relative c'' \new PianoStaff <<
-      \new Voice  {
-       c1_"followed by default spacing"\break
-       c\break
+      \new Voice {
+        c1_"followed by default spacing"
+        \break
 
-       \overrideProperty
-       #"Score.NonMusicalPaperColumn"
-       #'line-break-system-details
-       #'((Y-extent . (-30 . 10)))
-       c_"Big bounding box (property Y-extent)"\break
+        c
+        \break
 
-       \overrideProperty
-       #"Score.NonMusicalPaperColumn"
-       #'line-break-system-details
-       #'((refpoint-Y-extent . (-37 . -10)))
-       c_\markup {
-         \column {
-           "Refpoints further apart (property refpoint-Y-extent)."
-           "Stretchable space runs between refpoints"
-         }
-       }
-       
-       \break
-       
-       \overrideProperty
-       #"Score.NonMusicalPaperColumn"
-       #'line-break-system-details
-       #'((next-padding . 10))
+        \overrideProperty
+          #"Score.NonMusicalPaperColumn"
+          #'line-break-system-details
+          #'((Y-extent . (-30 . 10)))
+        c_"Big bounding box (property Y-extent)"
+        \break
 
-       c_"Followed by padding, ie unstretchable space. (property next-padding)" \break
-       \overrideProperty
-       #"Score.NonMusicalPaperColumn"
-       #'line-break-system-details
-       #'((next-space . 20))
-       c_"Followed by stretchable space (property next-space)"\break
-       c\break
-       \overrideProperty
-       #"Score.NonMusicalPaperColumn" #'line-break-system-details
-       #'((bottom-space . 25.0)) 
-       c_"25 staff space to the bottom of the page. (property bottom-space)"\break
+        \overrideProperty
+          #"Score.NonMusicalPaperColumn"
+          #'line-break-system-details
+          #'((refpoint-Y-extent . (-37 . -10)))
+        c_\markup {
+          \column {
+            "Refpoints further apart (property refpoint-Y-extent)."
+            "Stretchable space runs between refpoints" } }
+        \break
 
+        \overrideProperty
+          #"Score.NonMusicalPaperColumn"
+          #'line-break-system-details
+          #'((next-padding . 10))
+        c_"Followed by padding, ie unstretchable space (property next-padding)."
+        \break
 
+        \overrideProperty
+          #"Score.NonMusicalPaperColumn"
+          #'line-break-system-details
+          #'((next-space . 20))
+        c_"Followed by stretchable space (property next-space)"
+        \break
+
+        c
+        \break
+
+        \overrideProperty
+          #"Score.NonMusicalPaperColumn"
+          #'line-break-system-details
+          #'((bottom-space . 25.0))
+        c_"25 staff space to the bottom of the page (property bottom-space)."
+        \break
       }
       { c1 c c c c c c c }
     >>
   }
+
   \paper {
     ragged-last-bottom = ##f
     annotate-spacing = ##t
@@ -65,9 +75,6 @@ By setting annotate-spacing, we can see the effect of each property.
     #(set! text-font-defaults
       (acons
        'font-size 6
-       text-font-defaults)
-      
-    )
+       text-font-defaults))
   }
 }
-
index 7b3c1b39aa966ee05da6f21de9c70f8a2c335a68..5915234e091c9133d763cec3edcc54291d08593f 100644 (file)
@@ -1,15 +1,18 @@
 \version "2.10.12"
 
 \header { texidoc = "
-Proportional notation can be created by setting proportionalNotationDuration. Notes will be spaced proportional to the distance for the given duration.
+Proportional notation can be created by setting
+@code{proportionalNotationDuration}.  Notes will be spaced proportional to
+the distance for the given duration.
 " }
 
-\paper { ragged-right = ##t }
+\paper {
+  ragged-right = ##t
+}
 
 \relative c''
 <<
   \set Score.proportionalNotationDuration = #(ly:make-moment 1 16)
-  \new Staff { c8[ c c c c c]  c4 c2 r2 }
-  \new Staff { c2  \times 2/3 { c8 c c } c4 c1 }
+  \new Staff { c8[ c c c c c] c4 c2 r2 }
+  \new Staff { c2 \times 2/3 { c8 c c } c4 c1 }
 >>
-
index a0fc0859253909913883eecaafbb8b958814edf4..6488e4ae29c0858403fc43d1466d353174e2c3e9 100644 (file)
@@ -1,7 +1,8 @@
 \version "2.10.12"
 
 \header { texidoc = "
-With strict-note-spacing spacing for grace notes (even multiple ones), is floating as well.
+With @code{strict-note-spacing} spacing for grace notes (even multiple
+ones) is floating as well.
 " }
 
 \paper {
index 39b65433990c6d16f88537e332cd1bfbef005014..ecd362ce8255a7a6e96f26e04f6e2fa23af63cd3 100644 (file)
@@ -1,13 +1,17 @@
 \version "2.10.12"
 
 \header { texidoc = "
-If strict-note-spacing is set, then spacing of notes is not influenced by bars and clefs half-way on the system.  Rather, they are put just before the note that occurs at the same time.  This may cause collisions.
+If @code{strict-note-spacing} is set, then spacing of notes is not
+influenced by bars and clefs half-way on the system.  Rather, they are put
+just before the note that occurs at the same time.  This may cause
+collisions.
 " }
 
 \paper {
   ragged-right = ##t
   indent = 0
 }
+
 \layout {
   \context {
     \Score
index 78e276fab0700ad1cb915eb2d04d3fb16fe6aca0..053cef0b5f93c78cf3b8e31ddd5c2510addc9b17 100644 (file)
@@ -1,11 +1,16 @@
 \version "2.10.12"
 
 \header { texidoc = "
-By setting properties in NonMusicalPaperColumn, vertical spacing of alignments can be adjusted per system.
+By setting properties in @code{NonMusicalPaperColumn}, vertical spacing of
+alignments can be adjusted per system.
 
-By setting alignment-extra-space or fixed-alignment-extra-space an individual system may be stretched vertically.
+By setting @code{alignment-extra-space} or
+@code{fixed-alignment-extra-space} an individual system may be stretched
+vertically.
 
-For technical reasons, overrideProperty has to be used for setting properties on individual object. override in a \context block may still be used for global overrides
+For technical reasons, @code{\overrideProperty} has to be used for setting
+properties on individual objects.  Override in a @code{\context} block may
+still be used for global overrides.
 " }
 
 #(set-global-staff-size 13)
@@ -14,9 +19,14 @@ For technical reasons, overrideProperty has to be used for setting properties on
 \new StaffGroup <<
   \new Staff {
     c1\break 
-    c\break c\break
+    c\break
+    c\break
   }
-  \new Staff { c1 c c }
+
+  \new Staff {
+    c1 c c
+  }
+
   \new PianoStaff <<
     \new Voice  {
       \set PianoStaff.instrumentName = #"piano"
@@ -24,19 +34,17 @@ For technical reasons, overrideProperty has to be used for setting properties on
       c1_"normal"
       
       \overrideProperty
-      #"Score.NonMusicalPaperColumn"
-      #'line-break-system-details
-      #'((fixed-alignment-extra-space . 15))
+        #"Score.NonMusicalPaperColumn"
+        #'line-break-system-details
+        #'((fixed-alignment-extra-space . 15))
       c_"fixed-aligment-extra-space"
 
       \overrideProperty
-      #"Score.NonMusicalPaperColumn"
-      #'line-break-system-details
-      #'((alignment-extra-space . 15))
+        #"Score.NonMusicalPaperColumn"
+        #'line-break-system-details
+        #'((alignment-extra-space . 15))
       c_"aligment-extra-space"
     }
     { c1 c c }
   >>
 >>
-
-
index 8321da0d2dea353eca311835e63079e52921d1cf..ec83d19281e3d737639b10cb179205bbf16fd2de 100644 (file)
@@ -1,10 +1,11 @@
 \version "2.10.12"
 
 \header { texidoc = "
-The vertical positions of staff lines may be specified individually, by setting the line-positions property of the StaffSymbol.
+The vertical positions of staff lines may be specified individually, by
+setting the @code{line-positions} property of the @code{StaffSymbol}.
 " }
 
-\new Staff \relative c'  {
+\new Staff \relative c' {
   \override Staff.StaffSymbol #'line-positions = #'(-7 -2 0 3 9)
   g c f b e a
 }
index 49fdc4f304f1a68b4e1ba9797fc3ec8441dedf20..1e42227a25bdd711851eaf7cb0d6e117600de539 100644 (file)
@@ -1,29 +1,33 @@
 \version "2.10.12"
 
 \header { texidoc = "
-The default font families for text can be overridden with make-pango-font-tree
+The default font families for text can be overridden with
+@code{make-pango-font-tree}.
 " }
 
-\paper  {
+\paper {
   % change for other default global staff size. 
   myStaffSize = #20
+
   %{
-  run
-      lilypond -dshow-available-fonts blabla
-  to show all fonts available in the process log.  
-    %}
+     run
+       lilypond -dshow-available-fonts blabla
+     to show all fonts available in the process log.  
+  %}
 
-    #(define fonts
+  #(define fonts
     (make-pango-font-tree "Times New Roman"
                           "Nimbus Sans"
                           "Luxi Mono"
-;;     "Helvetica"
-;;     "Courier"
+;;                        "Helvetica"
+;;                        "Courier"
      (/ myStaffSize 20)))
 }
 
 \relative {
-  c'^\markup { roman: foo \bold bla \italic bar \italic \bold baz }
+  c'^\markup {
+    roman: foo \bold bla \italic bar \italic \bold baz
+  }
   c'_\markup {
     \override #'(font-family . sans)
     {
@@ -37,4 +41,3 @@ The default font families for text can be overridden with make-pango-font-tree
     }
   }
 }  
-
index 05ac9c78b5137fbc8ac4b5c4746ea8e361a6b25d..315a5fabb6364c660b644338d77f22297248b45f 100644 (file)
@@ -3,24 +3,27 @@
 \header { texidoc = "
 Ambituses indicate pitch ranges for voices.
 
-Accidentals only show up if they're not part of key signature.  AmbitusNoteHead grobs also have ledger lines.
+Accidentals only show up if they are not part of key signature. 
+@code{AmbitusNoteHead} grobs also have ledger lines.
 " }
 
 \layout {
-    ragged-right = ##t
-    \context {
-       \Voice
-       \consists Ambitus_engraver
-    }
+  ragged-right = ##t
+  \context {
+    \Voice
+    \consists Ambitus_engraver
+  }
 }
 
 \relative
 <<
-    \new Staff {  \time  2/4 c4 f' }
-    \new Staff \relative {
-       \time  2/4
-       \key d \major
-       cis as'
-    }
->>
+  \new Staff {
+    \time  2/4 c4 f'
+  }
 
+  \new Staff \relative {
+    \time  2/4
+    \key d \major
+    cis as'
+  }
+>>
index da4b076499a9ca6093c549a58fa3944b966ed608..a678de9072ca03f145c11e8421ff3c2c5cad1a8f 100644 (file)
@@ -1,7 +1,9 @@
 \version "2.10.12"
 
 \header { texidoc = "
-With the \lyricsto mechanism, individual lyric lines can be associated with one melody line. For each lyric line, they can be tuned whether to follow melismata or not.
+With the @code{\lyricsto} mechanism, individual lyric lines can be
+associated with one melody line.  For each lyric line, they can be tuned
+whether to follow melismata or not.
 " }
 
 <<
@@ -9,8 +11,12 @@ With the \lyricsto mechanism, individual lyric lines can be associated with one
     \autoBeamOff
     c2( d4) e8[ c b c] f4
   }
-  \lyricsto "bla"  \new Lyrics  { bla ab blob blob }
-  \lyricsto "bla"  \new Lyrics  {
+
+  \lyricsto "bla" \new Lyrics {
+    bla ab blob blob
+  }
+
+  \lyricsto "bla" \new Lyrics {
     bla 
 
     \set ignoreMelismata = ##t
@@ -24,9 +30,7 @@ With the \lyricsto mechanism, individual lyric lines can be associated with one
     blob
   }
   
-  \lyricsto "bla"  \new Lyrics  {
+  \lyricsto "bla" \new Lyrics {
     nes ted lyrics voice with more words than no tes
   }
 >>
-  
-