Integrating Programs and Documentation

Güting, Ralf Hartmut GND

A simple tool called PD system is described and offered for general use that allows one to integrate programs and their documentation in ASCII files. Such a program with documentation file (PD file) consists of alternating documentation and program sections. PD files can be compiled directly; for a compiler, documentation sections are just commentaries to be ignored. On the other hand, the PD system allows one to transform PD files into LaTeX source files and so to produce formatted documents. For the description of formatted material in the documentation sections, a simple markup language is offered. The main goal in the design of this language is readability of the source text. In other words, formatting specifications are kept as “implicit” and “invisible” as possible and much of the “formatting noise” occurring in LaTeX and other markup languages can be hidden. PD files should be readable for anyone without prior learning of the markup language.

Vorschau

Zitieren

Zitierform:

Güting, Ralf: Integrating Programs and Documentation. Hagen 1995. FernUniversität in Hagen.

Zugriffsstatistik

Gesamt

Volltextzugriffe:
Metadatenansicht:

12 Monate

Volltextzugriffe:
Metadatenansicht:

Rechte

Nutzung und Vervielfältigung:
Alle Rechte vorbehalten

Export

powered by MyCoRe