3. Renditions

The basic concept used in Imprimatur is the document rendition. The rendition defines how much editor's information and annotations should appear in the resulting document. There are three possible renditions:

Rendition: PROOF

This rendition is used for proofreading the document. It inserts all annotations in a prominent form, which makes it easy to revise the document.

Rendition: DISTRIB

This rendition is intended for the documentation distributed with the packaged versions and its online copies on the Web. It inserts most important annotations, so that the reader is aware about which parts of the document are not fully revised for adequacy. Dangling cross-references are also prominently marked as such (see Dangling cross-reference).

Rendition: PUBLISH

This rendition is intended for publishing printed copies of the documentation. It is supposed that by the time the document is ready for publishing, all editor's and proofreader's annotations and dangling references have been resolved and removed from the document. Consequently, the use of annotation macros in this rendition results in translation errors. This helps prevent publishing incomplete or inaccurate documentation.

Default rendition is determined when configuring the package. It can be redefined when building the output, by using the ‘RENDITION’ Makefile variable, e.g.: