Documentation Strategy » History » Version 3
Detlef Hühnlein, 10/16/2012 05:15 PM
| 1 | 1 | Detlef Hühnlein | h1. Documentation Strategy |
|---|---|---|---|
| 2 | |||
| 3 | In order to allow distributed and convenient editing using the wiki |
||
| 4 | *AND* producing documents with high quality typesetting, the following documentation |
||
| 5 | strategy is implemented: |
||
| 6 | |||
| 7 | h2. Wiki is primary source |
||
| 8 | |||
| 9 | The primary editing is performed in the present Wiki, which uses the |
||
| 10 | Textile-markup as explained "here":http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting. |
||
| 11 | |||
| 12 | h2. Rules for Wiki-based documentation |
||
| 13 | |||
| 14 | In order to allow conversion to LaTeX, the following rules MUST be considered: |
||
| 15 | |||
| 16 | 3 | Detlef Hühnlein | # References to literature - MUST be included as link with brackets around the "LABEL" (e.g. "[BSI-TR03112]":http://www.openecard.org/references#BSI-TR03112). |
| 17 | 1 | Detlef Hühnlein | |
| 18 | h2. RedCloth conversion to raw LaTeX |
||
| 19 | |||
| 20 | The Textile-markup from the Wiki can be converted to LaTeX using "RedCloth":http://redcloth.org/. |
||
| 21 | |||
| 22 | h2. Cleaning up LaTeX using awk |
||
| 23 | |||
| 24 | In order to support references to documents (e.g. "[BSI-TR03112]":http://www.openecard.org/references#BSI-TR03112) or |
||
| 25 | 3 | Detlef Hühnlein | 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. |
| 26 | This includes the following steps: |