[Openmcl-devel] ccl manual (was Re: trace on recursive functions)

[Daniel Weinreb]

Liam,

One of the factors is choosing the right tool is whether
you need the kinds of advanced features needed for
doing "book design"-level customization, indexes, and
all that sort of thing used to make professional-level
manuals.

If you're doing something more modest, there's
a very nice tool that we use for design documents
and things like that, called "reStructured Text".

http://docutils.sourceforge.net/rst.html

It lets you write your document with an ordinary text
editor, and makes it look very plausible and easy-to-read
in that form.  You do section headings like this:



The Sequence Functions
================


and you can do tables with vertical bars and underscores,
etc, so that it looks like a table in ordinary fixed-width
characters.

Then there are programs to convert this to HTML or to LaTex,
and the LaTex can be converted to PDF.

-- Dan

Liam Healy wrote:
> Sorry to go a bit off-topic here, but I'm contemplating how to do
> documentation for projects of my own.  I too was put off by the
> complexity (and unfamiliarity) of docbook and its tools.  On the other
> hand, (La)TeX, though I'm very familiar with it, doesn't seem very
> oriented toward documentation and code.  Someone recommended texinfo
> to me; it is appealing in that it is made for documentation, is quite
> simple, and you can generate many different formats from it, including
> DocBook.   Has anyone tried it?  What are your experiences?
>
> Liam
> _______________________________________________
> Openmcl-devel mailing list
> Openmcl-devel at clozure.com
> http://clozure.com/mailman/listinfo/openmcl-devel
>