This is the mail archive of the
mailing list for the DocBook project.
Re: Using DocBook for a API documentation
- To: docbook at lists dot oasis-open dot org
- Subject: Re: DOCBOOK: Using DocBook for a API documentation
- From: Norman Walsh <ndw at nwalsh dot com>
- Date: Thu, 2 Dec 1999 11:17:37 -0500
- References: <38435EF0.B400A27B@flashcom.net> <firstname.lastname@example.org>
- Reply-To: docbook at lists dot oasis-open dot org
/ maarten de boer <email@example.com> was heard to say:
| What is not clear to me is how the overall structure
| of such a documentation should be. What would be the
| tags to:
| * group function in certain categories
| * follow every function by a descriptive paragraph
| * have "See also:" references
The structure you describe sounds like a typical "RefEntry".
These are called "man pages" in typical UNIX documentation.
Take a look and see if that fulfills your needs.
| * generate an index of all functions
This is a processing expectation. The documents themselves
are just the data, you can write tools (stylesheets, programs,
whatever you want to call them) to walk through your source
documents and produce indexes of this sort.
Norman Walsh <firstname.lastname@example.org> | I have seen the truth and it makes
http://www.oasis-open.org/docbook/ | no sense.
Member, DocBook Editorial Board |