[EMAIL PROTECTED] wrote:
> 
> > > Any thoughts on converting the docs to DocBook (http://docbook.org)
> > > instead?  DocBook is an SGML flavor geared specifically for writing
> > > technical docs.
> 
> I really don't care about the format al long as it's:
> - idiot proof

Well, some would say the only way to make software idiot proof is to
take away the mouse and keyboard.  (c:  How idiot proof is "idiot
proof"?

> - possible to edit offline
> - it not takes more than a few minutes to understand how to use
> - it's a generally avaiable format
> - can be viewed on a web server too.

Well, it's SGML, just like HTML (well, technically, there's also an XML
DocBook flavor).  DocBook is a generic intermediate format which you
typically need to render to a viewable/printable format.  You do need a
working SGML installation and a handful of stylesheets to create the
other formats, but that's more of a developer-side issue.  This is sort
of analogous to needing autoconf to create a configure script, but not
to actually run it.  We could very easily create the HTML docs and check
them into CVS as well (or preferrably just put them in the distributable
tarballs).

Although I do believe that direct XML viewers are starting to appear
(e.g. Mozilla, GNOME) so that you can view DocBook directly, without the
rendering step.

> - possible  to do a simple commit to send changes (preferably direct cvs commit for 
>all developers)

This is more of an administration issue, and is orthogonal to the format
of the documentation.  Not sure whether it would be better to put it in
a separate CVS archive, or leave it in the main Wine distribution.

John

-- 
[EMAIL PROTECTED]                                http://www.gnome.org
[EMAIL PROTECTED]                      http://www.worldforge.org

Reply via email to