lilypond-devel
[Top][All Lists]
Advanced

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

Re: @uref doc policy


From: Graham Percival
Subject: Re: @uref doc policy
Date: Thu, 15 Apr 2010 00:30:17 +0100
User-agent: Mutt/1.5.18 (2008-05-17)

On Wed, Apr 14, 2010 at 03:42:27PM -0700, Mark Polesky wrote:
> James Lowe wrote:
> > address@hidden
> > +@@example
> > +@@address@hidden [, link text address@hidden
> > +@@end example
> > address@hidden example
> >  @end itemize
> 
> Is this a new doc policy?

Umm.  Kind-of.

> I seem to have missed the discussion.  Anyway, I think that
> surrounding @urefs with @examples would disrupt the flow of
> the text in many cases, for example here:
> http://lilypond.org/doc/v2.13/Documentation/web/productions

Umm.

How about "if it is important to let people follow the link, put
it inside an @example" ?  The idea is to make sure that people who
print the PDFs can see stuff.  If it's not too much bother.

Hey, maybe that's a better phrasing: "if it's not too much bother,
put @uref inside @example" ?


Basically, I like the way the
http://lilypond.org/website/help-us.html
and the top boxes of
http://lilypond.org/website/easier-editing.html
present the urls.  They're not obtrusive on a web-page, but
they'll be visible in info, pdf, printed materials, etc.

I have mixed feelings about
http://lilypond.org/website/contact.html
in that I'm very happy about the irc link, I'm happy with the
condensed (but not visible) links to the archives/gmane, and I
don't care about the translation groups.
OTOH, I'm not fond of the "subscriber+info" links, and somebody
should change the link to the lilypond Report ASAP.
(news.lilynet.net looks like a nice official website, so this both
adds more credence to the report, and makes it visible in all
formats)

Cheers,
- Graham




reply via email to

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