This is the software homepage of LAML Schemedoc version 28.0 (july 25, 2005, schemedoc).
LAML SchemeDoc is primarily a tool for extraction of interface documentation (API documentation) from specially marked comments in Scheme source files. LAML SchemeDoc can be controlled from an XML language, or from properties in the top-level comment in a source file.
Secondarily, LAML SchemeDoc allows you to author your manuals from scratch, using the XML language mentioned above. It is also possible to document XML DTDs with LAML SchemeDoc. This is especially relevant in a LAML context, because LAML represents XML DTDs as a collection of Scheme functions. Finally, SchemeDoc is bundled with the Scheme Elucidator - a tool for internal program documentation.
The SchemeDoc distribution is a (relatively small) subset of the LAML distribution. The distribution includes the relevant documentation. If you already have either the full or the slim LAML distribution, you also have SchemeDoc.
LAML SchemeDoc works on both Windows and Unix (Linux), and together with a number of different Scheme systems. You must install LAML SchemeDoc before you can use it. See the installation guide. The installation procedure is exactly the same as for LAML.
LAML SchemeDoc comes with a number of CSS stylesheets, which allows you to alter the look of a generated HTML file in different ways. Please consult the CSS SchemeDoc gallery. There is also some internal documentation of the relationship between the classes associated with HTML elements and SchemeDoc.
See also the LAML SchemeDoc home page on the web, which contains additional examples, description of related work, and other useful information.
SchemeDoc can be activated in several different ways, here ordered after the amount of control that can be exercised:
schemedoc file.scmAs of LAML version 27 this only works with MzScheme on Unix (Linux and Solaris). The shell script accepts no options, but processing options can be given in the initial comment of the Scheme source program.
In case you use Emacs, please be aware of a number of SchemeDoc menu entries in Emacs. The Tools menu has a SchemeDoc entry which holds commands that help you construct SchemeDoc scripts. When you are in Scheme mode, the Scheme > SchemeDoc menu entry holds a menu item that activates SchemeDoc, and entries that insert useful documentation comment templates.
Please notice that a few links from the documentation in this distribution may be blind. Consult the full LAML distribution to get access to the information behind these links.![]() |