docgenerator 1.1.1 → 1.2.1

data/readme.rd

@@ -0,0 +1,132 @@
+The docgenerator-gem allows the definition of documents and export to
+* LaTeX
+* HTML
+* Creole (a common wiki markup, see http://www.wikicreole.org )
+* Wiki-markup like Wikimedia[http://www.mediawiki.org/wiki/MediaWiki/] (not supported any longer)
+* plain text (not very good supported)
+* 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.
+
+Please check the examples:
+* examples/docgenerator_example.rb
+* examples/docgenerator_example_list.rb
+* examples/docgenerator_example_tabular.rb
+* examples/docgenerator_example_footnote.rb
+* examples/docgenerator_example_restrictions.rb
+* 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)
+
+
+
+=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:
+  Use ruby-code as generator for wiki-content.
+  Can be used to build examples.
+  See examples_tools/rubycode_wiki.rb
+
+=Version history
+0.0.x:
+* Developpers version
+
+0.1.0:
+*  to_element
+
+0.1.1:
+*  to_element
+
+1.0.0:
+*  to_doc
+*  no @@target any longer
+*  Document.new mit Hash
+*  unit tests
+*  lib-folder
+*  Constant DOCGENERATOR_VERSION
+*  Published as 1.0.2
+
+1.0.3:
+*  Add table of contents
+
+1.0.4 (2008-05-06)
+*  wiki2docgenerator: delete myscripts.rb
+*  wiki2docgenerator: change in link (no cr)
+*  Add dependency log4r
+*  Correction error 'uninitialized constant CSS_collection (NameError)'
+   -> rubyforge
+
+1.0.5 (2008-09-24)
+*  yaml2presentation + docgenerator_beamer.rb
+*  Correction packages/docgenerator_scrlettr2.rb
+*  wiki2docgenerator: In Tab: Allow ! as replacement for |
+*  CSS_collection: Define accessor []
+*  Attribute#filled? ignores nil-values
+*  Docgenerator: 
+   *Default-Logger gives message
+   *Check META-Values
+   *shorttitle adapted
+   *Document.new: add option :css
+
+1.1.0 
+*  Document.save: Changes interface, options...
+*  Wikitext: Ignore multiple empty lines
+*  Element#new: Define default-attribute :log for logger (used afterwords as @log)
+*  yaml2presentation: New setting :valid_keys
+*  package/docgenerator_scrlettr2: Extended
+*  default pdflualatex for runtex
+*  Add ->, => for text-output
+
+1.1.1:
+*  Document.new: New option parameter/All meta-tags are allowed
+*  Document.save: New option :additional_options
+*  Wikitext: Add method Wikitext.help
+*  Added first version of creole2doc (should replace wiki2docgenerator) 
+   Details see http://www.wikicreole.org/
+*  Little reorg of the Documentation
+   published 2009-06-28
+  
+1.1.2:
+*  Correction Creole  (Unit test test_creole_mix_titles_list)
+*  First steps for Context-support (don't expect too much)
+
+1.2.0:
+*  New gem: docgenerator_tools
+*  Move yaml2presentation from docgenerator to docgenerator_tools
+*  Creole_document makes tableofcontents for tex, not Creole#toc
+*  Add creole_rail.rb to docgenerator_tools
+*  Add rubycode4doc to docgenerator_tools
+*  Add code2structogramm to docgenerator_tools
+*  Add Creole-option :ignore
+*  Add Creole-option :comment
+*  Repair load-bug with usepackage
+*  Redefine pathes for privat and tools (check open)
+*  Add examples for docgenerator_tools
+*  Replace Document#runtex with rake4latex
+*  Add Versions to Classes...
+*  Reorganize unit tests
+*  Ruby 1.9 enabled
+
+1.2.1
+* 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

data/unittest/expected/test_document_usepackage_undefined.log

@@ -0,0 +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

data/unittest/expected/test_enumerate.context

@@ -0,0 +1,4 @@
+
+\startitemize[n]
+\item Listpunkt 1
+\stopitemize

data/unittest/expected/test_footnote.html

@@ -1,5 +1,5 @@
-<h1 >Abschnitt 1</h1>
-<p >Text zu Abschnitt 1<sup><a href="#footnote-1">1</a></sup>Weiterer Text</p>
-<h2 >Fu�noten</h2>
-<p ><sup ><a name="footnote-1">1</a></sup>Fu� eins<br />
+<h1 >Section 1</h1>
+<p >Text in section 1<sup><a href="#footnote-1">1</a></sup>More Text</p>
+<h2 >Footnotes</h2>
+<p ><sup ><a name="footnote-1">1</a></sup>Footnote one<br />
 </p>

data/unittest/expected/test_footnote.latex

@@ -1,11 +1,11 @@
-\section{Abschnitt 1}
+\section{Section 1}
 
 
-Text zu Abschnitt 1\footnote{Fu� eins}Weiterer Text
+Text in section 1\footnote{Footnote one}More Text
 
-\subsection{Fu�noten}
+\subsection{Footnotes}
 
 
-\textsuperscript{\label{footnote-1}\hypertarget{footnote-1}{1}}Fu� eins\newline 
+\textsuperscript{\label{footnote-1}\hypertarget{footnote-1}{1}}Footnote one\newline 
 
 

data/unittest/expected/test_footnote_group.html

@@ -1,8 +1,8 @@
-<h1 >Abschnitt 1</h1>
-<p >Text zu Abschnitt 1<sup><a href="#g2-1">1</a></sup>Weiterer Text<sup><a href="#footnote-1">1</a></sup></p>
-<h2 >Fu�noten</h2>
-<p ><sup ><a name="footnote-1">1</a></sup>Noch ne Fu�note<br />
+<h1 >Section 1</h1>
+<p >Text in section 1<sup><a href="#g2-1">1</a></sup>More Text<sup><a href="#footnote-1">1</a></sup></p>
+<h2 >Footnotes</h2>
+<p ><sup ><a name="footnote-1">1</a></sup>Again a footnote<br />
 </p>
-<h3 >Fu�noten g1</h3>
-<p ><sup ><a name="g2-1">1</a></sup>Fu� eins (g1)<br />
+<h3 >Footnotes of group 1</h3>
+<p ><sup ><a name="g2-1">1</a></sup>Footnote one (g1)<br />
 </p>

data/unittest/expected/test_footnote_group.latex

@@ -1,17 +1,17 @@
-\section{Abschnitt 1}
+\section{Section 1}
 
 
-Text zu Abschnitt 1\footnote{Fu� eins (g1)}Weiterer Text\footnote{Noch ne Fu�note}
+Text in section 1\footnote{Footnote one (g1)}More Text\footnote{Again a footnote}
 
-\subsection{Fu�noten}
+\subsection{Footnotes}
 
 
-\textsuperscript{\label{footnote-1}\hypertarget{footnote-1}{1}}Noch ne Fu�note\newline 
+\textsuperscript{\label{footnote-1}\hypertarget{footnote-1}{1}}Again a footnote\newline 
 
 
-\subsubsection{Fu�noten g1}
+\subsubsection{Footnotes of group 1}
 
 
-\textsuperscript{\label{g2-1}\hypertarget{g2-1}{1}}Fu� eins (g1)\newline 
+\textsuperscript{\label{g2-1}\hypertarget{g2-1}{1}}Footnote one (g1)\newline 
 
 

data/unittest/expected/test_href.html

@@ -1,2 +1,2 @@
-<p >Jetzt ein <a name="ilink">Ziel</a> f�r einen Link</p>
-<p >Und hier der Textlink zum <a href = "#ilink" >Ziel.</a></p>
+<p >Now a <a name="ilink">target</a> for a link</p>
+<p >And here the text link to  <a href = "#ilink" >target.</a></p>

data/unittest/expected/test_href.latex

@@ -1,8 +1,8 @@
 
 
-Jetzt ein \label{ilink}\hypertarget{ilink}{Ziel} f�r einen Link
+Now a \label{ilink}\hypertarget{ilink}{target} for a link
 
 
 
-Und hier der Textlink zum \hyperlink{ilink}{Ziel.}
+And here the text link to  \hyperlink{ilink}{target.}
 

data/unittest/expected/test_href.text

@@ -1,4 +1,4 @@
 
-Jetzt ein (ilink) Ziel f�r einen Link
+Now a (ilink) target for a link
 
-Und hier der Textlink zum Ziel. (#ilink)
+And here the text link to  target. (#ilink)

data/unittest/expected/test_itemize.context

@@ -0,0 +1,4 @@
+
+\startitemize[1]
+\item Listpunkt 1
+\stopitemize

data/unittest/expected/test_runtex.stdout

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

data/unittest/expected/test_runtex_2.stdout

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

data/unittest/expected/test_section.context

@@ -0,0 +1,20 @@
+\section{Abschnitt 1}
+
+
+Text zu Abschnitt 1
+
+\subsection{Abschnitt 1.1}
+
+
+Text zu Abschnitt 1.1
+
+\section{Abschnitt 2}
+
+
+Text zu Abschnitt 2
+
+\subsection{Abschnitt 2.1}
+
+
+Text zu Abschnitt 2.1
+

data/unittest/expected/test_tabular.html

@@ -1,7 +1,7 @@
 
 <table >
-<tr style = "border-bottom-style: solid;border-bottom-width: thick;" ><td colspan = "4" >Titel over all columns</td></tr>
-<tr style = "border-bottom-style: solid;border-bottom-width: thick;" ><td colspan = "4" >SubTitel over all columns</td></tr>
+<tr style = "border-bottom-style: solid;border-bottom-width: medium;" ><td colspan = "4" >Titel over all columns</td></tr>
+<tr style = "border-bottom-style: solid;border-bottom-width: medium;" ><td colspan = "4" >SubTitel over all columns</td></tr>
 <tr ><td >1A</td><td >1B</td><td >1C</td><td >1D</td></tr>
 <tr ><td >2A</td><td >2B</td><td >2C</td><td >2D</td></tr>
 <tr ><td >3A</td><td >3B</td><td >3C</td><td >3D</td></tr>

data/unittest/expected/test_verbatim.html

@@ -0,0 +1,3 @@
+<pre>Verbatim text
+second line
+</pre>

data/unittest/expected/test_verbatim.latex

@@ -0,0 +1,4 @@
+
+\begin{verbatim}Verbatim text
+second line
+\end{verbatim}

data/unittest/expected/test_verbatim_array.html

@@ -0,0 +1 @@
+<pre>Verbatimtextsecondline</pre>

data/unittest/expected/test_verbatim_array.latex

@@ -0,0 +1,2 @@
+
+\begin{verbatim}Verbatimtextsecondline\end{verbatim}

data/unittest/expected_creole/test_creole_characters_all.html

@@ -1,10 +1,17 @@
 <ul >
-<li >&lArr;  </li>
-<li >&rArr;  </li>
 <li >$  </li>
 <li >%  </li>
-<li >&larr;  </li>
-<li >&rarr;  </li>
 <li >&amp;  </li>
-<li >_</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>
 </ul>

data/unittest/expected_creole/test_creole_characters_all.latex

@@ -1,20 +1,34 @@
 
 \begin{itemize}
 
+\item \$  
+
+\item \%  
+
+\item \&  
+
+\item \ensuremath{\rightarrow}  
+
+\item \ensuremath{\leftarrow}  
+
 \item \ensuremath{\Lefttarrow}  
 
 \item \ensuremath{\Rightarrow}  
 
-\item \$  
+\item \_  
 
-\item \%  
+\item --  
 
-\item \ensuremath{\leftarrow}  
+\item ---  
 
-\item \ensuremath{\rightarrow}  
+\item ’  
 
-\item \&  
+\item \sbquo{}  
+
+\item ``  
+
+\item "  
 
-\item \_
+\item \ldots 
 \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_creole1.0test.html

@@ -33,10 +33,10 @@ Here's a external link without a description: <a href = "http://www.wikicreole.o
 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>   
+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.  
+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:  
@@ -116,7 +116,7 @@ You can also use it inline nowiki <span style = "display: inline;white-space:pre
 </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>   
+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>