Re: Doc: Added new option 'papersize' to Usage (issue4289057)

[pkx166h]

Reviewers: Graham Percival,

Message:
2nd Draft.

james


http://codereview.appspot.com/4289057/diff/1/Documentation/usage/lilypond-book.itely
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/4289057/diff/1/Documentation/usage/lilypond-book.itely#newcode607
Documentation/usage/lilypond-book.itely:607: @code{'landscape} can also
be used.
OK, I don't know if you were being sarcastic :) but after you asked me
that I had to go back and check as I wasn't 100% sure. I thought I could
put =a8'landscape or =a8landscape but no matter what I did (even two
paper sizes) I got an 'unknown papersize' message and lilypond-book
defaulted to A4. So I'll remove this comment from the patch as it
doesn't work.

http://codereview.appspot.com/4289057/diff/1/Documentation/usage/lilypond-book.itely#newcode613
Documentation/usage/lilypond-book.itely:613: If a @code{tagline} is
required, either default or custom, then the
Done. Moved it to 'Output' section with a simple @lilypond to show this.

Description:
Doc: Added new option 'papersize' to Usage

Added note on how to use @lilypond[papersize=xx] as defined
in scm/paper.scm

Please review this at http://codereview.appspot.com/4289057/

Affected files:
  M Documentation/usage/lilypond-book.itely


Index: Documentation/usage/lilypond-book.itely
diff --git a/Documentation/usage/lilypond-book.itely  
b/Documentation/usage/lilypond-book.itely
index  
d41d70ed07702db998566c549032bf4d8641cd9c..b0b97e91844ee4eac42fbaacbd5144c82b972e7f  
100644
--- a/Documentation/usage/lilypond-book.itely
+++ b/Documentation/usage/lilypond-book.itely
@@ -159,6 +159,20 @@ Larger examples can be put into a separate file, and  
introduced with

 @lilypondfile[quote,noindent]{screech-boink.ly}

+If a @code{tagline} is required, either default or custom, then the
+entire snippet must be enclosed in a @code{\book @{ @}} construct.
+
address@hidden,verbatim]
+\book{
+  \header{
+    title = "A scale in LilyPond"
+  }
+
+  \relative c' {
+    c d e f g a b c
+  }
+}
address@hidden lilypond

 @page

@@ -601,6 +615,14 @@ If no @code{line-width} option is given,  
@command{lilypond-book} tries to
 guess a default for @code{lilypond} environments which don't use the
 @code{ragged-right} option.

address@hidden address@hidden
+Where @var{string} is a paper size defined in @file{scm/paper.scm} i.e.
address@hidden, @code{quarto}, @code{11x17} etc.
+
+Values not defined in @file{scm/paper.scm} will be ignored, a warning
+will be posted and the snippet will be printed using the default
address@hidden size.
+
 @item notime
 Do not print the time signature, and turns off the timing (time signature,
 bar lines) in the score.