[Matrix-SIG] RE: Authoring tools (was Active arrays)
Thu, 20 Jan 2000 00:54:05 +0100 (CET)
We need to separate the documentation. We need a technical
documentation explaining the functions, classes and the parameters. I
would keep this in the same format like the standard python library
documentation. There will be tools to parse these files and extract
the info directly at the interpreter prompt, or link to them in a help
browser of the system. This info can have internal and external links
and put into many different output formats.
This has also the benefit, that module writers can do this kind of
documentation much easier (from a authoring perspective) than a
complete and right mathematical documentation. If we mix these two
kinds together it will take longer to document everything.
The pure module documentation (let's call it reference) can also be
included into the CVS. The tutorial and the mathematical rich
documents can be authored externally (and will probably only by the
actual author) with more suitable tools and will probably only be
available as PDF's.
Just some suggestions,
__Janko (who likes LaTeX a lot :-)