Previous | 
Home
Section: New Software and Platforms
LaTeX package: Checklistings
Functional Description
User manuals and papers about programming languages usually contain many code samples, often with accompanying compiler messages giving the types of declarations or error messages explaining why certain declarations are invalid.
The checklistings package augments the fancyvrb and listings packages for including source code in LaTeX documents with a way to pass the source code through a compiler and also include the resulting messages in the document. It also integrates with the HeVeA tool developed in the Gallium team: http://hevea.inria.fr .
The motivation is to check the code samples in a document for syntax and typing errors and to facilitate the inclusion of inferred types and compiler warnings or errors in a text. This package is intentionally very lightweight and unlike packages like python it is not intended for interacting with an interpretor or including the execution traces of code. While checklistings does not focus on a specific programming language, it is designed to work well with ML-like languages.
We developed this package to improve the quality of our papers and presentations on the Zélus programming language, but it is designed to be general purpose and also works, for instance, with OCaml programs.