Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code | Sign in
(306)

Issue 4445070: Doc: Adjusted CG Policy on @lilypond[] variables (Closed)

Can't Edit
Can't Publish+Mail
Start Review
Created:
8 years ago by pkx166h
Modified:
8 years ago
CC:
lilypond-devel_gnu.org
Visibility:
Public.

Description

Doc: Adjusted CG Policy on @lilypond[] variables As a reuslt of work on NR 3.2 Titles and Headers, it was necessary to define some more explicit requirements for using the variables in the @lilypond[ ... ] construct. Ssuch as removing staffsize and page sizes within the actual @lilypond example which only add more noise to the examples. Also when the need to show taglines and/or page breaks and footers is required then \book is needed in the example and this will result in unnecessary white space between top and bottom of the page. So showing page breaking features or numbering examples becomes problematic within the documentation. The new @lilypond[papersize=X] variable allows for explicit page sizing without the need to include it in the example itself. Allowing for better clarity. The papersize=X takes variables from the scm/paper.scm else 'a4' is presumed. Moved existing material to the front of this section so that it makes more sense and added the new requirements for the various preferred variables.

Patch Set 1 #

Total comments: 11

Patch Set 2 : Second Draft #

Total comments: 7

Patch Set 3 : another draft with corrections #

Total comments: 1
Unified diffs Side-by-side diffs Delta from patch set Stats (+82 lines, -46 lines) Patch
M Documentation/contributor/doc-work.itexi View 1 2 2 chunks +82 lines, -46 lines 1 comment Download

Messages

Total messages: 10
Graham Percival (old account)
Looks pretty good. http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi File Documentation/contributor/doc-work.itexi (right): http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi#newcode314 Documentation/contributor/doc-work.itexi:314: inlcude the @code{papersize=X} variable, where @code{X} ...
8 years ago (2011-04-27 16:39:04 UTC) #1
Trevor Daniels
A couple of nitpicks; otherwise looks fine. http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi File Documentation/contributor/doc-work.itexi (right): http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi#newcode323 Documentation/contributor/doc-work.itexi:323: and/or single ...
8 years ago (2011-04-27 22:46:32 UTC) #2
Graham Percival (old account)
http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi File Documentation/contributor/doc-work.itexi (right): http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi#newcode323 Documentation/contributor/doc-work.itexi:323: and/or single @code{tagline}. On 2011/04/27 22:46:32, Trevor Daniels wrote: ...
8 years ago (2011-04-28 11:43:05 UTC) #3
pkx166h
http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi File Documentation/contributor/doc-work.itexi (right): http://codereview.appspot.com/4445070/diff/1/Documentation/contributor/doc-work.itexi#newcode314 Documentation/contributor/doc-work.itexi:314: inlcude the @code{papersize=X} variable, where @code{X} is an defined ...
8 years ago (2011-04-28 13:06:22 UTC) #4
Graham Percival (old account)
LGTM. I still want to see the examples of quote, but if those change anything, ...
8 years ago (2011-04-28 13:15:25 UTC) #5
Trevor Daniels
A few more nitpicks; otherwise looks fine. [I'm not convinced adding colons before @examples is ...
8 years ago (2011-04-28 22:40:39 UTC) #6
pkx166h
Third draft includes new change from c9landscape to a8landscape - this requires an approval of ...
8 years ago (2011-05-02 16:22:39 UTC) #7
t.daniels_treda.co.uk
<pkx166h@gmail.com> wrote Monday, May 02, 2011 5:22 PM > http://codereview.appspot.com/4445070/diff/4001/Documentation/contributor/doc-work.itexi#newcode314 > Documentation/contributor/doc-work.itexi:314: inlcude the > ...
8 years ago (2011-05-02 17:32:53 UTC) #8
Graham Percival (old account)
LGTM
8 years ago (2011-05-02 18:15:41 UTC) #9
Graham Percival (old account)
8 years ago (2011-05-03 12:36:24 UTC) #10
http://codereview.appspot.com/4445070/diff/5/Documentation/contributor/doc-wo...
File Documentation/contributor/doc-work.itexi (right):

http://codereview.appspot.com/4445070/diff/5/Documentation/contributor/doc-wo...
Documentation/contributor/doc-work.itexi:325:
@lilypond[papersize=a8landscape,verbatim]
this is a .itexi, not a .itely, so you can't use @lilypond.

Change that whole example to a
@example
(and escape all { symbols).

Remember that you can do a quick test of the basic "will it compile" by doing
  touch Documentation/*.te??
  make
Sign in to reply to this message.

Powered by Google App Engine
RSS Feeds Recent Issues | This issue
This is Rietveld f62528b