docgenerator 0.1.1 → 1.0.2

data/{docgenerator_sections.rb → lib/docgenerator_sections.rb}

@@ -25,7 +25,7 @@ sect = Struct.new( 'Sections', :keys, :wiki, :html, :tex )
 ].each{ |s|
 	Element.create( s.keys,	{
 		:short	=> Attribute.create( [ :latex ] ),
-	}.update( HTML_ATTR_ALL),	true, 
+	}.update( HTML_ATTR_ALL ),	true, 
 		{	:htmltag	=> s.html,
 			#~ :latex	=> '#{linebreak(@crbefore)}' + "\\#{s.tex}" + '{#{@content}}#{linebreak(@crafter)}',
 			:latex	=>	'#{linebreak(@crbefore)}'	+ "\\#{s.tex}" + 
@@ -33,7 +33,7 @@ sect = Struct.new( 'Sections', :keys, :wiki, :html, :tex )
 								'{#{@content}}' +
 								'#{hypertarget(@attr[:id])}' +
 								'#{linebreak(@crafter)}',
-			:text	=> "\n" + '#{linebreak(@before)}#{@content}' + "\n" + 
+			:text	=> "\n" + '#{linebreak(@crbefore)}#{@content}' + "\n" + 
 								' ' * s.wiki * 2 + '-' * 30 + "\n"  + '#{linebreak(@crafter)}',
 			:wiki	=> '#{linebreak(@crbefore)}' + "\n" + '='* (s.wiki ) + '#{@content}' + '='* (s.wiki) + "\n" + '#{linebreak(@crafter)}',
 		} )

data/{docgenerator_tabular.rb → lib/docgenerator_tabular.rb}

@@ -1,9 +1,9 @@
 #
-#Definition of elements for DocGenerator.rb
+#Definition of tabular elements for DocGenerator.rb
 #
-if __FILE__ == $0
-	require 'DocGenerator' 
-end
+#~ if __FILE__ == $0
+	#~ require 'DocGenerator' 
+#~ end
 
 #Define some constants to include packages into document header.
 TEX_PACKAGE_TABULARX	= element(:usepackage,{},'tabularx').cr
@@ -14,8 +14,8 @@ class Table < Environment
 	add_attributes( HTML_ATTR_ALL ) 
 	Element.add( [:table ],  Table)
 	def htmltag(); 'div'; end
-	def to_latex( )
-		return to_latex_environment( 'table' )
+	def to_latex( options={} )
+		return to_latex_environment( 'table', nil, options )
 	end
 end
 
@@ -62,23 +62,29 @@ class Tabular < Element
 			row.columns = @attr[:columns].to_s.to_i
 		end
 		@content << row
-		set_backlink( row )
 	end
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for tabular") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
 		cmd	<<	"\\begin{tabular}{"
-		cmd	<<	@attr[:columndescription].content.to_s
+		cmd	<<	@attr[:columndescription].content.to_doc(:latex, o)
 		cmd	<<	"}"
 		cmd	<<	"\n" if @crmid
-		cmd	<< @content.to_s
+		cmd	<< @content.to_doc(:latex, o )
 		cmd	<<	"\\end{tabular}"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
+  def to_text(options={}); return @content.to_text(options); end
+  def to_wiki(options={}); return "{|\n#{@content.to_wiki(options).strip}\n|}\n"; end
 	def htmltag()
 		return 'table'
 	end
+  def inspect()
+    return "<Class Element(tabular) columns=#{@attr[:columns]}>"
+  end
 end
 #Requires
 #	doc.head	<< element(:usepackage,{},'longtable')
@@ -87,14 +93,16 @@ class Longtable < Tabular
 	Element.add( [:longtable],  Longtable )
 	#
 	add_attributes( Element.get_attribute_list( Tabular ) )
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for longtable") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
 		cmd	<<	"\\begin{longtable}{"
-		cmd	<<	@attr[:columndescription].content.to_s
+		cmd	<<	@attr[:columndescription].content.to_doc(:latex, o)
 		cmd	<<	"}"
 		cmd	<<	"\n" if @crmid
-		cmd	<< @content.to_s
+		cmd	<< @content.to_latex(o)
 		cmd	<<	"\\end{longtable}"
 		cmd	<<	"\n" if @crafter
 		return cmd
@@ -108,9 +116,11 @@ class Tabularx < Tabular
 	Element.add( [:tabularx],  Tabularx )
 	#
 	add_attributes( Element.get_attribute_list( Tabular ) )
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for tabularx") if o[:log].debug?
 		if @attr[:width].content.to_s == ''
-			puts "Tabularx: Empty width, set it to \\textwidth"
+			o[:log].error( "Tabularx: Empty width, set it to \\textwidth" ) if o[:log].error?
 			@attr[:width] << '\\textwidth'
 		end
 		cmd	=	''
@@ -121,7 +131,7 @@ class Tabularx < Tabular
 		cmd	<<	@attr[:columndescription].content.to_s
 		cmd	<<	"}"
 		cmd	<<	"\n" if @crmid
-		cmd	<< @content.to_s
+		cmd	<< @content.to_doc(:latex, o )
 		cmd	<<	"\\end{tabularx}"
 		cmd	<<	"\n" if @crafter
 		return cmd
@@ -213,25 +223,35 @@ class Row < Element
 		elsif @content.size > @columns 
 			puts "Tabular with #{@columns} columns get #{@content.size} columns" 
 		end
-		set_backlink( row )
 	end
 	def inspect()
-		return "<Class Row:#{object_id}> @content={@content.inspect}"
+		return "<Class Row columns=#{@content.size}>"
 	end
 	#Each cell is separated by '&'.
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for row") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
-		cmd	<< @content.join(' & ') + Regexp.escape('\\' + '\\')
+		cmd	<< @content.map{|cell| cell.to_latex(o)}.join(' & ') 
+    #In direct use, one \\ is ok.
+    #In usage in documents, two \\ are needed (-> see unittest )
+    if o[:filename]
+      o[:log].debug("table/row with corresponding file #{o[:filename].inspect}") if o[:log].debug?
+      cmd << Regexp.escape('\\' + '\\')
+    else
+      o[:log].debug("table/row without corresponding file") if o[:log].debug?
+      cmd << Regexp.escape('\\')
+    end
 		cmd	<< "[#{@attr[:add_vspace].content.to_s}]" if @attr[:add_vspace].content.size > 0
-		cmd	<< @hline.to_s		if @hline
-		cmd	<< @toprule.to_s	if @toprule
-		cmd	<< @midrule.to_s	if @midrule
-		cmd	<< @bottomrule.to_s	if @bottomrule
-		cmd	<< @endfirsthead.to_s	if @endfirsthead
-		cmd	<< @endhead.to_s	if @endhead
-		cmd	<< @endfoot.to_s	if @endfoot
-		cmd	<< @endlastfoot.to_s	if @endlastfoot		
+		cmd	<< @hline.to_latex(o)		if @hline
+		cmd	<< @toprule.to_latex(o)	if @toprule
+		cmd	<< @midrule.to_latex(o)	if @midrule
+		cmd	<< @bottomrule.to_latex(o)	if @bottomrule
+		cmd	<< @endfirsthead.to_latex(o)	if @endfirsthead
+		cmd	<< @endhead.to_latex(o)	if @endhead
+		cmd	<< @endfoot.to_latex(o)	if @endfoot
+		cmd	<< @endlastfoot.to_latex(o)	if @endlastfoot		
 		@cline.each{|cline|	cmd	<< "\\cline{#{cline}}"	} if @cline
 		@cmidrule.each{|cmidrule|	cmd	<< "\\cmidrule{#{cmidrule}}"	} if @cmidrule
 		cmd	<<	"\n" if @crafter
@@ -240,12 +260,14 @@ class Row < Element
 	def htmltag()
 		return 'tr'
 	end
-	def to_html()
+	def to_html(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_html for row") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
 		cmd	<< '<tr '
 		css = @attr[:style].content[0]
-		puts "docgenerator_tabular: style is no CSS #{css.inspect}" if css and ! css.is_a?(CSS)
+    o[:log].error( "docgenerator_tabular: style is no CSS #{css.inspect}" ) if css and ! css.is_a?(CSS) and o[:log].error?
 		@attr[:style] << css = CSS.new if ! css		
 		#Doesn't work. Style sheet setting in tr doesn't go to td
 		if @hline
@@ -266,13 +288,15 @@ class Row < Element
 			cmd << "#{k} = \"#{v}\" " if v.to_s != '' and v.html?
 		}
 		cmd	<< '>'
-		cmd	<< "#{@content}"
+		cmd	<< "#{@content.to_html(o)}"
 		cmd	<< "\n" if @crmid
 		cmd	<< '</tr>'
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-end
+  def to_text(options={}); return "#{@content.to_text(options).strip}\n"; end
+  def to_wiki(options={}); return "\n|-\n#{@content.to_wiki(options).strip}"; end
+end #Row
 
 Element.create( [:hline ], {},false, 
 	{	:htmltag	=> nil,
@@ -322,10 +346,12 @@ class Column < Element
 		:align 	=> HTML_ATTR_ALIGN,
 		:bgcolor	=> Attribute.create( [ :html ] ),
 	} )
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for column") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"#{@content}"
+		cmd	<<	"#{@content.to_latex(o)}"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
@@ -334,31 +360,37 @@ class Column < Element
 #	fixme th for head	
 		return 'td'
 	end
+  def to_text(options={}); return "#{@content.to_text(options).strip}\n"; end
+  def to_wiki(options={}); return "|#{@content.to_wiki(options).strip}\n"; end
 	def inspect()
 		return "<Class Column @content=#{@content.inspect}>"
 	end
-end
+end #Columns
 class Multicolumn < Column
 	#Make the key known to the complete key-list of elements.
 	Element.add( [:multicolumn],  Multicolumn )
 	#~ add_attributes( HTML_ATTR_ALL ) 
 	add_attributes( { 
 		#~ :columns	=>  Attribute.create( [:required], [ Fixnum ] ) ,	#colspan
-		:columns	=> 	Attribute.create( [:required, :html, :latex], [ Fixnum ], 2 ) ,	#colspan
-		:colspan	=>	:columns,
+		:colspan	=> 	Attribute.create( [:required, :html, :latex], [ Fixnum ], 2 ) ,
+		:columns => :colspan,
 		:rowspan	=> 	Attribute.create( [:html ], [ Fixnum ], 2 ),
 		:pos		=>  Attribute.create( [:latex] ) ,
 		:align	=>  HTML_ATTR_ALIGN,
 		:width 	=> Attribute.create( [ :html ] ),
 		:height 	=> Attribute.create( [ :html ] ),
 	}.update( HTML_ATTR_ALL ) ) 
-	def to_latex()
+	def to_latex(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for multicolumn") if o[:log].debug?
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
-		cmd	<< 	"\\multicolumn{#{@attr[:columns]}}{#{@attr[:pos]}}{#{@content}}"
+		cmd	<< 	"\\multicolumn{#{@attr[:colspan]}}{#{@attr[:pos]}}{#{@content.to_latex(o)}}"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
+  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

data/{packages → lib/packages}/docgenerator_listings.rb

@@ -54,7 +54,6 @@ class Lstinline < Element
 						:caption	=> Attribute.create( [ :latex ], nil, 1 ),
 				}.update(HTML_ATTR_ALL).update( LSTSETTINGS)
 		) 
-
 	def htmltag; 'pre'; end
 	#Redefine standard output. 
 	#Options are given, if an option is avalaible.
@@ -68,7 +67,7 @@ class Lstinline < Element
 		cmd << '\lstinline'
 		cmd << "[#{texkeyval()}]"
 		cmd << sep
-		cmd << "#{@content}"
+		cmd << "#{@content.to_latex}"
 		cmd << sep
 		cmd << linebreak(@crafter)
 		return cmd

data/{packages → lib/packages}/docgenerator_scrlettr2.rb

@@ -120,9 +120,9 @@ class Letter < Environment
 		anr	<< element(:br)
 		@attr[:address].content.each{|a|	anr << [a, element(:br) ] }
 		cmd	<< element(:p,{}, @attr[:opening] )
-		cmd	<< @content
+		cmd	<< @content.to_html
 		cmd	<< element(:p,{}, @attr[:closing] )
 		#~ cmd	<<	"\n" if @crafter
-		return cmd.to_s
+		return cmd.to_html
 	end
 end

data/lib/templates/docgenerator_template.rb

@@ -0,0 +1,176 @@
+#
+#Definition of templates.
+#
+#This templates are used for document types.
+class DocumentTemplate
+	@@templates	= {}
+  #
+  #Define a template.
+  #
+  #A template gets a key, a target and the corresponding source.
+  #
+  #Valid targets are:
+  #-:latex
+  #-:html
+  #-:wiki
+  #-:text
+  #
+  #The source should contain the following place holder:
+  #- <<prefix>>   Contains later some admin data like time of creation...
+  #- <<head>>   Some header definitions
+  #- <<body>>   The main text
+  #- <<classoptions>> Class options (LaTeX)
+	def initialize( key, target, template)
+    @key     = key
+    @target = target
+		@template = template.gsub(/^\t*/, '')
+		case target
+		when :text
+		when :wiki
+		when :latex
+		when :html
+    else
+      puts "DocumentTemplate: Undefined target #{target.inspect}"
+		end
+    
+		if @@templates[key]
+      puts "DocumentTemplate: Double definition of template #{key.inspect}"
+    end
+		@@templates[key] = self
+    
+    #~ puts "Define template #{key.inspect} for #{target}"
+    #~ File.open("#{File.dirname(__FILE__)}/#{key}.#{target}", 'w'){|f|
+      #~ f << @template
+    #~ }
+  end
+  #Template.
+  # Base for the document to be created.
+  #
+  # <<head>> will be replaced by the header data
+  # <<body>> will be replaced by the body data
+  #
+  def template()
+    #Return a dup. Else the template may be changed
+    return @template.dup
+  end
+  #Target format of the Template (:html, :latex...)
+  attr_reader :target
+	def DocumentTemplate.[]( key )
+		if @@templates[key]
+			return @@templates[key]
+		else
+			puts "Template unknown: #{key}"
+			return nil
+		end
+	end
+  #Returns array with all defined template keys.
+	def DocumentTemplate.keys()
+		return @@templates.keys
+	end
+  #
+  # To add new templates via an external yaml-definition file.
+  # See 'docgenerator_template.yaml' as an example.
+  #
+  # You can use DocumentTemplate.to_yaml() to build your file.
+  #
+	def DocumentTemplate.load( yamlfile = "#{File.dirname(__FILE__)}/docgenerator_template.yaml" )
+    File.open(yamlfile){|yaml|
+      YAML.load(yaml).each{|key, data|
+        DocumentTemplate.new( key, data[:target], data[:source] )
+    }}
+  end
+  #Litte helper to build yaml-files
+	def DocumentTemplate.to_yaml()
+		yaml = {}
+    @@templates.each{|key, template|
+      yaml[key] = {
+        #~ :key => template.key,
+        :source => template.template,
+        :target => template.target,
+      }
+    }
+    puts yaml.to_yaml
+	end
+end
+
+DocumentTemplate.load()
+
+#~ Dir["#{File.dirname(__FILE__)}/*.{wiki,latex,text,html}"].each{|templatename|
+  #~ key, target = File.basename(templatename).split(/\./)
+  #~ File.open(templatename){|f|
+    #~ DocumentTemplate.new( key,target.to_sym, f.readlines.to_s )
+  #~ }
+#~ }
+#~ END{DocumentTemplate.to_yaml}
+__END__
+DocumentTemplate.new( 
+	:include, :latex, %q|<<prefix>>
+		% ----------------------------------------------------------------
+		<<head>>
+		% ----------------------------------------------------------------
+		<<body>>
+		% ----------------------------------------------------------------
+	|)
+	
+DocumentTemplate.new( 
+	:article, :latex, %q|<<prefix>>
+		\documentclass[<<classoptions>>]{scrartcl}
+		\usepackage{babel}
+		\usepackage[ansinew]{inputenc}
+		\usepackage{hyperref}
+		% ----------------------------------------------------------------
+		<<head>>
+		% ----------------------------------------------------------------
+		\begin{document}
+		<<body>>
+		\end{document}
+		% ----------------------------------------------------------------
+	|)
+#~ DocumentTemplate.new( 
+	#~ :report, '',
+	#~ |)
+#~ DocumentTemplate.new( 
+	#~ :book, '',
+	#~ |)
+
+		#~ <!doctype html public "-//W3C//DTD XHTML 1.0 Strict//EN"   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+DocumentTemplate.new( 
+	:html, :html, %q|<!--
+		<<prefix>>
+		-->
+		<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
+		<html>
+		<<head>>
+		<<body>>
+		</html>
+		|)
+
+{
+	:xhtml_strict	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
+	:xhtml_trans	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
+	:html401_strict	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
+	:html401_trans	=> '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">',
+}.each{ |key, doctype|
+	DocumentTemplate.new( 
+		key, :html, %Q|<!--
+			<<prefix>>
+			-->
+			#{doctype}
+			<html>
+			
+			<<head>>
+			
+			<<body>>
+			</html>
+			|)
+}
+
+DocumentTemplate.new( 
+	:text, :text, %q|
+		<<body>>
+	|)
+DocumentTemplate.new( 
+	:wiki, :wiki, %q|
+		<<body>>
+	|)