convert-ly the user manual

diff --git a/ChangeLog b/ChangeLog
index 2e409e3ef641abc6844b47706df81d88b182f0d4..e7817fe766f2ba4de43c87344120fb3821ae44a3 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2006-08-10  Joe Neeman  <joeneeman@gmail.com>
+
+       * Documentation/user: convert-ly the user manual
+
 2006-08-09  Han-Wen Nienhuys  <hanwen@lilypond.org>
 
        * stepmake/aclocal.m4: version check patch (thanks MWD)

diff --git a/Documentation/user/README.txt b/Documentation/user/README.txt
index 37a44c4d0ab06f668121c0c3a25f133d208af278..ba2f98793ac3cb7068cdb767c7d8dd2d505cc4d8 100644 (file)
--- a/Documentation/user/README.txt
+++ b/Documentation/user/README.txt
@@ -1,7 +1,7 @@
 Info for Documentation
 ----------------------
 
-Current version of the manual: 2.8.0
+Current version of the manual: 2.9.13
 *** Please update this whenever you run convert-ly on the docs.
 
 convert-ly --from=... --to=... --no-version *.itely

diff --git a/Documentation/user/advanced-notation.itely b/Documentation/user/advanced-notation.itely
index 8974df682487fb40863bce936a846602625b4be6..5231745bfe049034d1f9c6e359fc54226055b576 100644 (file)
--- a/Documentation/user/advanced-notation.itely
+++ b/Documentation/user/advanced-notation.itely
@@ -291,7 +291,7 @@ but it can also be used anywhere text is called in lilypond
       #'break-visibility = #begin-of-line-invisible
     \override Score.RehearsalMark #'self-alignment-X = #right
 
-    \set Staff.instrument = \markup{ \column{ Alto solo } }
+    \set Staff.instrumentName = \markup{ \column{ Alto solo } }
     c2^\markup{ don't be \flat }
     \override TextSpanner #'edge-text = #(cons (markup #:italic "rit" ) "")
     b2\startTextSpan
@@ -981,8 +981,8 @@ the start of the staff.  For the first staff, @code{instrument} is
 used, for the following ones, @code{instr} is used.
 
 @lilypond[quote,verbatim,ragged-right,relative=1,fragment]
-\set Staff.instrument = "Ploink "
-\set Staff.instr = "Plk "
+\set Staff.instrumentName = "Ploink "
+\set Staff.shortInstrumentName = "Plk "
 c1
 \break
 c''
@@ -992,7 +992,7 @@ You can also use markup texts to construct more complicated instrument
 names, for example
 
 @lilypond[quote,fragment,verbatim,ragged-right]
-\set Staff.instrument = \markup {
+\set Staff.instrumentName = \markup {
   \column { "Clarinetti"
             \line { "in B" \smaller \flat } } }
 c''1
@@ -1003,13 +1003,13 @@ If you wish to center the instrument names, you must center all of them
 @lilypond[quote,verbatim,ragged-right]
 { <<
 \new Staff {
-  \set Staff.instrument = \markup {
+  \set Staff.instrumentName = \markup {
     \center-align { "Clarinetti"
       \line { "in B" \smaller \flat } } }
   c''1
 }
 \new Staff {
-  \set Staff.instrument = \markup{ \center-align { Vibraphone }}
+  \set Staff.instrumentName = \markup{ \center-align { Vibraphone }}
   c''1
 }
 >>
@@ -1025,13 +1025,11 @@ To center instrument names while leaving extra space to the right,
 \new StaffGroup \relative
 <<
   \new Staff {
-    \set Staff.instrument
-    = \markup { \hcenter-in #10 "blabla" }
+    \set Staff.instrumentName = \markup { \hcenter-in #10 "blabla" }
     c1 c1
   }
   \new Staff {
-    \set Staff.instrument
-    = \markup { \hcenter-in #10 "blo" }
+    \set Staff.instrumentName = \markup { \hcenter-in #10 "blo" }
     c1 c1
   }
 >>
@@ -2278,7 +2276,7 @@ deliberate nonsense.
 @lilypond[quote,ragged-right,verbatim]
 {
   \override Staff.StaffSymbol #'color = #(x11-color 'SlateBlue2)
-  \set Staff.instrument = \markup {
+  \set Staff.instrumentName = \markup {
     \with-color #(x11-color 'navy) "Clarinet"
   }
   \time 2/4

diff --git a/Documentation/user/examples.itely b/Documentation/user/examples.itely
index 9bb3dede2af22e9ff3bc89035c8a1f3962271d54..f20895cad6f961408920a02e7c7952d2cb58d53f 100644 (file)
--- a/Documentation/user/examples.itely
+++ b/Documentation/user/examples.itely
@@ -27,7 +27,7 @@ instrument or a melodic fragment.  Cut and paste this into a file,
 add notes, and you're finished!
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' {
    \clef treble
    \key c \major
@@ -52,7 +52,7 @@ automatic beaming, you'll have to change or comment out the relevant
 line.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' {
    \clef treble
    \key c \major
@@ -83,7 +83,7 @@ text = \lyricmode {
 Want to prepare a lead sheet with a melody and chords?  Look no further!
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' {
    \clef treble
    \key c \major
@@ -116,7 +116,7 @@ harmonies = \chordmode {
 This template allows you to prepare a song with melody, words, and chords.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' {
    \clef treble
    \key c \major
@@ -157,7 +157,7 @@ harmonies = \chordmode {
 Here is a simple piano staff.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 upper = \relative c'' {
    \clef treble
    \key c \major
@@ -176,7 +176,7 @@ lower = \relative c {
 
 \score {
    \new PianoStaff <<
-      \set PianoStaff.instrument = "Piano  "
+      \set PianoStaff.instrumentName = "Piano  "
       \new Staff = "upper" \upper
       \new Staff = "lower" \lower
    >>
@@ -191,7 +191,7 @@ Here is a typical song format: one staff with the melody and lyrics, with
 piano accompaniment underneath.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c'' {
    \clef treble
    \key c \major
@@ -247,7 +247,7 @@ Instead of having a full staff for the melody and lyrics, you can place
 the lyrics between the piano staff (and omit the separate melody staff).
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 upper = \relative c'' {
    \clef treble
    \key c \major
@@ -294,7 +294,7 @@ since the template is right here, you don't have to do the
 tweaking yourself.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 upper = \relative c'' {
   \clef treble
   \key c \major
@@ -391,7 +391,7 @@ This template demonstrates a string quartet.  It also uses a @code{\global}
 section for time and key signatures.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 
 global= {
   \time 4/4
@@ -399,26 +399,26 @@ global= {
 }
 
 violinOne = \new Voice { \relative c''{
-  \set Staff.instrument = "Violin 1 "
+  \set Staff.instrumentName = "Violin 1 "
 
   c2 d e1
 
 \bar "|." }}
 violinTwo = \new Voice { \relative c''{
-  \set Staff.instrument = "Violin 2 "
+  \set Staff.instrumentName = "Violin 2 "
 
   g2 f e1
 
 \bar "|." }}
 viola = \new Voice { \relative c' {
-  \set Staff.instrument = "Viola "
+  \set Staff.instrumentName = "Viola "
   \clef alto
 
   e2 d c1
 
 \bar "|." }}
 cello = \new Voice { \relative c' {
-  \set Staff.instrument = "Cello     "
+  \set Staff.instrumentName = "Cello     "
   \clef bass
 
   c2 b a1
@@ -451,7 +451,7 @@ contains all the music definitions.  The other files -- @code{score.ly},
 
 @verbatim
 %%%%% piece.ly
-\version "2.7.39"
+\version "2.9.13"
 
 global= {
   \time 4/4
@@ -459,26 +459,26 @@ global= {
 }
 
 Violinone = \new Voice { \relative c''{
-  \set Staff.instrument = "Violin 1 "
+  \set Staff.instrumentName = "Violin 1 "
 
   c2 d e1
 
 \bar "|." }}   %*********************************
 Violintwo = \new Voice { \relative c''{
-  \set Staff.instrument = "Violin 2 "
+  \set Staff.instrumentName = "Violin 2 "
 
   g2 f e1
 
 \bar "|." }}   %*********************************
 Viola = \new Voice { \relative c' {
-  \set Staff.instrument = "Viola "
+  \set Staff.instrumentName = "Viola "
   \clef alto
 
   e2 d c1
 
 \bar "|." }}   %*********************************
 Cello = \new Voice { \relative c' {
-  \set Staff.instrument = "Cello     "
+  \set Staff.instrumentName = "Cello     "
   \clef bass
 
   c2 b a1
@@ -497,7 +497,7 @@ music = {
 
 
 %%%%% score.ly
-\version "2.7.39"
+\version "2.9.13"
 \include "piece.ly"
 #(set-global-staff-size 14)
 \score {
@@ -508,7 +508,7 @@ music = {
 
 
 %%%%% vn1.ly
-\version "2.7.39"
+\version "2.9.13"
 \include "piece.ly"
 \score {
   \keepWithTag #'vn1 \music
@@ -517,7 +517,7 @@ music = {
 
 
 %%%%% vn2.ly
-\version "2.7.39"
+\version "2.9.13"
 \include "piece.ly"
 \score {
   \keepWithTag #'vn2 \music
@@ -526,7 +526,7 @@ music = {
 
 
 %%%%% vla.ly
-\version "2.7.39"
+\version "2.9.13"
 \include "piece.ly"
 \score {
   \keepWithTag #'vla \music
@@ -535,7 +535,7 @@ music = {
 
 
 %%%%% vlc.ly
-\version "2.7.39"
+\version "2.9.13"
 \include "piece.ly"
 \score {
   \keepWithTag #'vlc \music
@@ -555,7 +555,7 @@ parts.  For example, the time signature and key signatures are almost
 always the same for all parts.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 global = {
    \key c \major
    \time 4/4
@@ -636,7 +636,7 @@ to the vocal notes (say, tenorMusic), then the changes will also
 apply to the piano reduction.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 global = {
    \key c \major
    \time 4/4
@@ -739,7 +739,7 @@ notes.  As a compromise, bar lines are often printed between the
 staves rather than on the staves.
 
 @lilypond[quote,verbatim,line-width=11.0\cm]
-\version "2.7.39"
+\version "2.9.13"
 
 global = {
   \set Score.skipBars = ##t
@@ -789,7 +789,7 @@ global = {
 
 discantusNotes = {
   \transpose c' c'' {
-    \set Staff.instrument = "Discantus  "
+    \set Staff.instrumentName = "Discantus  "
 
     % incipit
     \clef "neomensural-c1"
@@ -825,7 +825,7 @@ discantusLyrics = \lyricmode {
 
 altusNotes = {
   \transpose c' c'' {
-    \set Staff.instrument = "Altus  "
+    \set Staff.instrumentName = "Altus  "
 
     % incipit
     \clef "neomensural-c3"
@@ -859,7 +859,7 @@ altusLyrics = \lyricmode {
 
 tenorNotes = {
   \transpose c' c' {
-    \set Staff.instrument = "Tenor  "
+    \set Staff.instrumentName = "Tenor  "
 
     % incipit
     \clef "neomensural-c4"
@@ -893,7 +893,7 @@ tenorLyrics = \lyricmode {
 
 bassusNotes = {
   \transpose c' c' {
-    \set Staff.instrument = "Bassus  "
+    \set Staff.instrumentName = "Bassus  "
 
     % incipit
     \clef "bass"
@@ -965,7 +965,7 @@ quarter noteheads, and special marks, indicating rests of different length.
 
 @lilypond[quote,verbatim,ragged-right]
 \include "gregorian-init.ly"
-\version "2.8.0"
+\version "2.9.13"
 
 chant = \relative c' {
   \set Score.timing = ##f
@@ -1025,7 +1025,7 @@ is within a @code{\transpose} section.
 @c The `line-width' argument is for the \header.
 
 @lilypond[quote,verbatim,ragged-right,line-width]
-\version "2.7.39"
+\version "2.9.13"
 \header {
   title = "Song"
   subtitle = "(tune)"
@@ -1083,7 +1083,7 @@ trpharmony = \transpose c' d {
 }
 trumpet = {
   \global
-  \set Staff.instrument = #"Trumpet"
+  \set Staff.instrumentName = #"Trumpet"
   \clef treble
   <<
     \trpt
@@ -1100,7 +1100,7 @@ altoharmony = \transpose c' a {
 }
 altosax = {
   \global
-  \set Staff.instrument = #"Alto Sax"
+  \set Staff.instrumentName = #"Alto Sax"
   \clef treble
   <<
     \alto
@@ -1117,7 +1117,7 @@ bariharmony = \transpose c' a \chordmode {
 }
 barisax = {
   \global
-  \set Staff.instrument = #"Bari Sax"
+  \set Staff.instrumentName = #"Bari Sax"
   \clef treble
   <<
     \bari
@@ -1134,7 +1134,7 @@ tboneharmony = \chordmode {
 }
 trombone = {
   \global
-  \set Staff.instrument = #"Trombone"
+  \set Staff.instrumentName = #"Trombone"
   \clef bass
   <<
     \tbone
@@ -1154,7 +1154,7 @@ gtrharmony = \chordmode {
 }
 guitar = {
   \global
-  \set Staff.instrument = #"Guitar"
+  \set Staff.instrumentName = #"Guitar"
   \clef treble
   <<
     \gtr
@@ -1205,7 +1205,7 @@ PianoLH = {
 
 piano = {
   <<
-    \set PianoStaff.instrument = #"Piano"
+    \set PianoStaff.instrumentName = #"Piano"
     \new Staff = "upper" \PianoRH
     \new Staff = "lower" \PianoLH
   >>
@@ -1218,7 +1218,7 @@ Bass = \relative c {
 }
 bass = {
   \global
-  \set Staff.instrument = #"Bass"
+  \set Staff.instrumentName = #"Bass"
   \clef bass
   <<
     \Bass
@@ -1240,7 +1240,7 @@ down = \drummode {
 drumContents = {
   \global
   <<
-    \set DrumStaff.instrument = #"Drums"
+    \set DrumStaff.instrumentName = #"Drums"
     \new DrumVoice { \voiceOne \up }
     \new DrumVoice { \voiceTwo \down }
   >>
@@ -1301,7 +1301,7 @@ violin concerto as TchaikovskyPI, whereas perhaps you wish to print
 
 @ The `line-width' is for \header.
 @li lypond[quote,verbatim,ragged-right,line-width]
-\version "2.7.39"
+\version "2.9.13"
 \header {
   dedication = "dedication"
   title = "Title"

diff --git a/Documentation/user/global.itely b/Documentation/user/global.itely
index bf8a5fdaafa61f5569061dffa680071f525ea0d9..9d2de24691400f2af39ebd6f6f444e30e96f92e1 100644 (file)
--- a/Documentation/user/global.itely
+++ b/Documentation/user/global.itely
@@ -42,7 +42,7 @@ these files end with ``@code{.ly}''.
 A basic example of a lilypond input file is
 
 @example
-\version "2.8.0"
+\version "2.9.13"
 \score @{
   @{ @}     % this is a single music expression;
             % all the music goes in here.

diff --git a/Documentation/user/instrument-notation.itely b/Documentation/user/instrument-notation.itely
index b6f89f7e6128aa2b7a7700d53f4bfa70f8826143..c365125bef629db1e7de7a694e87c5967de09f69 100644 (file)
--- a/Documentation/user/instrument-notation.itely
+++ b/Documentation/user/instrument-notation.itely
@@ -1444,7 +1444,7 @@ its fleece was white as snow.
 
 Names of singers can also be added.  They are printed at the start of
 the line, just like instrument names.  They are created by setting
-@code{vocalName}.  A short version may be entered as @code{vocNam}.
+@code{vocalName}.  A short version may be entered as @code{shortVocalName}.
 
 
 @lilypond[fragment,ragged-right,quote,verbatim,relative=2]

diff --git a/Documentation/user/invoking.itely b/Documentation/user/invoking.itely
index 20d211471362963b99eb024196c0beeda298d2f8..1701b04fcbeab15cca604dac96d461c7a0491188 100644 (file)
--- a/Documentation/user/invoking.itely
+++ b/Documentation/user/invoking.itely
@@ -565,7 +565,7 @@ following example, the accidental touches the note head.
 
 Using Mac OSX 10.3.7, lilypond 2.7.32
 
-\version "2.7.32"
+\version "2.9.13"
 \layout { ragged-right = ##t }
 \relative c'' {
    a4 b cis d

diff --git a/Documentation/user/putting.itely b/Documentation/user/putting.itely
index 6bd126a44cd175fdd0e3feab2d4c7dcade7f59dc..88aac44959cd41ae1cb0155bd3630ae92e48e5ec 100644 (file)
--- a/Documentation/user/putting.itely
+++ b/Documentation/user/putting.itely
@@ -26,7 +26,7 @@ cello.  In this case, we would start with ``Notes and lyrics'' (for the
 soprano part).
 
 @example
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' @{
   \clef treble
   \key c \major
@@ -55,7 +55,7 @@ text = \lyricmode @{
 Now we want to add a cello part.  Let's look at the ``Notes only'' example:
 
 @example
-\version "2.7.39"
+\version "2.9.13"
 melody = \relative c' @{
   \clef treble
   \key c \major
@@ -91,7 +91,7 @@ normally use bass clef.  We'll also give the cello some different
 notes.
 
 @example
-\version "2.7.39"
+\version "2.9.13"
 sopranoMusic = \relative c' @{
   \clef treble
   \key c \major
@@ -161,7 +161,7 @@ This looks a bit messy; the indentation is messed up now.  That is
 easily fixed.  Here's the complete soprano and cello template.
 
 @lilypond[quote,verbatim,ragged-right]
-\version "2.7.39"
+\version "2.9.13"
 sopranoMusic = \relative c' {
   \clef treble
   \key c \major

diff --git a/Documentation/user/tutorial.itely b/Documentation/user/tutorial.itely
index 08d9416e9c20d1d71bc6c4be4620d2e3332348fd..796705ec5149f7e08b299d82c36f8a27ac9b2e1a 100644 (file)
--- a/Documentation/user/tutorial.itely
+++ b/Documentation/user/tutorial.itely
@@ -928,7 +928,7 @@ statement marks for which version of LilyPond the file was written.
 To mark a file for version 2.6.0, use
 
 @example
-\version "2.6.0"
+\version "2.9.13"
 @end example
 
 @noindent

diff --git a/Documentation/user/working.itely b/Documentation/user/working.itely
index 1d1841f56376d9e172b821ce9b674d75e270af05..2872272a9f09c7341d70129e976dd0e41669ee5b 100644 (file)
--- a/Documentation/user/working.itely
+++ b/Documentation/user/working.itely
@@ -61,7 +61,7 @@ problems:
 
 @itemize @bullet
 @item @strong{Include @code{\version} numbers in every file}.  Note that all
-templates contain a @code{\version "2.8.0"} string.  We
+templates contain a @code{\version "2.9.13"} string.  We
 highly recommend that you always include the @code{\version}, no matter
 how small your file is.  Speaking from personal experience, it's
 quite frustrating to try to remember which version of LilyPond you were
@@ -525,7 +525,7 @@ file with @code{\include "../global.ly"}, which contains
 
 @example
 %%%   global.ly
-\version "2.8.0"
+\version "2.9.13"
 #(ly:set-option 'point-and-click #f)
 \include "../init/init-defs.ly"
 \include "../init/init-layout.ly"