Documentation Format (was Re: Help wanted: more qualified develo pers)

[Kelly Campbell <ca...@channelpoint.com>]

What's wrong with Stylebook? Personally, I prefer Docbook. It's well
documented, used for many other documentation projects, and has alot of
resources going for it. But we've already got most of the websites in
stylebook, so I'm just wondering if it makes sense to do things two
different ways? I know stylebook is more web-oriented, but we shouldn't have
to maintain duplicate sets of documents just to have a printable version.

If we do standardize on Docbook, I don't think we need to define a small
subset. As I said before, Docbook is well documented (thanks Norm), and has
a standard set of stylesheets which support most of the structures (thanks
again Norm). If you are a newcomer to Docbook, I would suggest using Norm's
simplified dtd (perhaps this is the subset you are wanting Andy?) But I
don't think we should rule out using the full power of it when neccessary. 

Links:
www.docbook.org
www.nwalsh.com


-Kelly

> -----Original Message-----
> From: Andy Clark [mailto:andyc@apache.org]
> Sent: Thursday, April 05, 2001 4:30 PM
> To: general@xml.apache.org
> Subject: Re: Help wanted: more qualified developers
> 
> 
> Arved Sandstrom wrote:
> > DocBook. If much or most of the XML Apache docs were to be 
> DocBook, then
> 
> I think it would be a good idea to use a standard document
> grammar like DocBook. However, DocBook is rather large so
> we should use a defined subset that is expressive enough
> for our purposes.
> 
> -- 
> Andy Clark * IBM, TRL - Japan * andyc@apache.org
> 
> ---------------------------------------------------------------------
> In case of troubles, e-mail:     webmaster@xml.apache.org
> To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
> For additional commands, e-mail: general-help@xml.apache.org
> 

---------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
For additional commands, e-mail: general-help@xml.apache.org

Re: Documentation Format (was Re: Help wanted: more qualified developers)

[Martin Stricker <sh...@gmx.de>]

Kelly Campbell wrote:
> 
> What's wrong with Stylebook? Personally, I prefer Docbook. It's well
> documented, used for many other documentation projects, and has alot
> of resources going for it. But we've already got most of the websites
> in stylebook, so I'm just wondering if it makes sense to do things two
> different ways? I know stylebook is more web-oriented, but we
> shouldn't have to maintain duplicate sets of documents just to have a
> printable version.

You can easily print web pages. Most browsers even have a print button.
;-))

Please keep the documentation format as simple as possible! I want to be
able to read it on a linux console (text only, no graphical user
interface).

BTW: The higher the learning curve for writing xml.apache.org
documentation is the lower is the chance I'll write some...

Best regards,
Martin Stricker

-- 
Homepage: http://www.martin-stricker.de/
Star Trek Rollenspiel: http://www.uss-republic.de/
Webmaster-Forum: http://www.masterportal24.com/cgi-bin/YaBB.cgi
Registered Linux user #210635: http://counter.li.org/

---------------------------------------------------------------------
In case of troubles, e-mail:     webmaster@xml.apache.org
To unsubscribe, e-mail:          general-unsubscribe@xml.apache.org
For additional commands, e-mail: general-help@xml.apache.org