asciidoc literate programming
Not logged in

Asciidoc is a plain text markup tool that can produce a wide variety of outputs. It is also very suitable for use in a literate programming environment. The atangle and aweave programs are literate programming tools for use with asciidoc. What is different about using asciidoc as a literate programming base, is that the source is a valid asciidoc document and can be formatted on it own. Atangle is used to extract source code from the document. Aweave adds some annotation and indexing information to the orignal asciidoc source. The use of aweave is optional but adds many index entries and hyperlinks within the document. Both atangle and aweave use noweb style chunk definitions. The documention describes the format. The only key point to remember is that source code in asciidoc is contained between lines of four or more hyphens.

------
A source code block.
------
Chunk definitions must be located within source code blocks.
------
<<search>>=
// Defines the "search" chunk.
<<found>>
// References the "found" chunk.
------
The programs can be obtained from the downloads page.