lilypond-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Documentation suggestions.


From: Michael Käppler
Subject: Re: Documentation suggestions.
Date: Wed, 5 Feb 2020 14:08:55 +0100
User-agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:68.0) Gecko/20100101 Thunderbird/68.4.2

Hello Peter,


Am 04.02.2020 um 10:44 schrieb Peter Toye:
I'm posting this here, as no-one on the devel list has answered, although most 
of the discussion went on in that list.
I think that many developers spend their effort on core topics like the
guile-2/3 transition,
or improving the contribution process, etc. at the moment.
I prepared a patch, mostly following your suggestions. Now every
developer can discuss your suggestions
during the formal code review procedure.

The review is here:
http://codereview.appspot.com/579280043

The tracker issue is:
https://sourceforge.net/p/testlilyissues/issues/5738/
LM 1.2.1 Simple notation. Add a paragraph after the 1st music example:

        Note-names in all examples use the English or Dutch naming system 
(white piano keys are C-B).
As Kieren pointed out it cannot be the English system (at least if
alterations come into play),
I think it is sufficient to mention the Dutch system.
LM 2.1.2 Pitches and key signatures. Subsection Pitch alterations. 3rd paragraph
        (1)after 'alterations' add 'and note-names'.
        (2) append:

                The default language for note-names and alterations is 
nederlands (Dutch).

A question: is "alterations" a good word throughout this subsection? The normal English 
one is "accidentals", which is used in the Music Glossary reference.
IMHO, alteration applys to the underlying process of "altering" a note,
which is part of the input,
"accidental" is the graphical sign that does show the alteration, hence
rather part of the rendering.
--------------------------------------------
NR 3.1.5 File Structure. Subsection Using variables. Add  a "Known Issues"  
subsection at end:


        In addition to the normal convention for variable names [add reference 
to LM 2.4.1] variable names can include non-ASCII characters and non-adjacent 
single underscores and dashes. Any combination of characters is allowed if the 
variable name is enclosed in double quotation marks. In this case backslashes 
and double quotation marks need to be escaped with backslashes.
-------------------------------------------
NR 1.2.5  Bars. Sub section Bar and bar number checks. Add a "known issues" 
section at end:

        If MIDI output is selected and volta repeats are in place, the bar 
number check may fail. It is best to suppress MIDI output while checking bar 
numbers.
----------------------------------------------
NR 3.3.2 Different editions from one source. Subsection Using tags. Add before paragraph 
3 ("The arguments..."):

        \tag, \keepWithTag and \removeWithTag are music functions which take a 
music expression as their second argument. Thus they cannot be used to filter 
items such as  \book or \score blocks.
----------------------------------------------
NR 3.2.1 Creating titles headers and footers. Subsection Default layout of 
headers and footers. Rename to:

        Default layout of page headers and footers

and index it as "page headers", "page footers", "headers, page", "footers, 
page".
Possibly also promote it to a 3rd-level section? It doesn't have anything in 
common with the previous two subsections.
Added the indices, but left the title because changing it would have
involved checking and fixing many crossreferences in other
sections / manuals / translations.

Regards and thanks for your work,
Michael

===8<===========End of original message text===========
_______________________________________________
bug-lilypond mailing list
address@hidden
https://lists.gnu.org/mailman/listinfo/bug-lilypond




reply via email to

[Prev in Thread] Current Thread [Next in Thread]