docgenerator 2.1.0 → 2.1.1

data/meta_test_and_doc/manpages/others.rb

@@ -9,6 +9,11 @@ This document is the source for a manpage for usage of Docgenerator elements.
 The following Element are documented in this document:
 
 * Docgenerator::Style
+* Docgenerator::Index::Index
+* Docgenerator::Index::Makeindex
+* Docgenerator::Index::Printindex
+* Docgenerator::Index::Newindex
+* Docgenerator::Index::Sindex
 =end
 
 #
@@ -126,4 +131,402 @@ Default:
   class Style << Docgenerator::Element
   #This coding is empty - this is the manpage definition, not the implementation
   end #class Style
+end #module Docgenerator
+module Docgenerator
+  module Index
+=begin rdoc
+=Docgenerator::Index::Index
+
+Docgenerator::Index::Index does not contain attributes
+
+
+Docgenerator::Index::Index can contain content.
+
+==Generate an object
+  test = Docgenerator::Index::Index.new( {}, 'content')
+
+Alternative generation
+  test = element(:index, {}, 'content' )
+
+
+==Outputs
+===Docgenerator::Index::Index#to_latex
+  \index{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Index::Index#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\index{content}<<END>>
+
+* Result after Docgenerator::Index::Index#cr:
+
+    <<START>>\index{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Index#cR:
+
+    <<START>>\index{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Index#Cr:
+
+    <<START>>
+    \index{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Index#CR:
+
+    <<START>>
+    \index{content}
+    <<END>>
+
+===Docgenerator::Index::Index#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Index::Index#to_context
+  \index{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Index::Index#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Index::Index#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Index::Index#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Index << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Index
+  end #module Index
+end #module Docgenerator
+module Docgenerator
+  module Index
+=begin rdoc
+=Docgenerator::Index::Makeindex
+
+Docgenerator::Index::Makeindex does not contain attributes
+
+
+Docgenerator::Index::Makeindex allows no content.
+
+==Generate an object
+  test = Docgenerator::Index::Makeindex.new( )
+
+Alternative generation
+  test = element(:makeindex)
+
+
+==Outputs
+===Docgenerator::Index::Makeindex#to_latex
+  \makeindex 
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Index::Makeindex#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\makeindex <<END>>
+
+* Result after Docgenerator::Index::Makeindex#cr:
+
+    <<START>>\makeindex 
+    <<END>>
+
+* Result after Docgenerator::Index::Makeindex#cR:
+
+    <<START>>\makeindex 
+    <<END>>
+
+* Result after Docgenerator::Index::Makeindex#Cr:
+
+    <<START>>
+    \makeindex 
+    <<END>>
+
+* Result after Docgenerator::Index::Makeindex#CR:
+
+    <<START>>
+    \makeindex 
+    <<END>>
+
+===Docgenerator::Index::Makeindex#to_html
+  <span />
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Index::Makeindex#to_context
+  \makeindex{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Index::Makeindex#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Index::Makeindex#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Index::Makeindex#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Makeindex << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Makeindex
+  end #module Index
+end #module Docgenerator
+module Docgenerator
+  module Index
+=begin rdoc
+=Docgenerator::Index::Printindex
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  subindex            :  -         -         X         -         -         -         -         -        
+
+
+Docgenerator::Index::Printindex allows no content.
+
+==Generate an object
+  test = Docgenerator::Index::Printindex.new( {
+       #:subindex            => <<value>>, % optional
+      })
+
+Alternative generation
+  test = element(:printindex, {...Attributes...})
+
+
+==Outputs
+===Docgenerator::Index::Printindex#to_latex
+  
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Index::Printindex#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>><<END>>
+
+* Result after Docgenerator::Index::Printindex#cr:
+
+    <<START>>
+    <<END>>
+
+* Result after Docgenerator::Index::Printindex#cR:
+
+    <<START>>
+    <<END>>
+
+* Result after Docgenerator::Index::Printindex#Cr:
+
+    <<START>>
+    <<END>>
+
+* Result after Docgenerator::Index::Printindex#CR:
+
+    <<START>>
+    <<END>>
+
+===Docgenerator::Index::Printindex#to_html
+  <span />
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Index::Printindex#to_context
+  \printindex{}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Index::Printindex#to_text
+  
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Index::Printindex#to_wiki
+  
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Index::Printindex#to_creole
+  
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Printindex << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Printindex
+  end #module Index
+end #module Docgenerator
+module Docgenerator
+  module Index
+=begin rdoc
+=Docgenerator::Index::Newindex
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  subname             :  X         -         X         -         -         -         -         -        
+
+
+Docgenerator::Index::Newindex can contain content.
+
+==Generate an object
+  test = Docgenerator::Index::Newindex.new( {
+        :subname             => <<value>>, % required
+      }, 'content')
+
+Alternative generation
+  test = element(:newindex, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Index::Newindex#to_latex
+  \newindex[Value for subname]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Index::Newindex#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\newindex[Value for subname]{content}<<END>>
+
+* Result after Docgenerator::Index::Newindex#cr:
+
+    <<START>>\newindex[Value for subname]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Newindex#cR:
+
+    <<START>>\newindex[Value for subname]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Newindex#Cr:
+
+    <<START>>
+    \newindex[Value for subname]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Newindex#CR:
+
+    <<START>>
+    \newindex[Value for subname]{content}
+    <<END>>
+
+===Docgenerator::Index::Newindex#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Index::Newindex#to_context
+  \newindex{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Index::Newindex#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Index::Newindex#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Index::Newindex#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Newindex << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Newindex
+  end #module Index
+end #module Docgenerator
+module Docgenerator
+  module Index
+=begin rdoc
+=Docgenerator::Index::Sindex
+
+==Attributes
+  Attribute             required? HTML      LaTeX     ~keyval   ConTeXt   Text      Wiki      Creole    Values    
+  ====================================================================================================
+  subindex            :  X         -         X         -         -         -         -         -        
+
+
+Docgenerator::Index::Sindex can contain content.
+
+==Generate an object
+  test = Docgenerator::Index::Sindex.new( {
+        :subindex            => <<value>>, % required
+      }, 'content')
+
+Alternative generation
+  test = element(:sindex, {...Attributes...}, 'content' )
+
+
+==Outputs
+===Docgenerator::Index::Sindex#to_latex
+  \sindex[Value for subindex]{content}
+
+====:cr, :cR, :Cr, :CR for Docgenerator::Index::Sindex#.to_latex
+<<START>> and <<END>> are not part of the output, but needed to illustrate the line breaks.
+
+Default:
+  <<START>>\sindex[Value for subindex]{content}<<END>>
+
+* Result after Docgenerator::Index::Sindex#cr:
+
+    <<START>>\sindex[Value for subindex]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Sindex#cR:
+
+    <<START>>\sindex[Value for subindex]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Sindex#Cr:
+
+    <<START>>
+    \sindex[Value for subindex]{content}
+    <<END>>
+
+* Result after Docgenerator::Index::Sindex#CR:
+
+    <<START>>
+    \sindex[Value for subindex]{content}
+    <<END>>
+
+===Docgenerator::Index::Sindex#to_html
+  <span >content</span>
+
+* No output routine defined for html - use a dummy
+===Docgenerator::Index::Sindex#to_context
+  \sindex{content}
+
+* No output routine defined for context - use a dummy
+===Docgenerator::Index::Sindex#to_text
+  content
+
+* No output routine defined for text - use a dummy
+===Docgenerator::Index::Sindex#to_wiki
+  content
+
+
+* No output routine defined for wiki - use a dummy
+===Docgenerator::Index::Sindex#to_creole
+  content
+
+
+* No output routine defined for creole - use a dummy
+=end
+    class Sindex << Docgenerator::Element
+    #This coding is empty - this is the manpage definition, not the implementation
+    end #class Sindex
+  end #module Index
 end #module Docgenerator

data/meta_test_and_doc/manpages/pdfpages.rb

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

data/meta_test_and_doc/manpages/readme.rdoc

@@ -1,8 +1,10 @@
+=Generated Manpages
+
 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
+===:cr, :cR, :Cr, :CR for elements
 With Element#cr, Element#cR, Element#Cr, Element#CR you may influence 
 the code layout.