docgenerator 2.0.0 → 2.1.0

data/meta_test_and_doc/manpages/attachfile.rb

@@ -0,0 +1,389 @@
+#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::Attachfile::Attachfile
+* Docgenerator::Packages::Attachfile::Noattachfile
+* Docgenerator::Packages::Attachfile::Textattachfile
+* Docgenerator::Packages::Attachfile::Notextattachfile
+=end
+
+#
+module Docgenerator
+  module Packages
+    module Attachfile
+=begin rdoc
+=Docgenerator::Packages::Attachfile::Attachfile
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  author              :  -         -         -         X         -         -         -         -        
+  description         :  -         -         -         X         -         -         -         -        
+  subject             :  -         -         -         X         -         -         -         -        
+  icon                :  -         -         -         X         -         -         -         -        
+  mimetype            :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Attachfile::Attachfile can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Attachfile::Attachfile.new( {
+       #:author              => <<value>>, % optional, values: [String]
+       #:description         => <<value>>, % optional, values: [String]
+       #:subject             => <<value>>, % optional, values: [String]
+       #:icon                => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
+       #:mimetype            => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
+      }, 'content')
+
+Alternative generation
+  test = element(:attachfile, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Attachfile::Attachfile#to_latex
+  \attachfile[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Attachfile#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\attachfile[]{content}<<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Attachfile#cr:
+
+    <<START>>\attachfile[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Attachfile#cR:
+
+    <<START>>\attachfile[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Attachfile#Cr:
+
+    <<START>>
+    \attachfile[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Attachfile#CR:
+
+    <<START>>
+    \attachfile[]{content}
+    <<END>>
+
+===Docgenerator::Packages::Attachfile::Attachfile#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Attachfile::Attachfile#to_context
+  \attachfile{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Attachfile::Attachfile#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Attachfile::Attachfile#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Attachfile::Attachfile#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Attachfile << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Attachfile
+    end #module Attachfile
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Attachfile
+=begin rdoc
+=Docgenerator::Packages::Attachfile::Noattachfile
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  author              :  -         -         -         X         -         -         -         -        
+  description         :  -         -         -         X         -         -         -         -        
+  subject             :  -         -         -         X         -         -         -         -        
+  icon                :  -         -         -         X         -         -         -         -        
+  mimetype            :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Attachfile::Noattachfile allows no content.
+
+==Generate an object
+  test = Docgenerator::Packages::Attachfile::Noattachfile.new( {
+       #:author              => <<value>>, % optional, values: [String]
+       #:description         => <<value>>, % optional, values: [String]
+       #:subject             => <<value>>, % optional, values: [String]
+       #:icon                => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
+       #:mimetype            => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
+      })
+
+Alternative generation
+  test = element(:noattachfile, {...Attributes...})
+
+
+==Outputs
+===Docgenerator::Packages::Attachfile::Noattachfile#to_latex
+  \noattachfile[]
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Noattachfile#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\noattachfile[]<<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Noattachfile#cr:
+
+    <<START>>\noattachfile[]
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Noattachfile#cR:
+
+    <<START>>\noattachfile[]
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Noattachfile#Cr:
+
+    <<START>>
+    \noattachfile[]
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Noattachfile#CR:
+
+    <<START>>
+    \noattachfile[]
+    <<END>>
+
+===Docgenerator::Packages::Attachfile::Noattachfile#to_html
+  <span />
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Attachfile::Noattachfile#to_context
+  \noattachfile{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Attachfile::Noattachfile#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Attachfile::Noattachfile#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Attachfile::Noattachfile#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Noattachfile << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Noattachfile
+    end #module Attachfile
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Attachfile
+=begin rdoc
+=Docgenerator::Packages::Attachfile::Textattachfile
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  author              :  -         -         -         X         -         -         -         -        
+  description         :  -         -         -         X         -         -         -         -        
+  subject             :  -         -         -         X         -         -         -         -        
+  icon                :  -         -         -         X         -         -         -         -        
+  mimetype            :  -         -         -         X         -         -         -         -        
+  text                :  -         -         -         -         -         -         -         -        
+
+
+Docgenerator::Packages::Attachfile::Textattachfile can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Attachfile::Textattachfile.new( {
+       #:author              => <<value>>, % optional, values: [String]
+       #:description         => <<value>>, % optional, values: [String]
+       #:subject             => <<value>>, % optional, values: [String]
+       #:icon                => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
+       #:mimetype            => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
+       #:text                => <<value>>, % optional, values: [String]
+      }, 'content')
+
+Alternative generation
+  test = element(:textattachfile, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Attachfile::Textattachfile#to_latex
+  \textattachfile[]{content}{}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Textattachfile#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\textattachfile[]{content}{}<<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Textattachfile#cr:
+
+    <<START>>\textattachfile[]{content}{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Textattachfile#cR:
+
+    <<START>>\textattachfile[]{content}{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Textattachfile#Cr:
+
+    <<START>>
+    \textattachfile[]{content}{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Textattachfile#CR:
+
+    <<START>>
+    \textattachfile[]{content}{}
+    <<END>>
+
+===Docgenerator::Packages::Attachfile::Textattachfile#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Attachfile::Textattachfile#to_context
+  \textattachfile{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Attachfile::Textattachfile#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Attachfile::Textattachfile#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Attachfile::Textattachfile#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Textattachfile << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Textattachfile
+    end #module Attachfile
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Attachfile
+=begin rdoc
+=Docgenerator::Packages::Attachfile::Notextattachfile
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  author              :  -         -         -         X         -         -         -         -        
+  description         :  -         -         -         X         -         -         -         -        
+  subject             :  -         -         -         X         -         -         -         -        
+  icon                :  -         -         -         X         -         -         -         -        
+  mimetype            :  -         -         -         X         -         -         -         -        
+  text                :  -         -         -         -         -         -         -         -        
+
+
+Docgenerator::Packages::Attachfile::Notextattachfile allows no content.
+
+==Generate an object
+  test = Docgenerator::Packages::Attachfile::Notextattachfile.new( {
+       #:author              => <<value>>, % optional, values: [String]
+       #:description         => <<value>>, % optional, values: [String]
+       #:subject             => <<value>>, % optional, values: [String]
+       #:icon                => <<value>>, % optional, values: ["Graph", "Paperclip", "PushPin", "Tag"]
+       #:mimetype            => <<value>>, % optional, values: ["text/plain", "video/mpeg"]
+       #:text                => <<value>>, % optional, values: [String]
+      })
+
+Alternative generation
+  test = element(:notextattachfile, {...Attributes...})
+
+
+==Outputs
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_latex
+  \notextattachfile[]{}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Attachfile::Notextattachfile#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\notextattachfile[]{}<<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Notextattachfile#cr:
+
+    <<START>>\notextattachfile[]{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Notextattachfile#cR:
+
+    <<START>>\notextattachfile[]{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Notextattachfile#Cr:
+
+    <<START>>
+    \notextattachfile[]{}
+    <<END>>
+
+* Result after Docgenerator::Packages::Attachfile::Notextattachfile#CR:
+
+    <<START>>
+    \notextattachfile[]{}
+    <<END>>
+
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_html
+  <span />
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_context
+  \notextattachfile{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Attachfile::Notextattachfile#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Notextattachfile << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Notextattachfile
+    end #module Attachfile
+  end #module Packages
+end #module Docgenerator

data/meta_test_and_doc/manpages/caption.rb

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