Re: [Firebird-docs] Changes to docset structure

[Robert J M. <rj...@ar...>]

Paul Vinkenoog wrote:

>Hi all,
>
>The first docs from the manual module will soon be published (in HTML)
>on the project website. To make them look as good as possible, I've
>prepared some changes to the docset structure and the stylesheets.
>None of the changes have been committed yet. I'll list them here;
>please respond if you have any objections, or ideas for further
>enhancements:
>
>- Until now the auto-generated HTML file names look like this:
>  bk01ch01.html, bk02ch01s08.html, etc. Very uninformative, but for
>  online browsing it's not disastrous. It IS disastrous however when
>  the docs are committed - with these names - to the 'web' CVS module.
>  
>
I'm not against the change of names, but either way, the HTML should not 
be commited to CVS. The latest version (and possibly the last stable 
version) should definately be published on the web, and probably 
available to download as a tarball / zip file etc, but if you put it in 
the CVS, people will be tempted to edit it there. This would be bad. 
There's also the issue of keeping the CVS html in sync with the CVS 
docbook, which is a really silly issue, but it's bound to cause some 
problems. An editor may have a docbook XML viewing / editing program, 
but not have the ability to build the HTML if they don't have Java 
installed, for example.

Robert Munro