docgenerator 2.0.0 → 2.1.0

data/meta_test_and_doc/manpages/footnote.rb

@@ -0,0 +1,439 @@
+#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::Elements::Footnotesize
+* Docgenerator::Footnote
+* Docgenerator::Footnotemark
+=end
+
+#
+module Docgenerator
+  module Elements
+=begin rdoc
+=Docgenerator::Elements::Footnotesize
+
+Docgenerator::Elements::Footnotesize does not contain attributes
+
+
+Docgenerator::Elements::Footnotesize can contain content.
+
+==Generate an object
+  test = Docgenerator::Elements::Footnotesize.new( {}, 'content')
+
+Alternative generation
+  test = element(:footnotesize, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Elements::Footnotesize#to_latex
+  {\footnotesize  content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Footnotesize#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>{\footnotesize  content}<<END>>
+
+* Result after Docgenerator::Elements::Footnotesize#cr:
+
+    <<START>>{\footnotesize  content}
+    <<END>>
+
+* Result after Docgenerator::Elements::Footnotesize#cR:
+
+    <<START>>{\footnotesize  content}
+    <<END>>
+
+* Result after Docgenerator::Elements::Footnotesize#Cr:
+
+    <<START>>
+    {\footnotesize  content}
+    <<END>>
+
+* Result after Docgenerator::Elements::Footnotesize#CR:
+
+    <<START>>
+    {\footnotesize  content}
+    <<END>>
+
+===Docgenerator::Elements::Footnotesize#to_html
+  <span style="font-size:x-small">content</span>
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Elements::Footnotesize#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><span style="font-size:x-small">content</span><<END>>
+
+* Docgenerator::Elements::Footnotesize#cr has no effect, same result as default
+* Docgenerator::Elements::Footnotesize#cR has no effect, same result as default
+* Docgenerator::Elements::Footnotesize#Cr has no effect, same result as default
+* Docgenerator::Elements::Footnotesize#CR has no effect, same result as default
+===Docgenerator::Elements::Footnotesize#to_context
+  \footnotesize{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Elements::Footnotesize#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Elements::Footnotesize#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Elements::Footnotesize#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Footnotesize << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Footnotesize
+  end #module Elements
+end #module Docgenerator
+module Docgenerator
+=begin rdoc
+=Docgenerator::Footnote
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  lang                :  -         X         -         -         -         -         -         -        
+  id                  :  -         X         -         -         -         -         -         -        
+  class               :  -         X         -         -         -         -         -         -        
+  style               :  -         X         -         -         -         -         -         -        
+  title               :  -         X         -         -         -         -         -         -        
+  dir                 :  -         X         -         -         -         -         -         -        
+  onclick             :  -         X         -         -         -         -         -         -        
+  ondblclick          :  -         X         -         -         -         -         -         -        
+  onmousedown         :  -         X         -         -         -         -         -         -        
+  onmouseup           :  -         X         -         -         -         -         -         -        
+  onmouseover         :  -         X         -         -         -         -         -         -        
+  onmousemove         :  -         X         -         -         -         -         -         -        
+  onmouseout          :  -         X         -         -         -         -         -         -        
+  onkeypress          :  -         X         -         -         -         -         -         -        
+  onkeyup             :  -         X         -         -         -         -         -         -        
+  onkeydown           :  -         X         -         -         -         -         -         -        
+  label               :  -         -         -         -         -         -         -         -        
+  group               :  X         -         -         -         -         -         -         -        
+
+
+Docgenerator::Footnote can contain content.
+
+==Generate an object
+  test = Docgenerator::Footnote.new( {
+       #:lang                => <<value>>, % optional, values: ["en", "de"]
+       #:id                  => <<value>>, % optional
+       #:class               => <<value>>, % optional
+       #:style               => <<value>>, % optional, values: [Docgenerator::CSS, String]
+       #:title               => <<value>>, % optional
+       #:dir                 => <<value>>, % optional, values: ["ltr", "rtl"]
+       #:onclick             => <<value>>, % optional
+       #:ondblclick          => <<value>>, % optional
+       #:onmousedown         => <<value>>, % optional
+       #:onmouseup           => <<value>>, % optional
+       #:onmouseover         => <<value>>, % optional
+       #:onmousemove         => <<value>>, % optional
+       #:onmouseout          => <<value>>, % optional
+       #:onkeypress          => <<value>>, % optional
+       #:onkeyup             => <<value>>, % optional
+       #:onkeydown           => <<value>>, % optional
+       #:label               => <<value>>, % optional
+        :group               => <<value>>, % required, values: [Docgenerator::Footnotegroup]
+      }, 'content')
+
+Alternative generation
+  test = element(:footnote, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Footnote#to_latex
+  \footnote{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnote#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\footnote{content}<<END>>
+
+* Result after Docgenerator::Footnote#cr:
+
+    <<START>>\footnote{content}
+    <<END>>
+
+* Result after Docgenerator::Footnote#cR:
+
+    <<START>>\footnote{content}
+    <<END>>
+
+* Result after Docgenerator::Footnote#Cr:
+
+    <<START>>
+    \footnote{content}
+    <<END>>
+
+* Result after Docgenerator::Footnote#CR:
+
+    <<START>>
+    \footnote{content}
+    <<END>>
+
+===Docgenerator::Footnote#to_html
+  <sup><a href="#footnote-1">1</a></sup>
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnote#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><sup><a href="#footnote-1">1</a></sup><<END>>
+
+* Result after Docgenerator::Footnote#cr:
+
+    <<START>><sup><a href="#footnote-1">1</a></sup>
+    <<END>>
+
+* Result after Docgenerator::Footnote#cR:
+
+    <<START>><sup><a href="#footnote-1">1</a></sup>
+    <<END>>
+
+* Result after Docgenerator::Footnote#Cr:
+
+    <<START>>
+    <sup><a href="#footnote-1">1</a></sup>
+    <<END>>
+
+* Result after Docgenerator::Footnote#CR:
+
+    <<START>>
+    <sup><a href="#footnote-1">1</a></sup>
+    <<END>>
+
+===Docgenerator::Footnote#to_context
+  \footnote{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Footnote#to_text
+  (1)
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnote#.to_text
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>(1)<<END>>
+
+* Result after Docgenerator::Footnote#cr:
+
+    <<START>>(1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#cR:
+
+    <<START>>(1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#Cr:
+
+    <<START>>
+    (1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#CR:
+
+    <<START>>
+    (1)
+    <<END>>
+
+===Docgenerator::Footnote#to_wiki
+  (1)
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnote#.to_wiki
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>(1)<<END>>
+
+* Result after Docgenerator::Footnote#cr:
+
+    <<START>>(1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#cR:
+
+    <<START>>(1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#Cr:
+
+    <<START>>
+    (1)
+    <<END>>
+
+* Result after Docgenerator::Footnote#CR:
+
+    <<START>>
+    (1)
+    <<END>>
+
+===Docgenerator::Footnote#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+  class Footnote << Docgenerator::Element
+  #This coding is empty - this is the manpage definition, not the implementation
+  end #class Footnote
+end #module Docgenerator
+module Docgenerator
+=begin rdoc
+=Docgenerator::Footnotemark
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  lang                :  -         X         -         -         -         -         -         -        
+  id                  :  -         X         -         -         -         -         -         -        
+  class               :  -         X         -         -         -         -         -         -        
+  style               :  -         X         -         -         -         -         -         -        
+  title               :  -         X         -         -         -         -         -         -        
+  dir                 :  -         X         -         -         -         -         -         -        
+  onclick             :  -         X         -         -         -         -         -         -        
+  ondblclick          :  -         X         -         -         -         -         -         -        
+  onmousedown         :  -         X         -         -         -         -         -         -        
+  onmouseup           :  -         X         -         -         -         -         -         -        
+  onmouseover         :  -         X         -         -         -         -         -         -        
+  onmousemove         :  -         X         -         -         -         -         -         -        
+  onmouseout          :  -         X         -         -         -         -         -         -        
+  onkeypress          :  -         X         -         -         -         -         -         -        
+  onkeyup             :  -         X         -         -         -         -         -         -        
+  onkeydown           :  -         X         -         -         -         -         -         -        
+
+
+Docgenerator::Footnotemark can contain content.
+
+==Generate an object
+  test = Docgenerator::Footnotemark.new( {
+       #:lang                => <<value>>, % optional, values: ["en", "de"]
+       #:id                  => <<value>>, % optional
+       #:class               => <<value>>, % optional
+       #:style               => <<value>>, % optional, values: [Docgenerator::CSS, String]
+       #:title               => <<value>>, % optional
+       #:dir                 => <<value>>, % optional, values: ["ltr", "rtl"]
+       #:onclick             => <<value>>, % optional
+       #:ondblclick          => <<value>>, % optional
+       #:onmousedown         => <<value>>, % optional
+       #:onmouseup           => <<value>>, % optional
+       #:onmouseover         => <<value>>, % optional
+       #:onmousemove         => <<value>>, % optional
+       #:onmouseout          => <<value>>, % optional
+       #:onkeypress          => <<value>>, % optional
+       #:onkeyup             => <<value>>, % optional
+       #:onkeydown           => <<value>>, % optional
+      }, 'content')
+
+Alternative generation
+  test = element(:footnotemark, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Footnotemark#to_latex
+  \footnotemark[content]
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnotemark#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\footnotemark[content]<<END>>
+
+* Result after Docgenerator::Footnotemark#cr:
+
+    <<START>>\footnotemark[content]
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#cR:
+
+    <<START>>\footnotemark[content]
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#Cr:
+
+    <<START>>
+    \footnotemark[content]
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#CR:
+
+    <<START>>
+    \footnotemark[content]
+    <<END>>
+
+===Docgenerator::Footnotemark#to_html
+  <sup >content</sup>
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Footnotemark#.to_html
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><sup >content</sup><<END>>
+
+* Result after Docgenerator::Footnotemark#cr:
+
+    <<START>><sup >content</sup>
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#cR:
+
+    <<START>><sup >
+    content
+    </sup>
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#Cr:
+
+    <<START>>
+    <sup >
+    content
+    </sup>
+    <<END>>
+
+* Result after Docgenerator::Footnotemark#CR:
+
+    <<START>>
+    <sup >
+    content
+    </sup>
+    <<END>>
+
+===Docgenerator::Footnotemark#to_context
+  \footnotemark{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Footnotemark#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Footnotemark#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Footnotemark#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+  class Footnotemark << Docgenerator::Element
+  #This coding is empty - this is the manpage definition, not the implementation
+  end #class Footnotemark
+end #module Docgenerator