docgenerator 1.2.1 → 2.0.0

data/readme.rd

@@ -7,11 +7,8 @@ The docgenerator-gem allows the definition of documents and export to
 * context (only rudimentory tests)
 
 
-The docgenerator_tools-gem contains some programs for
-special documents, based on the docgenerator-gem.
-
 =docgenerator-gem
-Defines a programmer interface to define documents.
+Defines a programmer interface to create documents.
 
 Please check the examples:
 * examples/docgenerator_example.rb
@@ -22,28 +19,29 @@ Please check the examples:
 * examples/docgenerator_example_tripfalls.rb
 
 
-This package is the base of
-* creole2doc.rb - a Creole-Wiki to TeX/HTML-Translator (part of the docgenerator-gem)
-* wiki2docgenerator.rb - a Wiki to TeX/HTML-Translator (part of the docgenerator-gem)
-* yaml2presentation.rb - a presentation generator for LaTeX-Beamer-class. Can also be used to build image galleries.
-  (part of docgenerator_tools-gem)
-
-
+This gem contains also
+* creole/creole2doc.rb - a Creole-Wiki to TeX/HTML-Translator
+* wiki2doc/wiki2docgenerator.rb - a Wiki to TeX/HTML-Translator
 
-=docgenerator_tools-gem
-Some tools based on the docgenerator-package:
 
-Special LaTeX-documents: 
-* yaml2presentation.rb: presentations (beamer.sty)
-  Uses packages/docgenerator_beamer.rb
-* rail4creole.rb: build rail-diagramms  (rail.sty)
-  See examples_tools/rail_diagramm_creole.rb
-* docgenerator_tools/code2structogramm.rb: Build structogramms
-  See examples_tools/code2structogramm_test_creole.rb 
-* docgenerator_tools/rubycode4doc/rubycode4doc_creole.rb:
+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_tools/rubycode_wiki.rb
+  See examples/creole_example_rubycode.rb
+  
+==Gems based on docgenerator
+===docgenerator4presentation
+A presentation generator for LaTeX-Beamer-class. 
+Can also be used to build image galleries.
+
+===docgenerator4calendar
+Generation of calendars and event lists. 
+
 
 =Version history
 0.0.x:
@@ -125,8 +123,20 @@ Special LaTeX-documents:
 *  Reorganize unit tests
 *  Ruby 1.9 enabled
 
-1.2.1
+1.2.1 2011-02-20
 * More Ruby 1.9.1 additions (convert encodings)
 * Creole: Images with option width (LaTeX)
 * Corrected examples, added expected results of the examples (increases gem size)
-* corrections footnote handling
+* corrections footnote handling
+
+1.2.2
+* correction wiki2docgenerator.rb, wiki2docgenerator_example.rb
+* add creole2doc_example.rb
+* add todonotes support (only LaTeX)
+
+2.0.0
+* Pack everything in module Docgenerator
+* Group classes to modules
+* clean up lib-folder
+* docgenerator_tools integrated in docgenerator (and docgenerator4presentation-gem)
+

data/unittest/creole_testtext.creole

@@ -0,0 +1,11 @@
+=Title
+==Subtitle
+Text
+
+* item
+* item
+* item
+
+# item 
+# item 
+# item 

data/unittest/expected/test_document_usepackage_undefined.log

@@ -1,2 +1,2 @@
-DEBUG docgenerator: usepackage: Try to load packages/docgenerator_undefined package.rb
- INFO docgenerator: usepackage: No supporting definitions packages/docgenerator_undefined package.rb found
+DEBUG docgenerator: usepackage: Try to load docgenerator/packages/undefined package.rb
+ INFO docgenerator: usepackage: No supporting definitions docgenerator/packages/undefined package.rb found

data/unittest/expected/test_runtex.stdout

@@ -1,3 +1,2 @@
-Save changed	test_runtex.tex
 Statistic for test_runtex:
   Document    : 1 page (test_runtex.log)

data/unittest/expected/test_runtex_2.stdout

@@ -1,3 +1,2 @@
-Save changed	test_runtex_2.tex
 Statistic for test_runtex_2:
   Document    : 1 page (test_runtex_2.log)

data/unittest/expected/toc_css.css

@@ -3,8 +3,9 @@
 	CSS for table of contents
 */
 div.toc	{
-	background: lightgray;
-	border: 2px solid;
+	background-color: lightgray;
+	border-style: solid;
+	border-width: 2px;
 	float: right;
 	width: 45%;
 }

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

@@ -1,17 +1,17 @@
 <ul >
-<li >$  </li>
-<li >%  </li>
-<li >&amp;  </li>
-<li >&rarr;  </li>
-<li >&larr;  </li>
-<li >&lArr;  </li>
-<li >&rArr;  </li>
-<li >_  </li>
-<li >&ndash;  </li>
-<li >&mdash;  </li>
-<li >&rsquo;  </li>
-<li >&sbquo;  </li>
-<li >&ldquo;  </li>
-<li >&bdquo;  </li>
-<li >&hellip;</li>
+<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::Singlelowquotemark: &sbquo;  </li>
+<li > Docgenerator::Characters::Doublelowquotemark: &bdquo;  </li>
+<li > Docgenerator::Characters::Ldots: &hellip;  </li>
+<li > Docgenerator::Characters::Rightsinglequotemark: &rsquo;  </li>
+<li > Docgenerator::Characters::Leftdoublequotemark: &ldquo;  </li>
+<li > Docgenerator::Characters::Ndash: &ndash;  </li>
+<li > Docgenerator::Characters::Mdash: &mdash;</li>
 </ul>

data/unittest/expected_creole/test_creole_characters_all.latex

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

data/unittest/expected_creole/test_creole_footnotes_groupid.html

@@ -0,0 +1,15 @@
+<p >
+Text<sup><a href="#footnote-1">1</a></sup> more text<sup><a href="#g1-1">1</a></sup>  
+</p>
+<hr />
+<p >
+<p ><sup ><a name="footnote-1">1</a></sup>This is a footnote<br />
+</p>
+  
+</p>
+<hr />
+<p >
+<p ><sup ><a name="g1-1">1</a></sup>This is a footnote in group g1<br />
+</p>
+  
+</p>

data/unittest/expected_creole/test_creole_links_file.html

@@ -1,6 +1,6 @@
 <p >
-<a href = "./unittest_creole2doc.rb" >./unittest_creole2doc.rb</a>  
+<a href = "./unittest_creole.rb" >./unittest_creole.rb</a>  
 </p>
 <p >
-<a href = "./unittest_creole2doc.rb" >This unittest-source</a>  
+<a href = "./unittest_creole.rb" >This unittest-source</a>  
 </p>

data/unittest/expected_creole/test_creole_links_file.latex

@@ -1,8 +1,8 @@
 
 
-\href{./unittest_creole2doc.rb}{./unittest_creole2doc.rb}  
+\href{./unittest_creole.rb}{./unittest_creole.rb}  
 
 
 
-\href{./unittest_creole2doc.rb}{This unittest-source}  
+\href{./unittest_creole.rb}{This unittest-source}  
 

data/unittest/expected_creole/test_creole_links_file.text

@@ -1,4 +1,4 @@
 
-./unittest_creole2doc.rb (./unittest_creole2doc.rb)  
+./unittest_creole.rb (./unittest_creole.rb)  
 
-This unittest-source (./unittest_creole2doc.rb)  
+This unittest-source (./unittest_creole.rb)  

data/unittest/expected_creole/test_creole_picture_link.html

@@ -1,5 +1,5 @@
 <p >
-<a href = "./unittest_creole2doc.rb" ><img src = "Red_Flower.jpg" /></a> - if you click on the image, will goto "some link"  
+<a href = "./unittest_creole.rb" ><img src = "Red_Flower.jpg" /></a> - if you click on the image, will goto "some link"  
 </p>
 <p >
 <a href = "http://example.com/" ><img src = "Red_Flower.jpg" /></a> - same as above: picture links to url  

data/unittest/expected_creole_rail/test_rail_creole_object.tex

@@ -0,0 +1,33 @@
+<<prefix>>
+\documentclass[ngerman]{scrartcl}
+\usepackage{babel}
+\usepackage[ansinew]{inputenc}
+\usepackage{hyperref}
+% ----------------------------------------------------------------
+\usepackage{rail}
+
+\title{Rail-Diagramms in Creole}
+\hypersetup{pdftitle={Rail-Diagramms in Creole}}
+
+% ----------------------------------------------------------------
+\begin{document}
+\section{Rail-Diagramms}
+\subsection{Via Ruby-object}
+
+
+%
+% Define a rail-diagramm block
+%
+\begin{rail}
+block :
+        ( lbrace | 'begin' )
+        ( ( '|' ( variable + ',' ) '|' ) | [Keine Blockvariablen] )
+        comm
+        ( rbrace | 'end' )
+;
+\end{rail}
+  
+
+
+\end{document}
+% ----------------------------------------------------------------

data/unittest/expected_creole_rail/test_rail_creole_placeholder.tex

@@ -0,0 +1,40 @@
+<<prefix>>
+\documentclass[ngerman]{scrartcl}
+\usepackage{babel}
+\usepackage[ansinew]{inputenc}
+\usepackage{hyperref}
+% ----------------------------------------------------------------
+\usepackage{rail}
+
+\title{Rail-Diagramms in Creole}
+\hypersetup{pdftitle={Rail-Diagramms in Creole}}
+
+% ----------------------------------------------------------------
+\begin{document}
+\section{Rail-Diagramms}
+\subsection{Via Placeholder}
+%
+% Define a rail-diagramm test
+%
+\begin{rail}
+test :
+      [1] (
+            ( '[' string ']' )
+           ? body[2--6] + '|'
+           )
+    | [2] body[3--6] '*' body[5--6]
+    | [2] body[3--6] '+' body[5--6]
+    | [3] ( body[4--5] + )
+    | [4] body[5] '?'
+    | [5] identifier ( '[' string ']' ) ?
+    | [5] quote string quote
+    | [5] dquote string dquote
+    | [5] '(' body[1--6] ')'
+    | [5] cr
+    | [6]
+    ;
+;
+\end{rail}
+
+\end{document}
+% ----------------------------------------------------------------

data/unittest/expected_rubycode4doc/creole_complete.html

@@ -0,0 +1,26 @@
+<p >
+rubycode  
+</p>
+<pre style = "rubycode" >1 + 1</pre>
+<hr />
+<p >
+rubycode_output  
+</p>
+<pre style = "rubycode_output" >2</pre>
+<hr />
+<p >
+rubycode_evaluated  
+</p>
+<pre style = "rubycode_evaluated" >1 + 1    # -&gt; 2         </pre>
+<hr />
+<p >
+rubycode_in_tab  
+</p>
+
+<table border = "1" ><tr style = "border-bottom-style: solid;border-bottom-width: medium;" ><td >No</td><td >Code</td><td >Result</td><td >Output</td><td >Output2</td></tr>
+<tr ><td >1</td><td ><pre class = "rubycode" >1 + 1</pre></td><td >2</td><td ></td><td ><pre class = "ruby_result" ></pre></td></tr>
+</table>
+<hr />
+<pre class = "rubycode_with_result" >
+1 + 1    # -> 2         
+</pre>

data/unittest/expected_rubycode4doc/creole_complete.tex

@@ -0,0 +1,40 @@
+
+
+rubycode  
+
+
+\begin{verbatim}1 + 1\end{verbatim}
+
+\hrulefill 
+
+
+rubycode\_output  
+
+
+\begin{verbatim}2\end{verbatim}
+
+\hrulefill 
+
+
+rubycode\_evaluated  
+
+
+\begin{verbatim}1 + 1    # -> 2         \end{verbatim}
+
+\hrulefill 
+
+
+rubycode\_in\_tab  
+
+
+\begin{tabular}{lp{3cm}llp{3cm}}No & Code & Result & Output & Output2\\\hline 
+1 & \lstinline[]!1 + 1! & 2 &  & 
+\begin{verbatim}\end{verbatim}
+\\
+\end{tabular}
+\hrulefill 
+
+\begin{lstlisting}[numbers={left}, numberstyle={\tiny}]
+1 + 1    # -> 2         
+\end{lstlisting}
+

data/unittest/expected_rubycode4doc/creole_in_tab.html

@@ -0,0 +1,4 @@
+
+<table border = "1" ><tr style = "border-bottom-style: solid;border-bottom-width: medium;" ><td >No</td><td >Code</td><td >Result</td><td >Output</td><td >Output2</td></tr>
+<tr ><td >1</td><td ><pre class = "rubycode" >1 + 1</pre></td><td >2</td><td ></td><td ><pre class = "ruby_result" ></pre></td></tr>
+</table>

data/unittest/expected_rubycode4doc/creole_in_tab.tex

@@ -0,0 +1,6 @@
+
+\begin{tabular}{lp{3cm}llp{3cm}}No & Code & Result & Output & Output2\\\hline 
+1 & \lstinline[]!1 + 1! & 2 &  & 
+\begin{verbatim}\end{verbatim}
+\\
+\end{tabular}