[Top][All Lists]

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

Re: Adds incipit section to NR (issue 108270043 address@hidden)

From: Phil Holmes
Subject: Re: Adds incipit section to NR (issue 108270043 address@hidden)
Date: Sun, 29 Jun 2014 21:41:19 +0100

----- Original Message ----- From: <address@hidden>
To: <address@hidden>; <address@hidden>; <address@hidden>
Cc: <address@hidden>; <address@hidden>
Sent: Sunday, June 29, 2014 6:55 PM
Subject: Re: Adds incipit section to NR (issue 108270043 address@hidden)

On 2014/06/29 16:51:06, wrote:

You seem to have missed the point.  Snippets are not judged by the
code, but by the ability of the writer to include them into the
documentation.  I did not need to do this as a snippet, so I didn't.

Not so.  Please read Section 5.5.1 of the CG.  It says there:

"Most tweaks should be added to LSR and not placed directly in the
'.itely' file.
In some cases, tweaks may be placed in the main text, but ask about this

By tweaks it means tweaks or overrides of any sort.

Admittedly there are sections of the manual which were written before
guidelines were approved which do not follow them, and the sections on
Music are such, but that's no reason for ignoring them now when entering
documentation.  What you have prepared is clearly better than "TBC", but
code parts should be added via the LSR using @lilypondfile[...] as is
done in
the earlier sections of the NR.


I appreciate your comments, but I really don't see why it is better to add overrides in the LSR. To the user, they both appear in the manual as equal relations. Unless they are "Selected snippets" (and remember, I'm replacing a main part of the NR which had "TBC" with something that works, rather than adding anything new) there's no actual difference in the published version of the manual with text written directly into the manual as opposed to that included from the LSR, except that if it's added to the manual as I did it now, then it will appear without an LSR import, whereas adding it to the LSR, tagging it as docs, importing it, and then sorting out the other issues with the import (which I do have on my list to do) is a complete pain.

I think I'll just delete the section so no-one thinks we can make incipits.

Phil Holmes

reply via email to

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