lilypond-devel
[Top][All Lists]
Advanced

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

Re: GDP: consistency in @q @qq @samp @code


From: Werner LEMBERG
Subject: Re: GDP: consistency in @q @qq @samp @code
Date: Tue, 09 Oct 2007 07:42:15 +0200 (CEST)

> I'd like to have some consistent usage amongst these terms.  Here's
> my proposal:
> 
> @code{}: actual lilypond code or property/context names.
> 
> @qq{}: only for actual quotes -- ie "he said" or "she wrote".
> 
> @samp{}: refers to pieces of notation, such as: @samp{crescendo} is
> often abbreviated as @samp{cresc.}.
> 
> @q{}: used for `vague' terms in English (and other natural
> languages).
> 
> 
> Does this make sense?  If we agree on these, I'll add them to the
> doc policy.

Sounds fine.  Actually, I've always tried to clean up the code
accordingly.  However, sometimes it's better IMHO to use @samp instead
of @code for single letters identifiers or such to increase
readability.


    Werner




reply via email to

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