docgenerator 2.0.0 → 2.1.0

data/meta_test_and_doc/manpages/others.rb

@@ -0,0 +1,129 @@
+#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::Style
+=end
+
+#
+module Docgenerator
+=begin rdoc
+=Docgenerator::Style
+
+Docgenerator::Style does not contain attributes
+
+
+Docgenerator::Style can contain content.
+
+==Generate an object
+  test = Docgenerator::Style.new( {}, 'content')
+
+Alternative generation
+  test = element(:style, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Style#to_latex
+  
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Style#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><<END>>
+
+* Docgenerator::Style#cr has no effect, same result as default
+* Docgenerator::Style#cR has no effect, same result as default
+* Docgenerator::Style#Cr has no effect, same result as default
+* Docgenerator::Style#CR has no effect, same result as default
+===Docgenerator::Style#to_html
+  <style type="text/css">
+  content</style>
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Style#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><style type="text/css">
+  content</style><<END>>
+
+* Result after Docgenerator::Style#cr:
+
+    <<START>><style type="text/css">
+    content</style>
+    <<END>>
+
+* Result after Docgenerator::Style#cR:
+
+    <<START>><style type="text/css">
+    content</style>
+    <<END>>
+
+* Result after Docgenerator::Style#Cr:
+
+    <<START>>
+    <style type="text/css">
+    content</style>
+    <<END>>
+
+* Result after Docgenerator::Style#CR:
+
+    <<START>>
+    <style type="text/css">
+    content</style>
+    <<END>>
+
+===Docgenerator::Style#to_context
+  \style{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Style#to_text
+  
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Style#.to_text
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><<END>>
+
+* Docgenerator::Style#cr has no effect, same result as default
+* Docgenerator::Style#cR has no effect, same result as default
+* Docgenerator::Style#Cr has no effect, same result as default
+* Docgenerator::Style#CR has no effect, same result as default
+===Docgenerator::Style#to_wiki
+  
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Style#.to_wiki
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><<END>>
+
+* Docgenerator::Style#cr has no effect, same result as default
+* Docgenerator::Style#cR has no effect, same result as default
+* Docgenerator::Style#Cr has no effect, same result as default
+* Docgenerator::Style#CR has no effect, same result as default
+===Docgenerator::Style#to_creole
+  
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Style#.to_creole
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><<END>>
+
+* Docgenerator::Style#cr has no effect, same result as default
+* Docgenerator::Style#cR has no effect, same result as default
+* Docgenerator::Style#Cr has no effect, same result as default
+* Docgenerator::Style#CR has no effect, same result as default
+=end
+  class Style << Docgenerator::Element
+  #This coding is empty - this is the manpage definition, not the implementation
+  end #class Style
+end #module Docgenerator

data/meta_test_and_doc/manpages/packages.rb

@@ -0,0 +1,13 @@
+=begin rdoc
+Generated manpages for elements.
+
+This document does not contain the implementation od code documentation.
+
+This document is the source for a manpage for usage of Docgenerator elements.
+
+The following Element are documented in this document:
+
+
+=end
+
+#

data/meta_test_and_doc/manpages/pdfpages.rb

@@ -0,0 +1,108 @@
+#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::IncludePDF
+=end
+
+#
+module Docgenerator
+  module Packages
+=begin rdoc
+=Docgenerator::Packages::IncludePDF
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  pages               :  -         -         -         X         -         -         -         -        
+  nup                 :  -         -         -         X         -         -         -         -        
+  landscape           :  -         -         -         X         -         -         -         -        
+  pagecommand         :  -         -         -         X         -         -         -         -        
+  link                :  -         -         -         X         -         -         -         -        
+  linkname            :  -         -         -         X         -         -         -         -        
+  linktodoc           :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::IncludePDF can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::IncludePDF.new( {
+       #:pages               => <<value>>, % optional, values: [String]
+       #:nup                 => <<value>>, % optional, values: [/\d+x\d+/]
+       #:landscape           => <<value>>, % optional, values: [true, false]
+       #:pagecommand         => <<value>>, % optional, values: [String]
+       #:link                => <<value>>, % optional, values: [true, false]
+       #:linkname            => <<value>>, % optional, values: [String]
+       #:linktodoc           => <<value>>, % optional, values: [true, false]
+      }, 'content')
+
+Alternative generation
+  test = element(:includepdf, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::IncludePDF#to_latex
+  \includepdf[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::IncludePDF#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\includepdf[]{content}<<END>>
+
+* Result after Docgenerator::Packages::IncludePDF#cr:
+
+    <<START>>\includepdf[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::IncludePDF#cR:
+
+    <<START>>\includepdf[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::IncludePDF#Cr:
+
+    <<START>>
+    \includepdf[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::IncludePDF#CR:
+
+    <<START>>
+    \includepdf[]{content}
+    <<END>>
+
+===Docgenerator::Packages::IncludePDF#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::IncludePDF#to_context
+  \includepdf{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::IncludePDF#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::IncludePDF#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::IncludePDF#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class IncludePDF << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class IncludePDF
+  end #module Packages
+end #module Docgenerator

data/meta_test_and_doc/manpages/readme.rdoc

@@ -0,0 +1,9 @@
+This is a generated manpage collection for docgenerator.
+
+Each *Element*-class of Docgenerator is analyzed for attributes and output.
+
+==:cr, :cR, :Cr, :CR for elements
+With Element#cr, Element#cR, Element#Cr, Element#CR you may influence 
+the code layout.
+
+The manpages show the different looks of the variants.

data/meta_test_and_doc/manpages/scrlettr2.rb

@@ -0,0 +1,362 @@
+#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::Letter::LoadLetterOption
+* Docgenerator::Packages::Letter::Setkomavar
+* Docgenerator::Packages::Letter::Letter
+=end
+
+#
+module Docgenerator
+  module Packages
+    module Letter
+=begin rdoc
+=Docgenerator::Packages::Letter::LoadLetterOption
+
+Docgenerator::Packages::Letter::LoadLetterOption does not contain attributes
+
+
+Docgenerator::Packages::Letter::LoadLetterOption can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Letter::LoadLetterOption.new( {}, 'content')
+
+Alternative generation
+  test = element(:loadletteroption, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Letter::LoadLetterOption#to_latex
+  \LoadLetterOption{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Letter::LoadLetterOption#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\LoadLetterOption{content}<<END>>
+
+* Result after Docgenerator::Packages::Letter::LoadLetterOption#cr:
+
+    <<START>>\LoadLetterOption{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::LoadLetterOption#cR:
+
+    <<START>>\LoadLetterOption{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::LoadLetterOption#Cr:
+
+    <<START>>
+    \LoadLetterOption{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::LoadLetterOption#CR:
+
+    <<START>>
+    \LoadLetterOption{content}
+    <<END>>
+
+===Docgenerator::Packages::Letter::LoadLetterOption#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Letter::LoadLetterOption#to_context
+  \loadletteroption{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Letter::LoadLetterOption#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Letter::LoadLetterOption#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Letter::LoadLetterOption#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class LoadLetterOption << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class LoadLetterOption
+    end #module Letter
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Letter
+=begin rdoc
+=Docgenerator::Packages::Letter::Setkomavar
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  field               :  X         -         X         -         -         -         -         -        
+  fieldtext           :  X         -         X         -         -         -         -         -        
+
+
+Docgenerator::Packages::Letter::Setkomavar can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Letter::Setkomavar.new( {
+        :field               => <<value>>, % required, values: [Symbol]
+        :fieldtext           => <<value>>, % required, values: [String]
+      }, 'content')
+
+Alternative generation
+  test = element(:setkomavar, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Letter::Setkomavar#to_latex
+  \setkomavar{Value for field}[Value for fieldtext]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Letter::Setkomavar#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\setkomavar{Value for field}[Value for fieldtext]{content}<<END>>
+
+* Result after Docgenerator::Packages::Letter::Setkomavar#cr:
+
+    <<START>>\setkomavar{Value for field}[Value for fieldtext]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Setkomavar#cR:
+
+    <<START>>\setkomavar{Value for field}[Value for fieldtext]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Setkomavar#Cr:
+
+    <<START>>
+    \setkomavar{Value for field}[Value for fieldtext]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Setkomavar#CR:
+
+    <<START>>
+    \setkomavar{Value for field}[Value for fieldtext]{content}
+    <<END>>
+
+===Docgenerator::Packages::Letter::Setkomavar#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Letter::Setkomavar#to_context
+  \setkomavar{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Letter::Setkomavar#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Letter::Setkomavar#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Letter::Setkomavar#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Setkomavar << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Setkomavar
+    end #module Letter
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Letter
+=begin rdoc
+=Docgenerator::Packages::Letter::Letter
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  address             :  X         -         X         -         -         -         -         -        
+  date                :  -         -         X         -         -         -         -         -        
+  opening             :  X         -         X         -         -         -         -         -        
+  letter_option       :  -         -         X         -         -         -         -         -        
+  backaddress         :  -         -         X         -         -         -         -         -        
+  customer            :  -         -         X         -         -         -         -         -        
+  fromaddress         :  -         -         X         -         -         -         -         -        
+  frombank            :  -         -         X         -         -         -         -         -        
+  fromemail           :  -         -         X         -         -         -         -         -        
+  fromfax             :  -         -         X         -         -         -         -         -        
+  fromlogo            :  -         -         X         -         -         -         -         -        
+  fromname            :  -         -         X         -         -         -         -         -        
+  fromphone           :  -         -         X         -         -         -         -         -        
+  fromurl             :  -         -         X         -         -         -         -         -        
+  invoice             :  -         -         X         -         -         -         -         -        
+  myref               :  -         -         X         -         -         -         -         -        
+  subject             :  -         -         X         -         -         -         -         -        
+  title               :  -         -         X         -         -         -         -         -        
+  signature           :  -         -         X         -         -         -         -         -        
+  closing             :  X         -         X         -         -         -         -         -        
+
+
+Docgenerator::Packages::Letter::Letter can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Letter::Letter.new( {
+        :address             => <<value>>, % required
+       #:date                => <<value>>, % optional, values: [String]
+        :opening             => <<value>>, % required
+       #:letter_option       => <<value>>, % optional
+       #:backaddress         => <<value>>, % optional
+       #:customer            => <<value>>, % optional
+       #:fromaddress         => <<value>>, % optional
+       #:frombank            => <<value>>, % optional
+       #:fromemail           => <<value>>, % optional
+       #:fromfax             => <<value>>, % optional
+       #:fromlogo            => <<value>>, % optional
+       #:fromname            => <<value>>, % optional
+       #:fromphone           => <<value>>, % optional
+       #:fromurl             => <<value>>, % optional
+       #:invoice             => <<value>>, % optional
+       #:myref               => <<value>>, % optional
+       #:subject             => <<value>>, % optional
+       #:title               => <<value>>, % optional
+       #:signature           => <<value>>, % optional
+        :closing             => <<value>>, % required
+      }, 'content')
+
+Alternative generation
+  test = element(:letter, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Letter::Letter#to_latex
+  
+  \begin{letter}{Value for address}
+  \date{}
+  \opening{Value for opening}
+  content
+  \closing{Value for closing}
+  \end{letter}
+
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Letter::Letter#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>
+  \begin{letter}{Value for address}
+  \date{}
+  \opening{Value for opening}
+  content
+  \closing{Value for closing}
+  \end{letter}
+  <<END>>
+
+* Result after Docgenerator::Packages::Letter::Letter#cr:
+
+    <<START>>
+    \begin{letter}{Value for address}
+    \date{}
+    \opening{Value for opening}
+    content
+    \closing{Value for closing}
+    \end{letter}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Letter#cR:
+
+    <<START>>
+    \begin{letter}{Value for address}
+    \date{}
+    \opening{Value for opening}
+    content
+    \closing{Value for closing}
+    \end{letter}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Letter#Cr:
+
+    <<START>>
+    
+    \begin{letter}{Value for address}
+    \date{}
+    \opening{Value for opening}
+    content
+    \closing{Value for closing}
+    \end{letter}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Letter::Letter#CR:
+
+    <<START>>
+    
+    \begin{letter}{Value for address}
+    \date{}
+    \opening{Value for opening}
+    content
+    \closing{Value for closing}
+    \end{letter}
+    
+    <<END>>
+
+===Docgenerator::Packages::Letter::Letter#to_html
+  
+  <div >
+  <p >An<br />Value for address<br /></p><p >Value for opening</p>content<p >Value for closing</p>
+  </div>
+
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Letter::Letter#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>
+  <div >
+  <p >An<br />Value for address<br /></p><p >Value for opening</p>content<p >Value for closing</p>
+  </div>
+  <<END>>
+
+* Docgenerator::Packages::Letter::Letter#cr has no effect, same result as default
+* Docgenerator::Packages::Letter::Letter#cR has no effect, same result as default
+* Docgenerator::Packages::Letter::Letter#Cr has no effect, same result as default
+* Docgenerator::Packages::Letter::Letter#CR has no effect, same result as default
+===Docgenerator::Packages::Letter::Letter#to_context
+  \letter{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Letter::Letter#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Letter::Letter#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Letter::Letter#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Letter << Docgenerator::Environments::Environment
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Letter
+    end #module Letter
+  end #module Packages
+end #module Docgenerator