From ab972ac40dedb63a1d0da045e12391411cce0e28 Mon Sep 17 00:00:00 2001 From: Werner Lemberg Date: Fri, 9 Feb 2007 11:00:04 +0100 Subject: [PATCH] Beautify texinfo doc strings. Some formatting (also avoiding tabs). --- input/lsr/chords/Chord-name-exceptions.ly | 25 ++--- input/lsr/chords/chord-name-major7.ly | 8 +- input/lsr/connecting/Laissez-vibrer-ties.ly | 14 +-- input/lsr/contemporary/Clusters.ly | 7 +- input/lsr/guitar/guitar-string-number.ly | 3 +- input/lsr/parts/Rehearsal-mark-numbers.ly | 17 ++-- input/lsr/parts/Tag-filter.ly | 16 ++-- input/lsr/repeats/Volta-multi-staff.ly | 12 ++- input/lsr/spacing/Page-layout-twopass.ly | 8 +- input/lsr/spacing/Page-spacing.ly | 93 ++++++++++--------- input/lsr/spacing/Proportional-spacing.ly | 13 ++- .../Proportional-strict-grace-notes.ly | 3 +- .../Proportional-strict-notespacing.ly | 6 +- .../lsr/spacing/alignment-vertical-spacing.ly | 34 ++++--- input/lsr/staff/Staff-line-positions.ly | 5 +- input/lsr/text/font-family-override.ly | 25 ++--- input/lsr/vocal/Ambitus.ly | 29 +++--- input/lsr/vocal/lyric-combine.ly | 16 ++-- 18 files changed, 193 insertions(+), 141 deletions(-) diff --git a/input/lsr/chords/Chord-name-exceptions.ly b/input/lsr/chords/Chord-name-exceptions.ly index b8f25b8779..855214e5c7 100644 --- a/input/lsr/chords/Chord-name-exceptions.ly +++ b/input/lsr/chords/Chord-name-exceptions.ly @@ -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 = { - 1-\markup { \super "7" "wahh" }} +chExceptionMusic = { + 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 >> - diff --git a/input/lsr/chords/chord-name-major7.ly b/input/lsr/chords/chord-name-major7.ly index 4c8785a638..9c670722de 100644 --- a/input/lsr/chords/chord-name-major7.ly +++ b/input/lsr/chords/chord-name-major7.ly @@ -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+ } diff --git a/input/lsr/connecting/Laissez-vibrer-ties.ly b/input/lsr/connecting/Laissez-vibrer-ties.ly index a589c6e8fe..71ce663edc 100644 --- a/input/lsr/connecting/Laissez-vibrer-ties.ly +++ b/input/lsr/connecting/Laissez-vibrer-ties.ly @@ -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 4\laissezVibrer r \override LaissezVibrerTieColumn #'tie-configuration - = #'((-7 . -1) - (-5 . -1) - (-3 . 1) - (-1 . 1)) + = #'((-7 . -1) + (-5 . -1) + (-3 . 1) + (-1 . 1)) 4\laissezVibrer r } - diff --git a/input/lsr/contemporary/Clusters.ly b/input/lsr/contemporary/Clusters.ly index ea45a8c059..c14108650e 100644 --- a/input/lsr/contemporary/Clusters.ly +++ b/input/lsr/contemporary/Clusters.ly @@ -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 4 diff --git a/input/lsr/guitar/guitar-string-number.ly b/input/lsr/guitar/guitar-string-number.ly index 85d9e6b191..f93e07eeec 100644 --- a/input/lsr/guitar/guitar-string-number.ly +++ b/input/lsr/guitar/guitar-string-number.ly @@ -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 { diff --git a/input/lsr/parts/Rehearsal-mark-numbers.ly b/input/lsr/parts/Rehearsal-mark-numbers.ly index 74d2cfeede..096c80f7e7 100644 --- a/input/lsr/parts/Rehearsal-mark-numbers.ly +++ b/input/lsr/parts/Rehearsal-mark-numbers.ly @@ -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 } diff --git a/input/lsr/parts/Tag-filter.ly b/input/lsr/parts/Tag-filter.ly index 28491f5ccd..ad30b20542 100644 --- a/input/lsr/parts/Tag-filter.ly +++ b/input/lsr/parts/Tag-filter.ly @@ -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 } } - - diff --git a/input/lsr/repeats/Volta-multi-staff.ly b/input/lsr/repeats/Volta-multi-staff.ly index 3ad1ca9a27..bd26d4d44a 100644 --- a/input/lsr/repeats/Volta-multi-staff.ly +++ b/input/lsr/repeats/Volta-multi-staff.ly @@ -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 << diff --git a/input/lsr/spacing/Page-layout-twopass.ly b/input/lsr/spacing/Page-layout-twopass.ly index 2812a66c19..7ef15b42a3 100644 --- a/input/lsr/spacing/Page-layout-twopass.ly +++ b/input/lsr/spacing/Page-layout-twopass.ly @@ -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)) - diff --git a/input/lsr/spacing/Page-spacing.ly b/input/lsr/spacing/Page-spacing.ly index dc6a941c08..84ed129322 100644 --- a/input/lsr/spacing/Page-spacing.ly +++ b/input/lsr/spacing/Page-spacing.ly @@ -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)) } } - diff --git a/input/lsr/spacing/Proportional-spacing.ly b/input/lsr/spacing/Proportional-spacing.ly index 7b3c1b39aa..5915234e09 100644 --- a/input/lsr/spacing/Proportional-spacing.ly +++ b/input/lsr/spacing/Proportional-spacing.ly @@ -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 } >> - diff --git a/input/lsr/spacing/Proportional-strict-grace-notes.ly b/input/lsr/spacing/Proportional-strict-grace-notes.ly index a0fc085925..6488e4ae29 100644 --- a/input/lsr/spacing/Proportional-strict-grace-notes.ly +++ b/input/lsr/spacing/Proportional-strict-grace-notes.ly @@ -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 { diff --git a/input/lsr/spacing/Proportional-strict-notespacing.ly b/input/lsr/spacing/Proportional-strict-notespacing.ly index 39b6543399..ecd362ce82 100644 --- a/input/lsr/spacing/Proportional-strict-notespacing.ly +++ b/input/lsr/spacing/Proportional-strict-notespacing.ly @@ -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 diff --git a/input/lsr/spacing/alignment-vertical-spacing.ly b/input/lsr/spacing/alignment-vertical-spacing.ly index 78e276fab0..053cef0b5f 100644 --- a/input/lsr/spacing/alignment-vertical-spacing.ly +++ b/input/lsr/spacing/alignment-vertical-spacing.ly @@ -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 } >> >> - - diff --git a/input/lsr/staff/Staff-line-positions.ly b/input/lsr/staff/Staff-line-positions.ly index 8321da0d2d..ec83d19281 100644 --- a/input/lsr/staff/Staff-line-positions.ly +++ b/input/lsr/staff/Staff-line-positions.ly @@ -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 } diff --git a/input/lsr/text/font-family-override.ly b/input/lsr/text/font-family-override.ly index 49fdc4f304..1e42227a25 100644 --- a/input/lsr/text/font-family-override.ly +++ b/input/lsr/text/font-family-override.ly @@ -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 } } } - diff --git a/input/lsr/vocal/Ambitus.ly b/input/lsr/vocal/Ambitus.ly index 05ac9c78b5..315a5fabb6 100644 --- a/input/lsr/vocal/Ambitus.ly +++ b/input/lsr/vocal/Ambitus.ly @@ -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' + } +>> diff --git a/input/lsr/vocal/lyric-combine.ly b/input/lsr/vocal/lyric-combine.ly index da4b076499..a678de9072 100644 --- a/input/lsr/vocal/lyric-combine.ly +++ b/input/lsr/vocal/lyric-combine.ly @@ -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 } >> - - -- 2.39.5