Re: Documentation for stanza numbers /Sietse

[Graham Percival]

Sietse Brouwer wrote:
> [A]
> In the last line of topic one, "just before the start of first
> syllable." is missing a "the". It should read "just before the start
> of the first syllable."

Done.

> [B]
> I recommend swapping topic 2 and topic 3, since 3 and 4 are about
> similar issues: about printing stanzas at the end, and about printing
> stanzas at the end in columns next to each other.

Done.

> [C] I also hereby submit a paragraph + code describing how to put a
> dynamics marks in front of the stanza. I recommend putting it after
> topic 1, as both deal with \set stanza.

Done.

> I would have liked to explain why \set stanza must take place outside
> \lyricmode: unfortunately, I don't know myself. All I know is that you
> get the error message "Unexpected LYRIC_MARKUP". If you have an
> explanation, I think it would be good to add it.

I have no clue, sorry.  (see below)

> [D] Finally, I would add a "Bugs" section after the "See also"
> section, saying the following:
>
> --start--
> Bugs
> When the stanza number becomes too wide, it just writes over whatever
> is to its left.
> --end--

The "bugs" section is intended more for long-term design decisions.  In 
this case, that collision is a small bug that will hopefully be fixed 
within the next year or two.

Basically, if a bug is in the tracker, it doesn't go in the docs.  If a 
bug in the tracker is too big to handle (i.e. long-term design issues), 
then we remove it from the tracker and add it to the docs.


> Two more questions:
> Firstly, do you think we should put the topics above into their own
> subsections: 7.3.9.1 - 7.3.9.5?

Done.  I like splitting things into subsections.

> Secondly: in my opinion, topic 5 (printing stanzas at the end in
> multiple colums) is more of a template than it describes new
> techniques. Perhaps it should be moved to the template appendix under
> section D.4 "Vocal Ensembles". What do you all think?

Although I'm the doc editor, I never use vocal music.  One of the 
reasons I structured the docs this way (chapters 6, 7, and 8) is that I 
have no clue how stuff in chapter 7 works.  I play string instruments, I 
write for string instruments, and that's it.  :)

When it comes to stuff in chapter 7, I really just take direction from 
intelligent, interested users.  You qualify, so give me directions.  :)

I think the example in topic 5 should be changed a little before making 
it a template, but it would probably only take you five minutes.

Cheers,
- Graham