Documentation Strategy » History » Revision 13
Revision 12 (Detlef Hühnlein, 10/17/2012 07:46 AM) → Revision 13/21 (Detlef Hühnlein, 10/17/2012 07:53 AM)
h1. Document Creation Process In order to allow distributed and convenient editing using the wiki *AND* producing documents with high quality typesetting, the document creation process as depicted in the following figure !process.png(Document Creation Process)! is implemented. !process.png(Document Creation Process)! h2. Editing in Wiki is primary source The primary editing is performed in the present Wiki, which uses the "Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29 markup Textile-markup as explained "here":http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting. h2. Rules for Wiki-based documentation In order to allow an automated conversion to and processing with LaTeX, the following issues rules MUST be considered: # Each A Wiki-page is converted corresponds to a corresponding .tex file LaTeX-chapter and hence a Wiki-page SHOULD NOT include sub-Wiki-pages. # h1.-h3. correspond to \section{ }-\subsubsection{ } # References to literature MAY be included, but if they MUST be are included as link with brackets [ ] around the "LABEL" (e.g. "[BSI-TR-03112-7]":http://docs.ecsec.de/BSI-TR-03112-7), where the LABEL SHOULD be defined in an appropriate BibTeX-file. h2. RedCloth conversion to raw LaTeX The Textile-markup from the Wiki can be converted to LaTeX using "RedCloth":http://redcloth.org/. h2. Cleaning up LaTeX using awk In order to support references to documents (e.g. "[BSI-TR-03112-7]":http://docs.ecsec.de/BSI-TR-03112-7) or the inclusion of pretty-printed XML- or Java-code (e.g. <pre><code class="xml"><xml> ... </xml></code></pre>), the raw LaTeX document needs to be cleaned up with "awk":https://de.wikipedia.org/wiki/Awk. This includes the following replacements: <pre><code> 1. <pre><code class="XXX"> --> \begin{minted}[bgcolor=bg]{XXX} 2. </code></pre> --> \end{minted} 3. "[LABEL]":http://url --> \cite{LABEL} 4. [[WikiRef]] --> ...