Slide 17 : 38

The source format of the documentation

When the programmer works with a literate program the source format of the documentation is of particular interest. This format is important because it constitute the words and lines actually written by the programmer. In addition, the programmer will spend much time reading parts of the documentation in this format. Therefore the properties of the format matters. This page is related to the Scheme elucidator only.

Scheme: A simple, specialized markup is used for the overall structure, the relations, and the source markers Non-obstructive, discrete, and terse It is relatively easy and attractive to read the documentation in the editor Java: An XML markup language is used for the overall structure, the relations, and the source markers Standard, and general markup language Can be processed via a number of different tools HTML is used for additional markup purposes Avoids proliferation of languages with similar purposes The mixing of markup styles is not aesthetically pleasant

An excerpt of the time conversion documentation source - Scheme An excerpt of the time conversion documentation source - Java