Documentation Strategy » History » Version 15
Detlef Hühnlein, 10/17/2012 08:04 AM
1 | 12 | Detlef Hühnlein | h1. Document Creation Process |
---|---|---|---|
2 | 1 | Detlef Hühnlein | |
3 | In order to allow distributed and convenient editing using the wiki |
||
4 | 12 | Detlef Hühnlein | *AND* producing documents with high quality typesetting, the document creation process |
5 | 13 | Detlef Hühnlein | as depicted in the following figure is implemented. |
6 | 1 | Detlef Hühnlein | |
7 | 13 | Detlef Hühnlein | !process.png(Document Creation Process)! |
8 | 1 | Detlef Hühnlein | |
9 | 13 | Detlef Hühnlein | h2. Editing in Wiki |
10 | |||
11 | 1 | Detlef Hühnlein | The primary editing is performed in the present Wiki, which uses the |
12 | 13 | Detlef Hühnlein | "Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29 markup as |
13 | explained "here":http://www.redmine.org/projects/redmine/wiki/RedmineTextFormatting. |
||
14 | 1 | Detlef Hühnlein | |
15 | 13 | Detlef Hühnlein | In order to allow an automated conversion to and processing with LaTeX, the following issues MUST be considered: |
16 | 4 | Detlef Hühnlein | |
17 | 13 | Detlef Hühnlein | # Each Wiki-page is converted to a corresponding .tex file |
18 | # h1.-h3. correspond to \section{ }-\subsubsection{ } |
||
19 | # References to literature MAY be included, but they MUST be included as link with brackets [ ] around the "LABEL" (e.g. "[BSI-TR-03112-7]":http://docs.ecsec.de/BSI-TR-03112-7), |
||
20 | 1 | Detlef Hühnlein | where the LABEL SHOULD be defined in an appropriate BibTeX-file. |
21 | |||
22 | 14 | Detlef Hühnlein | h2. Export |
23 | 1 | Detlef Hühnlein | |
24 | 14 | Detlef Hühnlein | The export of the Textile source to an appropriate .tex file and the provision of embedded pictures MAY be performed manually. |
25 | In the long turn there SHOULD be an automated export of the Wiki-pages as explained "here":http://stbuehler.de/blog/article/2011/06/04/exporting_redmine_wiki_pages.html for example. |
||
26 | |||
27 | |||
28 | h2. Textile to LaTeX conversion |
||
29 | |||
30 | 1 | Detlef Hühnlein | The Textile-markup from the Wiki can be converted to LaTeX using "RedCloth":http://redcloth.org/. |
31 | |||
32 | 14 | Detlef Hühnlein | h2. LaTeX-Post-Processing |
33 | 1 | Detlef Hühnlein | |
34 | 14 | Detlef Hühnlein | In order to support references to documents (e.g. "[BSI-TR-03112-7]":http://docs.ecsec.de/BSI-TR-03112-7), intra-Wiki-Links and |
35 | 10 | 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. |
36 | 14 | Detlef Hühnlein | |
37 | 10 | Detlef Hühnlein | This includes the following replacements: |
38 | 11 | Detlef Hühnlein | |
39 | 15 | Detlef Hühnlein | <pre><code>1. <pre><code class="XXX"> --> \begin{minted}[bgcolor=bg]{XXX} |
40 | 1 | Detlef Hühnlein | 2. </code></pre> --> \end{minted} |
41 | 3. "[LABEL]":http://url --> \cite{LABEL} |
||
42 | 4. [[WikiRef]] --> ... |
||
43 | 15 | Detlef Hühnlein | </code></pre> |
44 | 1 | Detlef Hühnlein | |
45 | 15 | Detlef Hühnlein | h2. Document Compilation |
46 | |||
47 | Finally the LaTeX sources are compiled to produce a nice pdf-document for example. |