Project

General

Profile

Documentation Strategy » History » Version 13

Detlef Hühnlein, 10/17/2012 07:53 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
h2. RedCloth conversion to raw LaTeX
23
24
The Textile-markup from the Wiki can be converted to LaTeX using "RedCloth":http://redcloth.org/.
25
26 4 Detlef Hühnlein
h2. Cleaning up LaTeX using awk
27 1 Detlef Hühnlein
28 10 Detlef Hühnlein
In order to support references to documents (e.g. "[BSI-TR-03112-7]":http://docs.ecsec.de/BSI-TR-03112-7) or 
29 1 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.  
30 10 Detlef Hühnlein
This includes the following replacements: 
31 11 Detlef Hühnlein
32
<pre><code> 
33
1. <pre><code class="XXX"> --> \begin{minted}[bgcolor=bg]{XXX}
34
2. </code></pre>           --> \end{minted}
35 1 Detlef Hühnlein
3. "[LABEL]":http://url    --> \cite{LABEL}
36
4. [[WikiRef]]             --> ...