[Zope] documentation bugs

Cees de Groot cg@cdegroot.com
Tue, 13 Jul 1999 21:16:56 +0200


michel@digicool.com said:
> My requirements are that it must be an open format, preferably some
> subset of SGML, absolutly must run on Linux, and would be nice if it
> were cross platform enough to run on Windows (but not an immediate
> requirement).

Use DocBook, it's a DTD specifically setup with software documentation in 
mind. People will be able to give you direct patches on the SGML sources, 
while internally you can use any of a number of tools to edit and publish the 
SGML (Emacs, SGMLtools, ArborText tools, with a little bit of hacking 
Frame+SGML, WordPerfect, ...). Many open source projects are moving to this 
format, so even where author experience isn't very high at the moment, it'll 
get better with time. Moving to other formats later on isn't very hard 
(DocBook itself will probably be used by many people as DocBk - the XML 
variant, for example).

http://www.docbook.org/
http://www.sgmltools.org/
http://www.oasis-open.org/cover/

should get you started :-)
-- 
Cees de Groot               http://www.cdegroot.com     <cg@cdegroot.com>
                            http://www.sgmltools.org   <cg@sgmltools.org>