docgenerator 2.0.0 → 2.1.0

data/meta_test_and_doc/manpages/hyperref.rb

@@ -0,0 +1,605 @@
+#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::Hyperref::HyperrefForm
+* Docgenerator::Packages::Hyperref::Reset
+* Docgenerator::Packages::Hyperref::Checkbox
+* Docgenerator::Packages::Hyperref::Pushbutton
+* Docgenerator::Packages::Hyperref::Choicemenu
+* Docgenerator::Packages::Hyperref::Textfield
+=end
+
+#
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::HyperrefForm
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  options             :  -         -         X         -         -         -         -         -        
+
+
+Docgenerator::Packages::Hyperref::HyperrefForm can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::HyperrefForm.new( {
+       #:options             => <<value>>, % optional, values: [nil]
+      }, 'content')
+
+Alternative generation
+  test = element(:hyperrefform, {...Attributes...}, 'content' )
+  test = element(:Form, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_latex
+  
+  \begin{Form}content\end{Form}
+
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::HyperrefForm#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>
+  \begin{Form}content\end{Form}
+  <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::HyperrefForm#cr:
+
+    <<START>>
+    \begin{Form}content\end{Form}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::HyperrefForm#cR:
+
+    <<START>>
+    \begin{Form}
+    content
+    \end{Form}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::HyperrefForm#Cr:
+
+    <<START>>
+    
+    \begin{Form}
+    content
+    \end{Form}
+    
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::HyperrefForm#CR:
+
+    <<START>>
+    
+    \begin{Form}
+    content
+    \end{Form}
+    
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_context
+  \Form{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::HyperrefForm#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class HyperrefForm << Docgenerator::Environments::Environment
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class HyperrefForm
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::Reset
+
+Docgenerator::Packages::Hyperref::Reset does not contain attributes
+
+
+Docgenerator::Packages::Hyperref::Reset can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::Reset.new( {}, 'content')
+
+Alternative generation
+  test = element(:reset, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::Reset#to_latex
+  \Reset{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::Reset#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\Reset{content}<<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Reset#cr:
+
+    <<START>>\Reset{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Reset#cR:
+
+    <<START>>\Reset{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Reset#Cr:
+
+    <<START>>
+    \Reset{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Reset#CR:
+
+    <<START>>
+    \Reset{content}
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::Reset#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::Reset#to_context
+  \reset{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::Reset#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::Reset#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::Reset#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Reset << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Reset
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::Checkbox
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  name                :  -         -         -         X         -         -         -         -        
+  checked             :  -         -         -         X         -         -         -         -        
+  onblur              :  -         -         -         X         -         -         -         -        
+  onclick             :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Hyperref::Checkbox can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::Checkbox.new( {
+       #:name                => <<value>>, % optional
+       #:checked             => <<value>>, % optional, values: [true, false]
+       #:onblur              => <<value>>, % optional
+       #:onclick             => <<value>>, % optional
+      }, 'content')
+
+Alternative generation
+  test = element(:checkbox, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::Checkbox#to_latex
+  \CheckBox[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::Checkbox#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\CheckBox[]{content}<<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Checkbox#cr:
+
+    <<START>>\CheckBox[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Checkbox#cR:
+
+    <<START>>\CheckBox[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Checkbox#Cr:
+
+    <<START>>
+    \CheckBox[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Checkbox#CR:
+
+    <<START>>
+    \CheckBox[]{content}
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::Checkbox#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::Checkbox#to_context
+  \checkbox{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::Checkbox#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::Checkbox#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::Checkbox#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Checkbox << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Checkbox
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::Pushbutton
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  width               :  -         -         -         X         -         -         -         -        
+  height              :  -         -         -         X         -         -         -         -        
+  borderstyle         :  -         -         -         X         -         -         -         -        
+  bordercolor         :  -         -         -         X         -         -         -         -        
+  color               :  -         -         -         X         -         -         -         -        
+  backgroundcolor     :  -         -         -         X         -         -         -         -        
+  onclick             :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Hyperref::Pushbutton can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::Pushbutton.new( {
+       #:width               => <<value>>, % optional
+       #:height              => <<value>>, % optional
+       #:borderstyle         => <<value>>, % optional, values: ["S", "D", "B", "I", "U"]
+       #:bordercolor         => <<value>>, % optional
+       #:color               => <<value>>, % optional
+       #:backgroundcolor     => <<value>>, % optional
+       #:onclick             => <<value>>, % optional
+      }, 'content')
+
+Alternative generation
+  test = element(:pushbutton, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::Pushbutton#to_latex
+  \PushButton[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::Pushbutton#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\PushButton[]{content}<<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Pushbutton#cr:
+
+    <<START>>\PushButton[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Pushbutton#cR:
+
+    <<START>>\PushButton[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Pushbutton#Cr:
+
+    <<START>>
+    \PushButton[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Pushbutton#CR:
+
+    <<START>>
+    \PushButton[]{content}
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::Pushbutton#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::Pushbutton#to_context
+  \pushbutton{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::Pushbutton#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::Pushbutton#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::Pushbutton#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Pushbutton << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Pushbutton
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::Choicemenu
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  width               :  -         -         -         X         -         -         -         -        
+  height              :  -         -         -         X         -         -         -         -        
+  borderstyle         :  -         -         -         X         -         -         -         -        
+  bordercolor         :  -         -         -         X         -         -         -         -        
+  color               :  -         -         -         X         -         -         -         -        
+  backgroundcolor     :  -         -         -         X         -         -         -         -        
+  name                :  X         -         -         -         -         -         -         -        
+  onblur              :  -         -         -         X         -         -         -         -        
+  default             :  -         -         -         X         -         -         -         -        
+  type                :  -         -         -         -         -         -         -         -        
+
+
+Docgenerator::Packages::Hyperref::Choicemenu can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::Choicemenu.new( {
+       #:width               => <<value>>, % optional
+       #:height              => <<value>>, % optional
+       #:borderstyle         => <<value>>, % optional, values: ["S", "D", "B", "I", "U"]
+       #:bordercolor         => <<value>>, % optional
+       #:color               => <<value>>, % optional
+       #:backgroundcolor     => <<value>>, % optional
+        :name                => <<value>>, % required
+       #:onblur              => <<value>>, % optional
+       #:default             => <<value>>, % optional
+       #:type                => <<value>>, % optional, values: ["combo", "radiobutton"]
+      }, 'content')
+
+Alternative generation
+  test = element(:choicemenu, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::Choicemenu#to_latex
+  \ChoiceMenu[,]{Value for name}{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::Choicemenu#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\ChoiceMenu[,]{Value for name}{content}<<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Choicemenu#cr:
+
+    <<START>>\ChoiceMenu[,]{Value for name}{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Choicemenu#cR:
+
+    <<START>>\ChoiceMenu[,]{Value for name}{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Choicemenu#Cr:
+
+    <<START>>
+    \ChoiceMenu[,]{Value for name}{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Choicemenu#CR:
+
+    <<START>>
+    \ChoiceMenu[,]{Value for name}{content}
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::Choicemenu#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::Choicemenu#to_context
+  \choicemenu{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::Choicemenu#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::Choicemenu#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::Choicemenu#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Choicemenu << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Choicemenu
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator
+module Docgenerator
+  module Packages
+    module Hyperref
+=begin rdoc
+=Docgenerator::Packages::Hyperref::Textfield
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  name                :  -         -         -         X         -         -         -         -        
+  password            :  -         -         -         X         -         -         -         -        
+  width               :  -         -         -         X         -         -         -         -        
+  height              :  -         -         -         X         -         -         -         -        
+  align               :  -         -         -         X         -         -         -         -        
+  borderstyle         :  -         -         -         X         -         -         -         -        
+  bordercolor         :  -         -         -         X         -         -         -         -        
+  backgroundcolor     :  -         -         -         X         -         -         -         -        
+  color               :  -         -         -         X         -         -         -         -        
+  multiline           :  -         -         -         X         -         -         -         -        
+  readonly            :  -         -         -         X         -         -         -         -        
+  hidden              :  -         -         -         X         -         -         -         -        
+  value               :  -         -         -         X         -         -         -         -        
+  validate            :  -         -         -         X         -         -         -         -        
+  format              :  -         -         -         X         -         -         -         -        
+  onclick             :  -         -         -         X         -         -         -         -        
+  onblur              :  -         -         -         X         -         -         -         -        
+
+
+Docgenerator::Packages::Hyperref::Textfield can contain content.
+
+==Generate an object
+  test = Docgenerator::Packages::Hyperref::Textfield.new( {
+       #:name                => <<value>>, % optional, values: [String, Symbol]
+       #:password            => <<value>>, % optional
+       #:width               => <<value>>, % optional
+       #:height              => <<value>>, % optional
+       #:align               => <<value>>, % optional, values: [0, 1, 2]
+       #:borderstyle         => <<value>>, % optional, values: ["S", "D", "B", "I", "U"]
+       #:bordercolor         => <<value>>, % optional
+       #:backgroundcolor     => <<value>>, % optional
+       #:color               => <<value>>, % optional
+       #:multiline           => <<value>>, % optional, values: [true, false]
+       #:readonly            => <<value>>, % optional, values: [true, false]
+       #:hidden              => <<value>>, % optional, values: [true, false]
+       #:value               => <<value>>, % optional, values: [String, Array]
+       #:validate            => <<value>>, % optional, values: [String, Array]
+       #:format              => <<value>>, % optional, values: [String, Array]
+       #:onclick             => <<value>>, % optional
+       #:onblur              => <<value>>, % optional
+      }, 'content')
+
+Alternative generation
+  test = element(:textfield, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Packages::Hyperref::Textfield#to_latex
+  \TextField[]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Packages::Hyperref::Textfield#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\TextField[]{content}<<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Textfield#cr:
+
+    <<START>>\TextField[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Textfield#cR:
+
+    <<START>>\TextField[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Textfield#Cr:
+
+    <<START>>
+    \TextField[]{content}
+    <<END>>
+
+* Result after Docgenerator::Packages::Hyperref::Textfield#CR:
+
+    <<START>>
+    \TextField[]{content}
+    <<END>>
+
+===Docgenerator::Packages::Hyperref::Textfield#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Packages::Hyperref::Textfield#to_context
+  \textfield{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Packages::Hyperref::Textfield#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Packages::Hyperref::Textfield#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Packages::Hyperref::Textfield#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+      class Textfield << Docgenerator::Element
+      #This coding is empty - this is the manpage definition, not the implementation
+      end #class Textfield
+    end #module Hyperref
+  end #module Packages
+end #module Docgenerator