[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: doc enhancement for \headers
From: |
-Eluze |
Subject: |
Re: doc enhancement for \headers |
Date: |
Thu, 5 Jul 2012 11:16:52 -0700 (PDT) |
Graham Percival-3 wrote:
>
> On Thu, Jul 05, 2012 at 08:05:16AM -0700, -Eluze wrote:
>> is it asking too much to add a full list or table of all the \header
>> variables supported by default!?
>
> Isn't that done in "Default layout of book and score title blocks"
> ? A working example is much more informative than a list or
> table.
>
yes and no - the list/table gives you an overview and singular items can be
illustrated with examples (first a little bit of theory and then get
practical…)
>> this would save users a lot of time
>> searching for an example/snippet where all of them are shown (actually
>> this
>> is the 3rd example in
>> http://www.lilypond.org/doc/v2.15/Documentation/notation/creating-titles-headers-and-footers#title-blocks-explained
>> 3.2.1 Creating titles headers and footers . it is not mentioned that all
>> variables are listed.
>
> ok, that's fair. So a sentence should be added to the top of that
> subsection, saying "This example demonstrates all \header
> variables" ? That sounds like a good idea.
>
exactly
>> and here is how this could look like:
>>
>> +++ (right after Title blocks explained or after the Note)
>>
>> there are 13 variables that can be defined in the \header block and which
>> will be used by the default header and footnote engraver:
>
> The problem with such a list is that it's easy to forget to update it…
>
certainly, but a documentation is only worthwhile if it shows the actual
state - I think LilyPond does a great effort to keep documentations
up-to-date and if there's a problem with it this should be attacked from
another starting point.
>> instrument*
>> piece**
>> opus**
>>
>> * the instrument will be repeated on every page.
>> ** these are printed in a \score when the paper variable
>> print-all-headers
>> is set to ##f (default)
>
> Good points! It would be nice if that example were extended to
> use multiple peices (to show off piece and opus), and had multiple
> pages (to show instrument).
>
>
I'll try to enlarge the third example
thanks for your feedback!
Eluze
--
View this message in context:
http://old.nabble.com/doc-enhancement-for-%5Cheaders-tp34118295p34119442.html
Sent from the Gnu - Lilypond - Bugs mailing list archive at Nabble.com.
Re: doc enhancement for \headers, Mark Mathias, 2012/07/07