Re: [hpoj-devel] updated SCAN-HOWTO documentation

[Joe P. <joe...@sn...>]

On Wednesday 23 May 2001 09:13 pm, PASCHAL,DAVID (HP-Roseville,ex1) wrote:
<...>
> Looking longer term, I would still like to further reorganize the
> documentation for 0.8.  I'm considering changing the format from plain text
> to HTML, to make it easier to hyperlink between different parts of the
> documentation for the sake of walking users through basic installation and
> linking to more detailed information about each command.  Since I expect
> everybody has an HTML viewer on their system these days, this shouldn't be
> a big problem, but I would be interested to hear what other people think. 
> I probably will keep the HTML pretty light-weight just in case anybody
> needs to look at it in plain-text modes (and also due to my poor HTML
> skills:-). I may or may not provide Unix manual pages for the various
> commands in addition to HTML versions.  In any case, the documentation will
> still be provided with the package as well as on the web, for both the
> released and CVS versions, so web access will still be optional for reading
> the documentation.

Reformatting the documentation in HTML is a good idea, IMO. It would be much 
more readable. If you use only the basic HTML tags, you probably won't lock 
any users out.

man pages could be useful as a quick reference. If you decide to supply them, 
they would not need to be very detailed.

-- 
Joe