Slide 15 : 20

Example of the Elucidator document style

As the last LAML document style we take a look at the Scheme Elucidator style.

The elucidator document styles support a variant of literate programming for Scheme in which we document the internal aspects of a program

An Elucidator demo (small example) The Elucidator documentation (large example) Example of the Elucidator's textual documentation format

Characteristics of the Scheme Elucidator: The documentation and the program are shown in a two column layout with lots of links in between them The documentation can either be defined using a simple, specialized markup language or via LAML expressions The program source files are not affected by our documentation efforts The Elucidator is language dependent Most of the functionality of the Elucidator is replicated in Emacs, such that it is convenient to document a program during the process of program development