Examples of lightweight literate programming

Here I am accumulating a small collection of examples of lightweight literate programming in my style. I expect to add to this collection occasionally.

Here is a brief example in which the "programming language" is XSLT, a notation for defining transformations on XML data. Specifically, this small "program" performs one of the basic literate programming transformations: extracting the code sections. In this case, the input is a lightweight-literate-programming document written in the XML form of DocBook. Standard DocBook tools can be used to render the document on paper, as web pages, and in other forms. The example also shows how my colleagues and I use DocBook for lightweight literate programming by using the DocBook <programlisting> construct.

Here are some examples of Python library classes and routines that I have used in applications I have written. They illustrate particular programming techniques in the Python language, and so they contain much more explanatory text than code.

Next are somewhat longer examples. These are complete but rather small applications, really done just as programming exercises rather than to meet any real-world demand.

The final examples are real applications created for real clients.

My colleague John Shipman has a larger collection of examples.


Last modified: April 6, 2007 by Allan Stavely (email astavely@acm.org). This web page is a work in progress.