docgenerator-creole 3.0.0

data/readme.rdoc

@@ -0,0 +1,44 @@
+=Docgenerator::Creole
+
+==Docgenerator-gem
+The docgenerator-gem allows the definition of documents and export to
+* LaTeX
+* HTML
+* Creole (a common wiki markup, see http://www.wikicreole.org )
+* plain text (not very good supported)
+* context (only rudimentory tests)
+
+==Docgenerator::Creole-gem
+
+This gem is an extension with a Creole-Wiki to TeX/HTML-Translator
+Before docgenerator 3.0 the creole parts are integrated to the main gem.
+
+The creole markup is defined at http://www.wikicreole.org
+
+
+==Examples
+Please check the examples:
+
+
+===Special LaTeX-Packages
+
+There is also support of some special (LaTeX)-documents:
+* lib/creole/plugins/rail.rb: build rail-diagramms  (rail.sty)
+  See examples/creole_example_rail.rb
+* lib/creole/plugins/struktex.rb: Build structogramms (struktex.sty)
+  See examples/creole_example_struktex.rb
+* lib/creole/plugins/rubycode4creole.rb:
+  Use ruby-code as generator for wiki-content.
+  Can be used to build examples.
+  See examples/creole_example_rubycode.rb
+  
+
+==Version and History
+For actual Version see Docgenerator::Creole::VERSION.
+
+===Version 3.0.0. 2015-05-29
+
+Initial version as own gem.
+
+Changes to docgenerator 2.0:
+* tabular cells are right justified if the content contains only numbers.

data/unittest/expected_creole/test_creole.html

@@ -0,0 +1,3 @@
+<h2 >Titel 1</h2>
+<p >Text, mehr Text</p>
+<p >Neuer Absatz</p>

data/unittest/expected_creole/test_creole_characters_all.creole

@@ -0,0 +1,28 @@
+
+* Docgenerator::Characters::Dollar: $  
+* Docgenerator::Characters::Percent: 
+  
+* Docgenerator::Characters::Ampersand: 
+  
+* Docgenerator::Characters::Rightarrow: 
+  
+* Docgenerator::Characters::Leftarrow: 
+  
+* Docgenerator::Characters::LLeftarrow: 
+  
+* Docgenerator::Characters::RRightarrow: 
+  
+* Docgenerator::Characters::Underscore: _  
+* Docgenerator::Characters::Sbquo: 
+  
+* Docgenerator::Characters::Bdquo: 
+  
+* Docgenerator::Characters::Ldots: 
+  
+* Docgenerator::Characters::Rsquo: 
+  
+* Docgenerator::Characters::Ldquo: 
+  
+* Docgenerator::Characters::Ndash: 
+  
+* Docgenerator::Characters::Mdash: 

data/unittest/expected_creole/test_creole_characters_all.html

@@ -0,0 +1,18 @@
+<ul >
+<li > Docgenerator::Characters::Dollar: $  </li>
+<li > Docgenerator::Characters::Percent: %  </li>
+<li > Docgenerator::Characters::Ampersand: &amp;  </li>
+<li > Docgenerator::Characters::Rightarrow: &rarr;  </li>
+<li > Docgenerator::Characters::Leftarrow: &larr;  </li>
+<li > Docgenerator::Characters::LLeftarrow: &lArr;  </li>
+<li > Docgenerator::Characters::RRightarrow: &rArr;  </li>
+<li > Docgenerator::Characters::Underscore: _  </li>
+<li > Docgenerator::Characters::Ndash: &ndash;  </li>
+<li > Docgenerator::Characters::Mdash: &mdash;  </li>
+<li > Docgenerator::Characters::Rightsinglequotemark: &rsquo;  </li>
+<li > Docgenerator::Characters::Singlelowquotemark: &sbquo;  </li>
+<li > Docgenerator::Characters::Leftdoublequotemark: &ldquo;  </li>
+<li > Docgenerator::Characters::Rightdoublequotemark: &rdquo;  </li>
+<li > Docgenerator::Characters::Doublelowquotemark: &bdquo;  </li>
+<li > Docgenerator::Characters::Ldots: &hellip;</li>
+</ul>

data/unittest/expected_creole/test_creole_characters_all.latex

@@ -0,0 +1,36 @@
+
+\begin{itemize}
+
+\item  Docgenerator::Characters::Dollar: \$  
+
+\item  Docgenerator::Characters::Percent: \%  
+
+\item  Docgenerator::Characters::Ampersand: \&  
+
+\item  Docgenerator::Characters::Rightarrow: \ensuremath{\rightarrow}  
+
+\item  Docgenerator::Characters::Leftarrow: \ensuremath{\leftarrow}  
+
+\item  Docgenerator::Characters::LLeftarrow: \ensuremath{\Leftarrow}  
+
+\item  Docgenerator::Characters::RRightarrow: \ensuremath{\Rightarrow}  
+
+\item  Docgenerator::Characters::Underscore: \_  
+
+\item  Docgenerator::Characters::Ndash: --  
+
+\item  Docgenerator::Characters::Mdash: ---   
+
+\item  Docgenerator::Characters::Rightsinglequotemark: \rq   
+
+\item  Docgenerator::Characters::Singlelowquotemark: \glq   
+
+\item  Docgenerator::Characters::Leftdoublequotemark: \lq\lq{}  
+
+\item  Docgenerator::Characters::Rightdoublequotemark: \grqq   
+
+\item  Docgenerator::Characters::Doublelowquotemark: \glqq   
+
+\item  Docgenerator::Characters::Ldots: \ldots 
+\end{itemize}
+

data/unittest/expected_creole/test_creole_characters_special.html

@@ -0,0 +1,10 @@
+<p >
+Special Characters: 
+</p>
+<ul >
+<li >$ - Dollar </li>
+<li >% - Percent </li>
+<li >&rArr; Rightarrow </li>
+<li >&rarr; rightarrow </li>
+<li >_ Underscore </li>
+</ul>

data/unittest/expected_creole/test_creole_characters_special.latex

@@ -0,0 +1,18 @@
+
+
+Special Characters: 
+
+
+\begin{itemize}
+
+\item \$ - Dollar 
+
+\item \% - Percent 
+
+\item \ensuremath{\Rightarrow} Rightarrow 
+
+\item \ensuremath{\rightarrow} rightarrow 
+
+\item \_ Underscore 
+\end{itemize}
+

data/unittest/expected_creole/test_creole_comment.context

@@ -0,0 +1,11 @@
+\subsection{Titel 1}
+
+
+Text 
+
+%This is a comment.
+%It's part of the document, but not visible to readers.
+
+
+Text after 
+

data/unittest/expected_creole/test_creole_comment.creole

@@ -0,0 +1,12 @@
+
+===Titel 1
+
+
+Text 
+
+<<<comment
+This is a comment.
+It's part of the document, but not visible to readers.
+>>>
+Text after 
+

data/unittest/expected_creole/test_creole_comment.html

@@ -0,0 +1,9 @@
+<h2 >Titel 1</h2>
+<p >
+Text 
+</p>
+<!-- This is a comment.
+It's part of the document, but not visible to readers.
+ --><p >
+Text after 
+</p>

data/unittest/expected_creole/test_creole_comment.latex

@@ -0,0 +1,11 @@
+\subsection{Titel 1}
+
+
+Text 
+
+%This is a comment.
+%It's part of the document, but not visible to readers.
+
+
+Text after 
+

data/unittest/expected_creole/test_creole_countdown.html

@@ -0,0 +1,3 @@
+<p >
+Countdown: 10-9-8-7-6-5-4-3-2-1  
+</p>

data/unittest/expected_creole/test_creole_countdown.latex

@@ -0,0 +1,4 @@
+
+
+Countdown: 10-9-8-7-6-5-4-3-2-1  
+

data/unittest/expected_creole/test_creole_creole1.0test.html

@@ -0,0 +1,182 @@
+<h1 > Top-level heading (1)</h1>
+<h2 > This a test for creole 0.1 (2)</h2>
+<h3 > This is a Subheading (3)</h3>
+<h4 > Subsub (4)</h4>
+<h5 > Subsubsub (5)</h5>
+<p >
+The ending equal signs should not be displayed: 
+</p>
+<h1 > Top-level heading (1) </h1>
+<h2 > This a test for creole 0.1 (2) </h2>
+<h3 > This is a Subheading (3) </h3>
+<h4 > Subsub (4) </h4>
+<h5 > Subsubsub (5) </h5>
+<p >
+You can make things <strong >bold</strong> or <em >italic</em> or <strong ><em >both</em></strong> or <em ><strong >both</strong></em>. 
+</p>
+<p >
+Character formatting extends across line breaks: <strong >bold, this is still bold. This line deliberately does not end in star-star. </strong>
+</p>
+<p >
+Not bold. Character formatting does not cross paragraph boundaries. 
+</p>
+<p >
+You can use <a href = "internal links" >internal links</a> or <a href = "http://www.wikicreole.org" >external links</a>, give the link a <a href = "internal links" >different</a> name. 
+</p>
+<p >
+Here's another sentence: This wisdom is taken from <a href = "Ward Cunningham's" >Ward Cunningham's</a>  <a href = "http://www.c2.com/doc/wikisym/WikiSym2006.pdf" >Presentation at the Wikisym 06</a>. 
+</p>
+<p >
+Here's a external link without a description: <a href = "http://www.wikicreole.org" >http://www.wikicreole.org</a>  
+</p>
+<p >
+Be careful that italic links are rendered properly: <em ><a href = "http://my.book.example/" >My Book Title</a></em>  
+</p>
+<p >
+Free links without braces should be rendered as well, like <a href = "http://www.wikicreole.org/">http://www.wikicreole.org/</a>  and <a href = "http://www.wikicreole.org/users/~example.">http://www.wikicreole.org/users/~example.</a>    
+</p>
+<p >
+Creole1.0 specifies that <a href = "http://bar">http://bar</a>  and ftp:<em >bar should not render italic, something like foo:</em>bar should render as italic. 
+</p>
+<p >
+You can use this to draw a line to separate the page: 
+</p>
+<hr />
+<p >
+You can use lists, start it at the first column for now, please... 
+</p>
+<p >
+unnumbered lists are like 
+</p>
+<ul >
+<li > item a </li>
+<li > item b </li>
+<li >  <strong >bold item c</strong>  </li>
+</ul>
+<p >
+blank space is also permitted before lists like: 
+</p>
+<ul >
+<li > item a </li>
+<li > item b </li>
+<li > item c <ul >
+<li > item c.a </li>
+</ul>
+</li>
+</ul>
+<p >
+or you can number them 
+</p>
+<ol >
+<li >  <a href = "item 1" >item 1</a>  </li>
+<li > item 2 </li>
+<li >  <em >italic item 3 </em>  <ol >
+<li > item 3.1 </li>
+<li > item 3.2 </li>
+</ol>
+</li>
+</ol>
+<p >
+up to five levels 
+</p>
+<ul >
+<li > 1 <ul >
+<li > 2 <ul >
+<li > 3 <ul >
+<li > 4 <ul >
+<li > 5 </li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<ul >
+<li > You can have multiline list items </li>
+<li > this is a second multiline list item </li>
+</ul>
+<p >
+You can use nowiki syntax if you would like do stuff like this: 
+</p>
+<pre>
+Guitar Chord C:
+
+||---|---|---|
+||-0-|---|---|
+||---|---|---|
+||---|-0-|---|
+||---|---|-0-|
+||---|---|---|
+</pre>
+<p >
+You can also use it inline nowiki <span style = "display: inline;white-space:pre;font-family:monospace"> in a sentence </span> like this. 
+</p>
+<h1 > Escapes </h1>
+<p >
+Normal Link: <a href = "http://wikicreole.org/">http://wikicreole.org/</a>  - now same link, but escaped: ~<a href = "http://wikicreole.org/">http://wikicreole.org/</a>    
+</p>
+<p >
+Normal asterisks: ~<strong >not bold~</strong>  
+</p>
+<p >
+a tilde alone: ~ 
+</p>
+<p >
+a tilde escapes itself: ~~xxx 
+</p>
+<h3 > Creole 0.2 </h3>
+<p >
+This should be a flower with the ALT text "this is a flower" if your wiki
+supports ALT text on images: 
+</p>
+<p >
+<img src = "Red_Flower.jpg" alt = "here is a red flower" />  
+</p>
+<h3 > Creole 0.4 </h3>
+<p >
+Tables are done like this: 
+</p>
+<table >
+<tr ><th >header col1</th>
+<th >header col2</th>
+</tr>
+<tr ><td >col1</td>
+<td >col2</td>
+</tr>
+<tr ><td >you</td>
+<td >can</td>
+</tr>
+<tr ><td >also</td>
+<td >align<br />
+ it.</td>
+</tr>
+</table>
+<p >
+You can format an address by simply forcing linebreaks: 
+</p>
+<p >
+My contact dates:<br />
+ Phone: xyz<br />
+ Fax: +45<br />
+ Mobile: abc 
+</p>
+<h3 > Creole 0.5 </h3>
+<table >
+<tr ><th >Header title</th>
+<th >Another header title</th>
+</tr>
+<tr ><td ><span style = "display: inline;white-space:pre;font-family:monospace"> //not italic text// </span></td>
+<td ><span style = "display: inline;white-space:pre;font-family:monospace"> **not bold text** </span></td>
+</tr>
+<tr ><td ><em >italic text</em></td>
+<td ><strong >bold text </strong></td>
+</tr>
+</table>
+<h3 > Creole 1.0 </h3>
+<p >
+If interwiki links are setup in your wiki, this links to the WikiCreole
+page about Creole 1.0 test cases: <a href = "WikiCreole:Creole1.0TestCases" >WikiCreole:Creole1.0TestCases</a>. 
+</p>

data/unittest/expected_creole/test_creole_creole1.0test.latex

@@ -0,0 +1,253 @@
+\section{ Top-level heading (1)}
+\subsection{ This a test for creole 0.1 (2)}
+\subsubsection{ This is a Subheading (3)}
+\paragraph{ Subsub (4)}
+\subparagraph{ Subsubsub (5)}
+
+
+The ending equal signs should not be displayed: 
+
+\section{ Top-level heading (1) }
+\subsection{ This a test for creole 0.1 (2) }
+\subsubsection{ This is a Subheading (3) }
+\paragraph{ Subsub (4) }
+\subparagraph{ Subsubsub (5) }
+
+
+You can make things \textbf{bold} or \emph{italic} or \textbf{\emph{both}} or \emph{\textbf{both}}. 
+
+
+
+Character formatting extends across line breaks: \textbf{bold, this is still bold. This line deliberately does not end in star-star. }
+
+
+
+Not bold. Character formatting does not cross paragraph boundaries. 
+
+
+
+You can use \href{internal links}{internal links} or \href{http://www.wikicreole.org}{external links}, give the link a \href{internal links}{different} name. 
+
+
+
+Here's another sentence: This wisdom is taken from \href{Ward Cunningham's}{Ward Cunningham's}  \href{http://www.c2.com/doc/wikisym/WikiSym2006.pdf}{Presentation at the Wikisym 06}. 
+
+
+
+Here's a external link without a description: \href{http://www.wikicreole.org}{http://www.wikicreole.org}  
+
+
+
+Be careful that italic links are rendered properly: \emph{\href{http://my.book.example/}{My Book Title}}  
+
+
+
+Free links without braces should be rendered as well, like \url{http://www.wikicreole.org/}  and \url{http://www.wikicreole.org/users/~example.}    
+
+
+
+Creole1.0 specifies that \url{http://bar}  and ftp:\emph{bar should not render italic, something like foo:}bar should render as italic. 
+
+
+
+You can use this to draw a line to separate the page: 
+
+\hrulefill 
+
+
+You can use lists, start it at the first column for now, please... 
+
+
+
+unnumbered lists are like 
+
+
+\begin{itemize}
+
+\item  item a 
+
+\item  item b 
+
+\item   \textbf{bold item c}  
+\end{itemize}
+
+
+
+blank space is also permitted before lists like: 
+
+
+\begin{itemize}
+
+\item  item a 
+
+\item  item b 
+
+\item  item c 
+\begin{itemize}
+
+\item  item c.a 
+\end{itemize}
+
+
+\end{itemize}
+
+
+
+or you can number them 
+
+
+\begin{enumerate}
+
+\item   \href{item 1}{item 1}  
+
+\item  item 2 
+
+\item   \emph{italic item 3 }  
+\begin{enumerate}
+
+\item  item 3.1 
+
+\item  item 3.2 
+\end{enumerate}
+
+
+\end{enumerate}
+
+
+
+up to five levels 
+
+
+\begin{itemize}
+
+\item  1 
+\begin{itemize}
+
+\item  2 
+\begin{itemize}
+
+\item  3 
+\begin{itemize}
+
+\item  4 
+\begin{itemize}
+
+\item  5 
+\end{itemize}
+
+
+\end{itemize}
+
+
+\end{itemize}
+
+
+\end{itemize}
+
+
+\end{itemize}
+
+
+\begin{itemize}
+
+\item  You can have multiline list items 
+
+\item  this is a second multiline list item 
+\end{itemize}
+
+
+
+You can use nowiki syntax if you would like do stuff like this: 
+
+
+\begin{verbatim}
+Guitar Chord C:
+
+||---|---|---|
+||-0-|---|---|
+||---|---|---|
+||---|-0-|---|
+||---|---|-0-|
+||---|---|---|
+\end{verbatim}
+
+
+
+You can also use it inline nowiki \verb| in a sentence | like this. 
+
+\section{ Escapes }
+
+
+Normal Link: \url{http://wikicreole.org/}  - now same link, but escaped: ~\url{http://wikicreole.org/}    
+
+
+
+Normal asterisks: ~\textbf{not bold~}  
+
+
+
+a tilde alone: ~ 
+
+
+
+a tilde escapes itself: ~~xxx 
+
+\subsubsection{ Creole 0.2 }
+
+
+This should be a flower with the ALT text "this is a flower" if your wiki
+supports ALT text on images: 
+
+
+
+\includegraphics[,]{Red_Flower.jpg}  
+
+\subsubsection{ Creole 0.4 }
+
+
+Tables are done like this: 
+
+\begin{tabular}{ll}
+\textbf{header col1}
+ & \textbf{header col2}
+\\
+col1
+ & col2
+\\
+you
+ & can
+\\
+also
+ & align\newline 
+ it.
+\\
+\end{tabular}
+
+
+You can format an address by simply forcing linebreaks: 
+
+
+
+My contact dates:\newline 
+ Phone: xyz\newline 
+ Fax: +45\newline 
+ Mobile: abc 
+
+\subsubsection{ Creole 0.5 }
+\begin{tabular}{ll}
+\textbf{Header title}
+ & \textbf{Another header title}
+\\
+\verb| //not italic text// |
+ & \verb| **not bold text** |
+\\
+\emph{italic text}
+ & \textbf{bold text }
+\\
+\end{tabular}
+\subsubsection{ Creole 1.0 }
+
+
+If interwiki links are setup in your wiki, this links to the WikiCreole
+page about Creole 1.0 test cases: \href{WikiCreole:Creole1.0TestCases}{WikiCreole:Creole1.0TestCases}. 
+