docgenerator 2.0.0 → 2.1.0

data/meta_test_and_doc/manpages/todonotes.rb

@@ -0,0 +1,235 @@
+#encoding utf-8
+=begin rdoc
+Generated manpages for elements.
+
+This document does not contain the implementation or code documentation.
+
+This document is the source for a manpage for usage of Docgenerator elements.
+
+The following Element are documented in this document:
+
+* Docgenerator::Packages::Todonotes::Todo
+* Docgenerator::Packages::Todonotes::Missingfigure
+* Docgenerator::Packages::Todonotes::Listoftodos
+=end
+
+#
+module Docgenerator
+  module Packages
+    module Todonotes
+=begin rdoc
+=Docgenerator::Packages::Todonotes::Todo
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  color               :  -         -         -         X         -         -         -         -        
+  backgroundcolor     :  -         -         -         X         -         -         -         -        
+  linecolor           :  -         -         -         X         -         -         -         -        
+  bordercolor         :  -         -         -         X         -         -         -         -        
+  inline              :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Todonotes::Todo can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Todonotes::Todo.new( {
+       #:color               => <<value>>, % optional, values: [String]
+       #:backgroundcolor     => <<value>>, % optional, values: [String]
+       #:linecolor           => <<value>>, % optional, values: [String]
+       #:bordercolor         => <<value>>, % optional, values: [String]
+       #:inline              => <<value>>, % optional, values: [true, false]
+      }, 'content')
+
+Alternative generation
+  test = element(:todo, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Todonotes::Todo#to_latex
+  \todo[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Todonotes::Todo#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\todo[]{content}<<END>>
+
+* Result after Docgenerator::Packages::Todonotes::Todo#cr:
+
+    <<START>>\todo[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Todonotes::Todo#cR:
+
+    <<START>>\todo[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Todonotes::Todo#Cr:
+
+    <<START>>
+    \todo[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Todonotes::Todo#CR:
+
+    <<START>>
+    \todo[]{content}
+    <<END>>
+
+===Docgenerator::Packages::Todonotes::Todo#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Todonotes::Todo#to_context
+  \todo{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Todonotes::Todo#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Todonotes::Todo#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Todonotes::Todo#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Todo << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Todo
+    end #module Todonotes
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Todonotes
+=begin rdoc
+=Docgenerator::Packages::Todonotes::Missingfigure
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  figwidth            :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Todonotes::Missingfigure can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Todonotes::Missingfigure.new( {
+       #:figwidth            => <<value>>, % optional, values: [Integer, String]
+      }, 'content')
+
+Alternative generation
+  test = element(:missingfigure, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Todonotes::Missingfigure#to_latex
+  \missingfigure{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Todonotes::Missingfigure#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\missingfigure{content}<<END>>
+
+* Docgenerator::Packages::Todonotes::Missingfigure#cr has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Missingfigure#cR has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Missingfigure#Cr has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Missingfigure#CR has no effect, same result as default
+===Docgenerator::Packages::Todonotes::Missingfigure#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Todonotes::Missingfigure#to_context
+  \missingfigure{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Todonotes::Missingfigure#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Todonotes::Missingfigure#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Todonotes::Missingfigure#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Missingfigure << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Missingfigure
+    end #module Todonotes
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Todonotes
+=begin rdoc
+=Docgenerator::Packages::Todonotes::Listoftodos
+
+Docgenerator::Packages::Todonotes::Listoftodos does not contain attributes
+
+
+Docgenerator::Packages::Todonotes::Listoftodos allows no content.
+
+==Generate an object
+  test = Docgenerator::Packages::Todonotes::Listoftodos.new( )
+
+Alternative generation
+  test = element(:listoftodos)
+
+
+==Outputs
+===Docgenerator::Packages::Todonotes::Listoftodos#to_latex
+  \listoftodos 
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Todonotes::Listoftodos#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\listoftodos <<END>>
+
+* Docgenerator::Packages::Todonotes::Listoftodos#cr has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Listoftodos#cR has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Listoftodos#Cr has no effect, same result as default
+* Docgenerator::Packages::Todonotes::Listoftodos#CR has no effect, same result as default
+===Docgenerator::Packages::Todonotes::Listoftodos#to_html
+  <span />
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Todonotes::Listoftodos#to_context
+  \listoftodos{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Todonotes::Listoftodos#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Todonotes::Listoftodos#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Todonotes::Listoftodos#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Listoftodos << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Listoftodos
+    end #module Todonotes
+  end #module Packages
+end #module Docgenerator

data/meta_test_and_doc/manpages/wiki2docgenerator.rb

@@ -0,0 +1,64 @@
+#encoding utf-8
+=begin rdoc
+Generated manpages for elements.
+
+This document does not contain the implementation or code documentation.
+
+This document is the source for a manpage for usage of Docgenerator elements.
+
+The following Element are documented in this document:
+
+* Docgenerator::Wikimedia::WikiCollectorHTML
+=end
+
+#
+module Docgenerator
+  module Wikimedia
+=begin rdoc
+=Docgenerator::Wikimedia::WikiCollectorHTML
+
+Docgenerator::Wikimedia::WikiCollectorHTML does not contain attributes
+
+
+Docgenerator::Wikimedia::WikiCollectorHTML can contain content.
+
+==Generate an object
+  test = Docgenerator::Wikimedia::WikiCollectorHTML.new( {}, 'content')
+
+Alternative generation
+  test = element(:wikicollectorhtml, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_latex
+  \wikicollectorhtml{content}
+
+* No output routine defined for latex - use a dummy
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_context
+  \wikicollectorhtml{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Wikimedia::WikiCollectorHTML#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class WikiCollectorHTML << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class WikiCollectorHTML
+  end #module Wikimedia
+end #module Docgenerator

data/{readme.rd → readme.rdoc}

@@ -134,9 +134,26 @@ Generation of calendars and event lists.
 * add creole2doc_example.rb
 * add todonotes support (only LaTeX)
 
-2.0.0
+2.0.0 2011-04-29
 * Pack everything in module Docgenerator
 * Group classes to modules
 * clean up lib-folder
 * docgenerator_tools integrated in docgenerator (and docgenerator4presentation-gem)
 
+2.1.0 2012-06-16
+* Encoding:
+  * Switch templates to UTF-8
+  * enable encoding for templates + unittest_templates.rb
+* Creole
+  * Correction Creole#toc
+  * Add parameter Creole#new logname
+  * new: Creole_longtable
+  * Correction implicit HTTP (Use \url instead href)
+  * to_creole for tables implemented
+* Document.new: 
+  * option latex_option (replacement for Document#add_option)
+  * option logname 
+* Correction element caption
+* href: change internal links
+* element li: add type
+

data/unittest/expected/test_tabular.creole

@@ -0,0 +1,33 @@
+<<<tabular
+|!columns=4
+|!columndescription=cccc
+|-
+|Titel over all columns||columns=4|pos=c
+|-
+|SubTitel over all columns||columns=4|pos=c
+|-
+|1A
+|1B
+|1C
+|1D
+|-
+|2A
+|2B
+|2C
+|2D
+|-
+|3A
+|3B
+|3C
+|3D
+|-
+|4A
+|4B
+|4C
+|4D
+|-
+|5A
+|5B
+|5C
+|5D
+>>>

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>  

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

@@ -42,11 +42,11 @@ Be careful that italic links are rendered properly: \emph{\href{http://my.book.e
 
 
 
-Free links without braces should be rendered as well, like \href{http://www.wikicreole.org/}{http://www.wikicreole.org/}  and \href{http://www.wikicreole.org/users/~example.}{http://www.wikicreole.org/users/~example.}    
+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 \href{http://bar}{http://bar}  and ftp:\emph{bar should not render italic,something like foo:}bar should render as italic.  
+Creole1.0 specifies that \url{http://bar}  and ftp:\emph{bar should not render italic,something like foo:}bar should render as italic.  
 
 
 
@@ -178,7 +178,7 @@ You can also use it inline nowiki \verb| in a sentence | like this.
 \section{ Escapes }
 
 
-Normal Link: \href{http://wikicreole.org/}{http://wikicreole.org/}  - now same link, but escaped: ~\href{http://wikicreole.org/}{http://wikicreole.org/}    
+Normal Link: \url{http://wikicreole.org/}  - now same link, but escaped: ~\url{http://wikicreole.org/}    
 
 
 

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

@@ -55,9 +55,9 @@ Here's a external link without a description: http://www.wikicreole.org (http://
 
 Be careful that italic links are rendered properly: My Book Title (http://my.book.example/)    
 
-Free links without braces should be rendered as well, like http://www.wikicreole.org/ (http://www.wikicreole.org/)  and http://www.wikicreole.org/users/~example. (http://www.wikicreole.org/users/~example.)    
+Free links without braces should be rendered as well, like http://www.wikicreole.org/  and http://www.wikicreole.org/users/~example.    
 
-Creole1.0 specifies that http://bar (http://bar)  and ftp:bar should not render italic,something like foo:bar should render as italic.  
+Creole1.0 specifies that http://bar  and ftp: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:  
 -------------------------
@@ -103,7 +103,7 @@ You can also use it inline nowiki  in a sentence  like this.
     ------------------------------
 
 
-Normal Link: http://wikicreole.org/ (http://wikicreole.org/)  - now same link, but escaped: ~http://wikicreole.org/ (http://wikicreole.org/)    
+Normal Link: http://wikicreole.org/  - now same link, but escaped: ~http://wikicreole.org/    
 
 Normal asterisks: ~not bold~  
 

data/unittest/expected_creole/test_creole_inline_apostroph.html

@@ -0,0 +1,6 @@
+<p >
+You can add text "in apostoph".  
+</p>
+<p >
+Problem may be german.sty and activated " like in "a.  It will be converted to an a-Umlaut.  
+</p>

data/unittest/expected_creole/test_creole_inline_apostroph.latex

@@ -0,0 +1,8 @@
+
+
+You can add text "in apostoph".  
+
+
+
+Problem may be german.sty and activated " like in "a.  It will be converted to an a-Umlaut.  
+

data/unittest/expected_creole/test_creole_inline_apostroph.text

@@ -0,0 +1,4 @@
+
+You can add text "in apostoph".  
+
+Problem may be german.sty and activated " like in "a.  It will be converted to an a-Umlaut.  

data/unittest/expected_creole/test_creole_input.normsource

@@ -1,23 +1,23 @@
 --- 
 - !ruby/struct:Creole_line 
-  :type: :dummy
-  :content: 
-  :add_info: 
+  type: :dummy
+  content: 
+  add_info: 
 - !ruby/struct:Creole_line 
-  :type: :par
-  :content: |
+  type: :par
+  content: |
     Text,
     more Text.
     And some more text.
 
-  :add_info: 
+  add_info: 
 - !ruby/struct:Creole_line 
-  :type: :dummy
-  :content: 
-  :add_info: 
+  type: :dummy
+  content: 
+  add_info: 
 - !ruby/struct:Creole_line 
-  :type: :par
-  :content: |
+  type: :par
+  content: |
     A new paragraph.
 
-  :add_info: 
+  add_info: 

data/unittest/expected_creole/test_creole_input.normsource_1.8

@@ -0,0 +1,23 @@
+--- 
+- !ruby/struct:Creole_line 
+  :type: :dummy
+  :content: 
+  :add_info: 
+- !ruby/struct:Creole_line 
+  :type: :par
+  :content: |
+    Text,
+    more Text.
+    And some more text.
+
+  :add_info: 
+- !ruby/struct:Creole_line 
+  :type: :dummy
+  :content: 
+  :add_info: 
+- !ruby/struct:Creole_line 
+  :type: :par
+  :content: |
+    A new paragraph.
+
+  :add_info: 

data/unittest/expected_creole/test_creole_links_external_implicit.html

@@ -1,8 +1,8 @@
 <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 >
-See also description: <a href = "http://www.wikicreole.org/wiki/Links" >http://www.wikicreole.org/wiki/Links</a>  
+See also description: <a href = "http://www.wikicreole.org/wiki/Links">http://www.wikicreole.org/wiki/Links</a>  
 </p>
 <p >
 In case of phrase ends with . you should use explicit links like  <a href = "http://www.wikicreole.org/users/~example" >http://www.wikicreole.org/users/~example</a>.  

data/unittest/expected_creole/test_creole_links_external_implicit.latex

@@ -1,10 +1,10 @@
 
 
-Free links without braces should be rendered as well, like \href{http://www.wikicreole.org/}{http://www.wikicreole.org/}  and \href{http://www.wikicreole.org/users/~example}{http://www.wikicreole.org/users/~example}.  
+Free links without braces should be rendered as well, like \url{http://www.wikicreole.org/}  and \href{http://www.wikicreole.org/users/~example}{http://www.wikicreole.org/users/~example}.  
 
 
 
-See also description: \href{http://www.wikicreole.org/wiki/Links}{http://www.wikicreole.org/wiki/Links}  
+See also description: \url{http://www.wikicreole.org/wiki/Links}  
 
 
 

data/unittest/expected_creole/test_creole_links_external_implicit.text

@@ -1,6 +1,6 @@
 
-Free links without braces should be rendered as well, like http://www.wikicreole.org/ (http://www.wikicreole.org/)  and http://www.wikicreole.org/users/~example (http://www.wikicreole.org/users/~example).  
+Free links without braces should be rendered as well, like http://www.wikicreole.org/  and http://www.wikicreole.org/users/~example (http://www.wikicreole.org/users/~example).  
 
-See also description: http://www.wikicreole.org/wiki/Links (http://www.wikicreole.org/wiki/Links)  
+See also description: http://www.wikicreole.org/wiki/Links  
 
 In case of phrase ends with . you should use explicit links like  http://www.wikicreole.org/users/~example (http://www.wikicreole.org/users/~example).  

data/unittest/expected_creole/test_creole_links_implicit_end.html

@@ -1,3 +1,3 @@
 <p >
-<a href = "http://www.wikicreole.org/users/~example" >http://www.wikicreole.org/users/~example</a>
+<a href = "http://www.wikicreole.org/users/~example">http://www.wikicreole.org/users/~example</a>
 </p>

data/unittest/expected_creole/test_creole_links_implicit_end.latex

@@ -1,4 +1,4 @@
 
 
-\href{http://www.wikicreole.org/users/~example}{http://www.wikicreole.org/users/~example}
+\url{http://www.wikicreole.org/users/~example}