Re: [OctDev] Re: Nonlinear optimization tutorial

[Rafael L. <lab...@mp...>]

* Paul Kienzle <pki...@ja...> [2002-03-19 12:25]:

> For the documentation we distribute we need to use a format that is
> available to the user.  html and pdf are obvious candidates here, and I see
> that most everyone will be able to view MathML with a bit of effort
> (http://www.w3.org/Math/implementations.html).  Initially I'll use html
> because it is easiest, but MathML seems like the direction we should go.

DocBook may be a better choice than HTML for documentation.  Indeed, DocBook
is intended for writing software documentation, having tags like <funcdef>,
<parameter>, <variablelist>, etc.  See the Element Reference chapter of the
DocBook Book at http://www.docbook.org.

As an example of what DocBook can do, lokk at the documentation of the
PLplot package, which has been converted (by me and others) into the DocBook
format:

    http://plplot.sourceforge.net/resources/docbook-manual/

In particular, see the API section in

    http://plplot.sf.net/resources/docbook-manual/plplotdoc-html-0.4.3/api.html

-- 
Rafael