[Maxima] documenting packages not in distribution
l.butler at ed.ac.uk
Sat Jun 12 10:31:28 CDT 2010
On Tue, 8 Jun 2010, John Lapeyre wrote:
< Does someone know how to make documentation for maxima
< functions that are not part of the maxima distribution? For
< instance, being able to integrate documentation into the the
< online system would be nice.
< ./share/template.texi gives instructions for making
< a document and integrating it into the distribution. It's not clear
< how to do this without doing configure and make for the entire
< distribution. template.texi makes reference to template-standalone.texi,
< which is not in the source tree.
< It appears that code for online documentation is in
< cl-info.lisp and is called via build_index.pl.
< ./perl build_index.pl maxima.info
< looks like it generates lisp code that makes a hash table
< giving the range of bytes in .info files for each topic.
< I guess that it would go something like this:
< 1. write your own texi documents.
< 2. convert it to info files
< 3 call ./build_info.pl mydoc.info
< 4 execute the resulting lisp code which will add entries
< to the hash tables that are referenced by 'describe'
< There are probably other issues like getting your user info
< files into some search path. Maybe someone else has already
< done this ?
A while ago I wrote user_doc that provides a straightforward means
to add documentation to Maxima's online help. It does not require
a separate texinfo document; it is more in the spirit of POD.
It should be fairly straightforward to add functionality to it
so that the user can build documentation in texinfo documents and
have that information available via online help similar to what
you describe above (but also have the documentation distinct from
Maxima's own documentation, so that you can load documentation on
a package or directory basis).
Would you mind putting in a feature request about this, please.
The University of Edinburgh is a charitable body, registered in
Scotland, with registration number SC005336.
More information about the Maxima