Documentation Strategy

In order to allow distributed and convenient editing using the wiki
AND producing documents with high quality typesetting, the following documentation
strategy is implemented:

Wiki is primary source

The primary editing is performed in the present Wiki, which uses the
Textile-markup as explained here.

Rules for Wiki-based documentation

In order to allow conversion to LaTeX, the following rules MUST be considered:

  1. A Wiki-page corresponds to a LaTeX-chapter and hence a Wiki-page SHOULD NOT include sub-Wiki-pages.
  2. References to literature MAY be included, if they are included as link with brackets [ ] around the "LABEL" (e.g. [BSI-TR-03112-7]),
    where the LABEL SHOULD be defined in an appropriate BibTeX-file.

RedCloth conversion to raw LaTeX

The Textile-markup from the Wiki can be converted to LaTeX using RedCloth.

Cleaning up LaTeX using awk

In order to support references to documents (e.g. [BSI-TR-03112-7]) or
the inclusion of pretty-printed XML- or Java-code (e.g. 

<xml> ... </xml>
), the raw LaTeX document needs to be cleaned up with awk.
This includes the following steps:

  1. Replacing 
    <pre><code class="XXX"></pre> by <pre>\begin{minted}[bgcolor=bg]{XXX}</pre>