Doc -- Add info on \version statements to Tutorial

Doc -- Add info on \version statements to Tutorial

[Graham Percival (old account), 2009-12-22 15:14:01]

ok, given the support for this idea, I'm ok with in theory.  Comments below.

http://codereview.appspot.com/179121/diff/1002/3
File Documentation/learning/tutorial.itely (right):

http://codereview.appspot.com/179121/diff/1002/3#newcode51
Documentation/learning/tutorial.itely:51: 
Let's keep the separate @example, so that we can write
@example
\version "@version{}"
@{
...

http://codereview.appspot.com/179121/diff/1002/3#newcode66
Documentation/learning/tutorial.itely:66: 
This isn't important enough to have on this page; if we have too many warnings,
people will start ignoring them.

http://codereview.appspot.com/179121/diff/1002/3#newcode779
Documentation/learning/tutorial.itely:779: 
Separate @node @subsection, please.  The \version has nothing to do with
omitting braces.

Alternately, we could rename "omitting braces" to "omitted material".

http://codereview.appspot.com/179121/diff/1002/3#newcode855
Documentation/learning/tutorial.itely:855: 
Could we also get a paragraph about \version in 1.2.2?  Also, remove 2.4.2
entirely.

[Mark Polesky, 2009-12-22 15:57:03]

http://codereview.appspot.com/179121/diff/1002/3
File Documentation/learning/tutorial.itely (right):

http://codereview.appspot.com/179121/diff/1002/3#newcode51
Documentation/learning/tutorial.itely:51: 
but don't forget the @w{}:
\version @w{"@version{}"}

http://codereview.appspot.com/179121/diff/1002/3#newcode296
Documentation/learning/tutorial.itely:296: @example
Don't forget this instance here as well:
+ \version @w{@version{}}
+

http://codereview.appspot.com/179121/diff/1002/3#newcode315
Documentation/learning/tutorial.itely:315: lilypond test.ly
fix extraneous line break in pdf:
- GNU LilyPond @version{}
+ GNU LilyPond @w{@version{}}

[Mark Polesky, 2009-12-22 16:05:19]

http://codereview.appspot.com/179121/diff/1002/3
File Documentation/learning/tutorial.itely (right):

http://codereview.appspot.com/179121/diff/1002/3#newcode315
Documentation/learning/tutorial.itely:315: lilypond test.ly
Also, remove command input; and update output to reflect recent changes in the
stdout:

 @example
-lilypond test.ly
-GNU LilyPond @version{}
+GNU LilyPond @w{@version{}}
 Processing `test.ly'
 Parsing...
 Interpreting music...
 Preprocessing graphical objects...
-Finding the ideal number of pages...
-Fitting music on 1 page...
+Solving 1 page-breaking chunks...[1: 1 pages]
 Drawing systems...
 Layout output to `test.ps'...
-Converting to `test.pdf'...
+Converting to `./test.pdf'...
 @end example

[c_sorensen, 2009-12-22 22:00:13]

On 12/22/09 8:14 AM, "percival.music.ca@gmail.com"
<percival.music.ca@gmail.com> wrote:

> ok, given the support for this idea, I'm ok with in theory.  Comments
> below.
> 
> 
> http://codereview.appspot.com/179121/diff/1002/3
> File Documentation/learning/tutorial.itely (right):
> 
> http://codereview.appspot.com/179121/diff/1002/3#newcode51
> Documentation/learning/tutorial.itely:51:
> Let's keep the separate @example, so that we can write
> @example
> \version "@version{}"
> @{
> ...


Sounds great.  @version{} isn't listed in the CG.  I'll add it.

> 
> http://codereview.appspot.com/179121/diff/1002/3#newcode66
> Documentation/learning/tutorial.itely:66:
> This isn't important enough to have on this page; if we have too many
> warnings, people will start ignoring them.
> 

OK.


> http://codereview.appspot.com/179121/diff/1002/3#newcode779
> Documentation/learning/tutorial.itely:779:
> Separate @node @subsection, please.  The \version has nothing to do with
> omitting braces.
> 
> Alternately, we could rename "omitting braces" to "omitted material".

I thought about the separate subsection and decided it was too short.

I'll be happy to change the section name.


> 
> http://codereview.appspot.com/179121/diff/1002/3#newcode855
> Documentation/learning/tutorial.itely:855:
> Could we also get a paragraph about \version in 1.2.2?  Also, remove
> 2.4.2 entirely.
> 

Yes, I'll do that.

All the changes have been made.  A new version is pushed:

http://codereview.appspot.com/179121

[Graham Percival, 2009-12-23 00:51:30]

On Tue, Dec 22, 2009 at 02:57:26PM -0700, Carl Sorensen wrote:
> 
> All the changes have been made.  A new version is pushed:
> 
> http://codereview.appspot.com/179121

Looks fine; please push.

Cheers,
- Graham