bug-lilypond
[Top][All Lists]
Advanced

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

Re: documentation-files / lilypond-homepage


From: John Mandereau
Subject: Re: documentation-files / lilypond-homepage
Date: Mon, 29 Sep 2008 21:12:41 +0200

Hello Werner,
Sorry for the late reply.
On 2008/08/30 07:56 +0000, Werner wrote: 
> I think it would be good, to give the documentation-files names including the
> version like
> lilypond-2.11.57.pdf or lilypond.de-2.10.33.pdf ...
> But there would be the problem, that the links inside the documents would have
> to be updated too. Also it would be confusing, if there was a newer version, 
> but
> a file wasn't changed.

This would be very cumbersome to do this on the developers' side,
whereas you can easily store several versions of the documentation in
2.y.z directories on your side.


> So it would be better at
> http://lilypond.org/doc/v2.11/Documentation/ [index.html]
> to give not only the version and date as it is at the top of the page, but 
> also
> the date of the last change for every single document (I think not every file 
> is
> changed with every new version (?)).

The documentation files are generated from text source files, so it's
difficult to isolate changes for each splitted HTML page (is that what
you mean with "every single document"?); however, it would be very cool
for users to have a documentation change log, which would list which
sections in the docs changed between releases... we could write an
automated script to do this, but this is not easy to do right now (on
the techincal side, we must be able to play with parsed Texinfo
documents, using texi2html parser is an option to investigate).


> On
> http://lilypond.org/doc/v2.11/Documentation/index.html
> there is given a hint about the possibility to download the complete docu as
> tarball from http://lilypond.org/web/install/
> This hint could be given at the top of
> http://lilypond.org/doc/v2.10/Documentation/
>
> http://lilypond.org/doc/v2.11/Documentation/
> too.

2.10 is no longer maintained, but as many people have requested this
link, it will appear (maybe) in 2.11.61 and (surely) 2.12.0.


> I'm not shure, what causes more traffic: one big download or the everyday-use 
> of
> the online-manuals.

It depends on how you use the documentation, I guess there is no general
rule.


> But I don't know, if windows-users can use the tar.bz-file.

Sure they can.  Our documentation tarball gradually grows and is quite
big these days, so switching from Bzip2 to Zip is not an option IMHO.

Cheers,
John





reply via email to

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