bug-lilypond
[Top][All Lists]
Advanced

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

Re: Web/Docs: LilyPond version is not clear on docs web pages


From: James
Subject: Re: Web/Docs: LilyPond version is not clear on docs web pages
Date: Wed, 08 May 2013 18:57:40 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:17.0) Gecko/20130329 Thunderbird/17.0.5

On 08/05/13 17:57, Paul Morris wrote:
PROBLEM

In the docs on the web it is not obvious, especially to new users, which 
version of LilyPond any given page is for.  This is particularly a problem when 
landing on a doc page directly from a web search or link.

For example, a new user does a web search that takes them directly to an old 
docs page like this:
http://lilypond.org/doc/v2.14/Documentation/notation/writing-rhythms

The only clue they have that they are not looking at the current docs is the "2.14" in 
the URL (which they will probably not notice), and the tiny text "This page is for 
LilyPond-2.14.2 (stable-branch)." that is not visible until you scroll all the way down a long 
page.


SUGGESTION

A simple thing would be to put the version number of LilyPond somewhere at the top of every web 
page.  For example, it could go at the top of the left hand column.  Where it says "LilyPond - 
Notation Reference" it could say "LilyPond 2.14 - Notation Reference" instead.

To make it more obvious, you could have "LilyPond 2.14" in a larger font size on its own 
line, with "Notation Reference" on the next line.

Optionally, to take this a step further, a clear message could appear at the top of each 
page in older versions of the docs that says something like "NOTE: This 
documentation is *not* for the most recent version of LilyPond.  We recommend using the 
most recent version which is documented here."  With links to the current version of 
LilyPond and the docs.
_______________________________________________
bug-lilypond mailing list
address@hidden
https://lists.gnu.org/mailman/listinfo/bug-lilypond


The website is built automatically using texinfo/scripts.

See:

http://lilypond.org/doc/v2.17/Documentation/contributor-big-page.html#introduction-to-website-work

It isn't simply a case of someone editing some HTML code somewhere on a hosted page.

There are a number of bug reports about various aspects of the website

http://code.google.com/p/lilypond/issues/detail?id=2777

http://code.google.com/p/lilypond/issues/detail?id=3191

http://code.google.com/p/lilypond/issues/detail?id=1272

http://code.google.com/p/lilypond/issues/detail?id=3209

http://code.google.com/p/lilypond/issues/detail?id=2731

etc.

There are probably more but these are the open ones that I quickly found. I am sure this has been discussed and probably tracked elsewhere if not in one of these above.



--
Regards,

James



reply via email to

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