docgenerator 1.2.1 → 2.0.0

data/lib/docgenerator/tabular.rb

@@ -3,6 +3,12 @@
 Definition of tabular elements for DocGenerator.rb
 =end
 
+#
+module Docgenerator
+=begin rdoc
+Definition of tabular elements for DocGenerator.rb
+=end
+module Tables
 #~ if __FILE__ == $0
 	#~ require 'DocGenerator' 
 #~ end
@@ -12,38 +18,38 @@ TEX_PACKAGE_TABULARX	= element(:usepackage,{},'tabularx').cr
 TEX_PACKAGE_LONGTABLE= element(:usepackage,{},'longtable').cr
 TEX_PACKAGE_BOOKTABS	= element(:usepackage,{},'booktabs').cr
 
-class Table < Environment
-	add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:table ],  Table)
-	def htmltag(); 'div'; end
+=begin rdoc
+Environment Table
+=end
+class Table < Environments::Environment
+	add_attributes HTML_ATTR_ALL 
+	add_html_tag 'div'
 	def to_latex( options={} )
 		return to_latex_environment( 'table', nil, options )
 	end
 end
+=begin rdoc
+Tabulars
 
-#Tabulars
-#fixme:  check on attributes. columnsdescription
-#~ :table=> {:border=>nil, :width=>nil, :cellpadding=>nil, :cellspacing=>nil},#complete it
-#~ :colgroup => {}, #comlpete it
+fixme:  check on attributes. columnsdescription
+~ :table=> {:border=>nil, :width=>nil, :cellpadding=>nil, :cellspacing=>nil},#complete it
+~ :colgroup => {}, #comlpete it
+=end
 class Tabular < Element
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:tabular],  Tabular )
-	#~ add_attributes( HTML_ATTR_ALL ) 
+	add_attributes HTML_ATTR_ALL
 	#Problem: Nicht weitervererbt
-	add_attributes( {
-		:columndescription	=>  Attribute.create( [:latex, :required ] ) ,
-		:columns			=>  Attribute.create( [:required], [ Fixnum ] ) ,
-		:border			=>  Attribute.create( [:html] ) ,
-		:bgcolor			=> Attribute.create( [ :html ] ),
-		:width			=> Attribute.create( [ :html ], [ Integer, String ] ),	#String necessary for percentage
-		:frame			=> Attribute.create( [ :html ], [ 'box', 'above', 'below', 'hsides', 'vsides', 'lhs', 'rhs' ] ),
-		:rules			=> Attribute.create( [ :html ], [ 'none', 'rows', 'cols', 'groups', 'all' ] ),
-		:height			=> Attribute.create( [ :html ], [ Integer ] ),
-		:cellspacing		=> Attribute.create( [ :html ], [ Integer ] ),
-		:cellpadding		=> Attribute.create( [ :html ], [ Integer ] ),
-		:summary			=> Attribute.create( [:html] ) ,
-		:align			=> HTML_ATTR_ALIGN,
-	}.update( HTML_ATTR_ALL ) )
+	add_attribute	:columndescription	,  Attribute.create( [:latex, :required ] ) 
+	add_attribute	:columns			,  Attribute.create( [:required], [ Fixnum ] ) 
+	add_attribute	:border			,  Attribute.create( [:html] ) 
+	add_attribute	:bgcolor			, Attribute.create( [ :html ] )
+	add_attribute	:width			, Attribute.create( [ :html ], [ Integer, String ] )	#String necessary for percentage
+	add_attribute	:frame			, Attribute.create( [ :html ], [ 'box', 'above', 'below', 'hsides', 'vsides', 'lhs', 'rhs' ] )
+	add_attribute	:rules			, Attribute.create( [ :html ], [ 'none', 'rows', 'cols', 'groups', 'all' ] )
+	add_attribute	:height			, Attribute.create( [ :html ], [ Integer ] )
+	add_attribute	:cellspacing		, Attribute.create( [ :html ], [ Integer ] )
+	add_attribute	:cellpadding		, Attribute.create( [ :html ], [ Integer ] )
+	add_attribute	:summary			, Attribute.create( [:html] ) 
+	add_attribute	:align			, HTML_ATTR_ALIGN
 	#Only rows are allowed to be added.
 	#The row get the number of columns.
 	#The row counting does not word, when the row-content is added immediate in element-initialization.
@@ -58,7 +64,7 @@ class Tabular < Element
 			end
 		}
 		if ! allowed
-			puts "Add non-row to tabular (#{row.class})"
+			@log.warn("Add non-row to tabular (#{row.class})") if @log.warn?
 		end
 		if row.is_a?( Row )
 			row.columns = @attr[:columns].to_s.to_i
@@ -66,7 +72,7 @@ class Tabular < Element
 		@content << row
 	end
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for tabular") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -88,15 +94,16 @@ class Tabular < Element
     return "<Class Element(tabular) columns=#{@attr[:columns]}>"
   end
 end
-#Requires
-#	doc.head	<< element(:usepackage,{},'longtable')
+=begin rdoc
+Use longtable-package.
+
+Requires
+	doc.head	<< element(:usepackage,{},'longtable')
+=end
 class Longtable < Tabular
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:longtable],  Longtable )
-	#
-	add_attributes( Element.get_attribute_list( Tabular ) )
+	add_attributes Tabular.get_attribute_list( )
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for longtable") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -110,16 +117,19 @@ class Longtable < Tabular
 		return cmd
 	end
 end
-#Requires
-#	doc.head	<< element(:usepackage,{},'longtable')
-#fixme :width is obligatory
+=begin rdoc
+Use Tabularx-package.
+
+Requires
+	doc.head	<< element(:usepackage,{},'longtable')
+
+fixme :width is obligatory
+=end
 class Tabularx < Tabular
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:tabularx],  Tabularx )
 	#
-	add_attributes( Element.get_attribute_list( Tabular ) )
+	add_attributes Tabular.get_attribute_list( )
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for tabularx") if o[:log].debug?
 		if @attr[:width].content.to_s == ''
 			o[:log].error( "Tabularx: Empty width, set it to \\textwidth" ) if o[:log].error?
@@ -139,12 +149,13 @@ class Tabularx < Tabular
 		return cmd
 	end
 end
-#May only be used insode a tabular. Tabular must set the columns-value. 
-#If not, zero columns is expected and an error is thrown.
-class Row < Element
+=begin rdoc
+May only be used insode a tabular. Tabular must set the columns-value. 
 
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:row, :tr],  Row )
+If not, zero columns is expected and an error is thrown.
+=end
+class Row < Element
+  add_id :tr
 	#~ :tr	=> {:align=>align},#complete it
 	add_attributes( {
 			:add_vspace	=>  Attribute.create( [:latex] ) ,
@@ -176,7 +187,7 @@ class Row < Element
 	def cline( val )
 		@cline = [] if ! defined?( @cline )
 		if ! ( /\A\d+-\d+\z/  =~ val )
-			puts "\\cline with wrong parameter: #{val.inspect}"
+			@log.warn("\\cline with wrong parameter: #{val.inspect}") if @log.warn?
 		end
 		@cline	<< val
 		return self
@@ -188,7 +199,7 @@ class Row < Element
 	def cmidrule( val )
 		@cmidrule = [] if ! defined?( @cmidrule )
 		if ! ( /\A\d+-\d+\z/  =~ val )
-			puts "\\cmidrule with wrong parameter: #{val.inspect}"
+			@log.warn("\\cmidrule with wrong parameter: #{val.inspect}") if @log.warn?
 		end
 		@cmidrule	<< val
 		return self
@@ -216,22 +227,23 @@ class Row < Element
 			end
 		}
 		if ! allowed
-			puts "Add non-column to tabular (#{row.class})"
+			@log.warn("Add non-column to tabular (#{row.class})") if @log.warn?
 		end
 		@content << row
 		#Does not work with multicolumns.
 		if !@columns
-			puts "Add row to tabular with undefined columns number (#{row.inspect})" 
+			@log.warn("Add row to tabular with undefined columns number (#{row.inspect})" ) if @log.warn?
 		elsif @content.size > @columns 
-			puts "Tabular with #{@columns} columns get #{@content.size} columns" 
+			@log.warn("Tabular with #{@columns} columns get #{@content.size} columns" ) if @log.warn?
 		end
 	end
+  
 	def inspect()
-		return "<Class Row columns=#{@content.size}>"
+		return "<Class Row columns=#{@content.size}#{inspect_creation_caller}>"
 	end
 	#Each cell is separated by '&'.
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for row") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -263,7 +275,7 @@ class Row < Element
 		return 'tr'
 	end
 	def to_html(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_html for row") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -302,55 +314,139 @@ class Row < Element
   def to_wiki(options={}); return "\n|-\n#{@content.to_wiki(options).strip}"; end
 end #Row
 
-Element.create( [:hline ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\hline '
-	} )
-Element.create( [:toprule ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\toprule'
-	} )
-Element.create( [:midrule ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\midrule'
-	} )
-Element.create( [:bottomrule ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\bottomrule'
-	} )
-Element.create( [:endfirsthead  ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\endfirsthead '
-	} )
-Element.create( [:endhead  ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\endhead '
-	} )
-Element.create( [:endfoot ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\endfoot'
-	} )
-Element.create( [:endlastfoot ], {},false, 
-	{	:htmltag	=> nil,
-		:latex	=> '\endlastfoot'
-	} )
-#~ @cline.each{|cline|	cmd	<< "\\cline{#{cline}}"	} if @cline
+=begin rdoc
+Define Element :hline
+
+Create an instance with
+  element( :hline, [ attributes, [content]] )
+or
+  Hline.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Hline < Element
+  has_no_content false
+  add_latex_output '\hline '
+end #Hline
+
+=begin rdoc
+Define Element :toprule
+
+Create an instance with
+  element( :toprule, [ attributes, [content]] )
+or
+  Toprule.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Toprule < Element
+  has_no_content false
+  add_latex_output '\toprule'
+end #Toprule
+
+=begin rdoc
+Define Element :midrule
+
+Create an instance with
+  element( :midrule, [ attributes, [content]] )
+or
+  Midrule.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Midrule < Element
+  has_no_content false
+  add_latex_output '\midrule '
+end #Midrule
+
+=begin rdoc
+Define Element :bottomrule
+
+Create an instance with
+  element( :bottomrule, [ attributes, [content]] )
+or
+  Bottomrule.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Bottomrule < Element
+  has_no_content false
+  add_latex_output '\bottomrule '
+end #Bottomrule
+
+=begin rdoc
+Define Element :endfirsthead
+
+Create an instance with
+  element( :endfirsthead, [ attributes, [content]] )
+or
+  Endfirsthead.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Endfirsthead < Element
+  has_no_content false
+  add_latex_output '\endfirsthead '
+end #Endfirsthead
+
+=begin rdoc
+Define Element :endhead
+
+Create an instance with
+  element( :endhead, [ attributes, [content]] )
+or
+  Endhead.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Endhead < Element
+  has_no_content false
+  add_latex_output '\endhead '
+end #Endhead
 
+=begin rdoc
+Define Element :endfoot
 
-#One column in a tabular.
+Create an instance with
+  element( :endfoot, [ attributes, [content]] )
+or
+  Endfoot.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Endfoot < Element
+  has_no_content false
+  add_html_tag nil
+  add_latex_output '\endfoot '
+  
+end #Endfoot
+
+=begin rdoc
+Define Element :endlastfoot
+
+Create an instance with
+  element( :endlastfoot, [ attributes, [content]] )
+or
+  Endlastfoot.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Endlastfoot < Element
+  has_no_content false
+  add_html_tag nil
+  add_latex_output '\endlastfoot '
+end #Endlastfoot
+
+=begin rdoc
+A column in a tabular.
+=end
 class Column < Element
-	#Make the key known to the complete key-list of elements.
+  has_no_content :empty_ok
+
+  add_id :col
+  add_id :td
+	add_attributes HTML_ATTR_ALL
+	
 #~ :th	=> {:colspan => nil, :rowspan => nil, :align=>align, :valign=>valign, :border=>nil, :width=>nil},#complete it
-	Element.add( [:col, :column, :td ],  Column )
-	add_attributes( HTML_ATTR_ALL )
-	add_attributes( { 
-		:width 	=> Attribute.create( [ :html ] ),
-		:height 		=> Attribute.create( [ :html ] ),
-		:align 	=> HTML_ATTR_ALIGN,
-		:bgcolor	=> Attribute.create( [ :html ] ),
-	} )
+	add_attribute	:width 	, Attribute.create( [ :html ] )
+	add_attribute	:height 		, Attribute.create( [ :html ] )
+	add_attribute	:align 	, HTML_ATTR_ALIGN
+	add_attribute	:bgcolor	, Attribute.create( [ :html ] )
+  
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for column") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -368,17 +464,20 @@ class Column < Element
 		return "<Class Column @content=#{@content.inspect}>"
 	end
 end #Columns
-#Header cell (only for HTML
+=begin rdoc
+Header cell (only for HTML)
+=end
 class Column_th < Column
-	Element.add( [:th ],  Column_th )
-	def htmltag()
-		return 'th'
-	end
+	add_id :th
+	add_html_tag 'th'
 end
+=begin rdoc
+Multicolumn 
+=end
 class Multicolumn < Column
-	#Make the key known to the complete key-list of elements.
-	Element.add( [:multicolumn],  Multicolumn )
-	#~ add_attributes( HTML_ATTR_ALL ) 
+  has_no_content :empty_ok
+
+#~ add_attributes( HTML_ATTR_ALL ) 
 	add_attributes( { 
 		#~ :columns	=>  Attribute.create( [:required], [ Fixnum ] ) ,	#colspan
 		:colspan	=> 	Attribute.create( [:required, :html, :latex], [ Fixnum ], 2 ) ,
@@ -390,7 +489,7 @@ class Multicolumn < Column
 		:height 	=> Attribute.create( [ :html ] ),
 	}.update( HTML_ATTR_ALL ) ) 
 	def to_latex(options={})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     o[:log].debug("enter to_latex for multicolumn") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
@@ -398,20 +497,37 @@ class Multicolumn < Column
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
+  #add_html_output -> like Column, :colspan is obligatory
   def to_text(options={}); return "#{@content.to_text(options).strip}\n"; end
   def to_wiki(options={}); return "|columns=#{@attr[:colspan]}|pos=#{@attr[:pos]}||#{@content.to_wiki(options).strip}\n"; end
-	#~ def htmltag()
-		#~ return 'td'
-	#~ end
-	#~ def to_html()
-		#~ cmd	=	''
-		#~ cmd	+=	"\n" if @crbefore
-		#~ cmd	+= 	"<td colspan=\"#{@attr[:columns]}\">"
-		#~ cmd	+= "#{@content}</td>"
-		#~ cmd	+=	"\n" if @crafter
-		#~ return cmd
-	#~ end
+  
+  #
 	def inspect()
 		return "<Class Multicolumn @content=#{@content.inspect}>"
 	end
 end
+
+class Caption < Element
+	#
+	add_attribute :optional, Attribute.create( [ :latex ] )
+  
+	def to_latex(options= {})
+		cmd	=	''
+		cmd	<<	"\n" if @crbefore
+		cmd	<<	"\\caption"
+		if @attr[:optional].content != []
+			cmd	<<	"["
+			cmd	<<	@attr[:optional].content.to_s
+			cmd	<<	"]"
+			cmd	<<	"\n\t" if @crmid
+		end
+		cmd	<<	"{"
+		cmd	<< @content.to_s
+		cmd	<<	"}"
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end
+end
+
+end #module Tab
+end #module Docgenerator