docgenerator 0.1.1 → 1.0.2

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

@@ -5,41 +5,7 @@
 #
 #Definition of elements for DocGenerator.rb
 #
-if __FILE__ == $0
-	require 'DocGenerator' 
-else
-	#
-	#Definition of HTML-Tags (Sublasses of Element).
-	ATTR_LANG		= Attribute.create( [ :html ], ['en', 'de'] )
-	#
-	HTML_ATTR_CORE	= {	
-						:id		=> Attribute.create( [ :html ] ),
-						:class	=> Attribute.create( [ :html ] ),
-						:style	=> Attribute.create( [ :html ], [CSS, String]),	#fixm string raus
-						:title		=> Attribute.create( [ :html ] ) }
-	HTML_ATTR_I18N	= {	
-						:lang		=> ATTR_LANG,
-						:dir		=> Attribute.create( [ :html ], ['ltr', 'rtl'] )
-					}
-	HTML_ATTR_EVENTS = {	:onclick		=> Attribute.create( [ :html ] ), 
-						:ondblclick		=> Attribute.create( [ :html ] ), 
-						:onmousedown	=> Attribute.create( [ :html ] ),
-						:onmouseup	=> Attribute.create( [ :html ] ),
-						:onmouseover	=> Attribute.create( [ :html ] ),
-						:onmousemove	=> Attribute.create( [ :html ] ),
-						:onmouseout	=> Attribute.create( [ :html ] ), 
-						:onkeypress	=> Attribute.create( [ :html ] ),
-						:onkeyup		=> Attribute.create( [ :html ] ), 
-						:onkeydown	=> Attribute.create( [ :html ] )
-				}
-	HTML_ATTR_ALL = {}
-	HTML_ATTR_ALL.update(HTML_ATTR_I18N)
-	HTML_ATTR_ALL.update(HTML_ATTR_EVENTS)
-	HTML_ATTR_ALL.update(HTML_ATTR_CORE)
-	
-	HTML_ATTR_ALIGN	= Attribute.create( [ :html ], ['left', 'center', 'right', 'justify', 'char'] )
-	HTML_ATTR_VALIGN	= Attribute.create( [ :html ], ['bottom', 'top', 'middle', 'baseline'] )
-end
+#
 
 #
 #Main document control.
@@ -91,7 +57,7 @@ class Title < Element
 		@attr[:short].content.compact!	#delete nils.
 		return nil	if ! @attr[:short].filled?
 		@part_of_doc.each{|doc|
-			if doc.template[:latex].include?('Beamer')
+			if doc.template[:latex].template.include?('Beamer')
 				return "[#{@attr[:short].content}]" 
 			end
 		}
@@ -243,7 +209,9 @@ Element.create( [:div, :Group],	divattr,	true,
 		:latex	=>	'#{linebreak(@crbefore)}' +  
 					'\begingroup '	+ '#{linebreak(@crmid)}' + 
 					'#{@content}'	+ '#{linebreak(@crmid)}' + 
-					'\endgroup '	+ '#{linebreak(@crafter)}' 
+					'\endgroup '	+ '#{linebreak(@crafter)}',
+    :text => '#{@content}',
+    :wiki => '#{@content}',
 	} )
 
 
@@ -266,8 +234,8 @@ Element.create( [ :url ],
 	HTML_ATTR_ALL,
 	true,
 	{
-		:html	=> '<a href="#{@content}">#{@content}</a>',
-		:latex	=> '\url{#{@content}}',
+		:html	=> '#{linebreak(@crbefore)}<a href="#{@content}">#{@content}</a>#{linebreak(@crafter)}',
+		:latex	=> '#{linebreak(@crbefore)}\url{#{@content}}#{linebreak(@crafter)}',
 	} )
 
 Element.create( [ :ensuremath ], 
@@ -299,23 +267,26 @@ class Href < Element
 		}.update(HTML_ATTR_ALL)
 	)
 	def htmltag(); 'a'; end
-	def to_wiki( )
-		"[#{@attr[:href].to_s} #{@content}]"
+	def to_wiki( options = {} )
+		"[#{@attr[:href].to_s} #{@content.to_doc(:wiki, options)}]"
 	end
-	def to_latex( )
+	def to_latex( options = {} )
+    cmd = linebreak(@crbefore)
 		reference = @attr[:href].to_s
 		if reference.sub!(/\#/, '')	#Internal reference
-			return "\\hyperlink{#{reference}}{#{@content}}"
+			cmd << "\\hyperlink{#{reference}}{#{@content.to_doc(:latex, options)}}"
 		else	#external reference
-			return "\\href{#{reference}}{#{@content}}"
+			cmd << "\\href{#{reference}}{#{@content.to_doc(:latex, options)}}"
 		end
+    cmd << linebreak(@crafter)
+    cmd
 	end
-	def to_text( )
+	def to_text( options = {} )
 		if @attr[:href].to_s	== @content
-			@content
+			@content.to_doc(:text, options)
 		else
 			#~ "<#{@attr[:href].to_s} #{@content}>"	--> Problem: Wird gerne als komplette URL interpreitert
-			"#{@content} (#{@attr[:href].to_s})"
+			"#{@content.to_doc(:text, options)} (#{@attr[:href].to_s})"
 		end
 	end
 end
@@ -338,13 +309,16 @@ end
 	#~ } )
 
 Element.create( [ :label ], 
-	{	:name		=> Attribute.create( [ :html, :latex, :required ] ),
+	{
+    :name		=> Attribute.create( [ :html, :latex, :required ] ),
 	}.update( HTML_ATTR_ALL ),
 	true,
 	{
 		#~ :htmltag	=> 'a',
 		:html	=> '#{linebreak(@crbefore)}<a name="#{@attr[:name]}">#{linebreak(@crmid)}#{@content}</a>#{linebreak(@crafter)}',
 		:latex	=> '#{linebreak(@crbefore)}\label{#{@attr[:name]}}#{linebreak(@crmid)}\hypertarget{#{@attr[:name]}}{#{@content}}#{linebreak(@crafter)}',
+    :text => '(#{@attr[:name]}) #{@content}',
+    :wiki => '#{linebreak(@crbefore)}[[??#{@attr[:name]}]]#{@content}#{linebreak(@crafter)}', #fixme wrong
 	} )
 
 Element.create( [ :hypertarget ], 
@@ -375,14 +349,18 @@ Element.create( [ :link ],
 
 #
 
+#
+#TeX-Makro usepackage.
+# Trys to load element definitions 
+#
 class Usepackage < Element
 	#Make the key known to the complete key-list of elements.
 	Element.add( [:usepackage],  Usepackage)
 	#~ add_attributes( HTML_ATTR_ALL ) 
 	add_attributes( { :option =>  Attribute.create( ) } ) 
 	
-	#With usepackage additional command my be defined.
-	#Here we load this special 
+	#With usepackage additional command may be defined.
+	#Here we load this special commands/elements if available.
 	def << ( content )
 		@content << content
 		#Load new makros
@@ -394,9 +372,9 @@ class Usepackage < Element
 	end	
 	
 	#Redefine standard output. 
-	#Options are given, if an option is avalaible.
+	#Options are given, if an option is available.
 	#~ add_output( :latex,	'\usepackage[#{@attr[:option]}]{#{@content}}' )
-	def to_latex()
+	def to_latex( options = {} )
 		cmd = linebreak(@crbefore)
 		cmd << '\usepackage'
 		opt = @attr[:option].content
@@ -405,7 +383,7 @@ class Usepackage < Element
 		cmd << linebreak(@crafter)
 		return cmd
 	end
-	def to_html()
+	def to_html( options = {} )
 		return ''
 	end
 end	#Usepackage
@@ -487,7 +465,9 @@ Element.create( [:underline ], {},true,
 
 Element.create( [:sup, :textsuperscript ], {}.update(HTML_ATTR_ALL),true, 
 	{	:htmltag	=> 'sup',
-		:latex	=> '#{linebreak(@crbefore)}\textsuperscript{#{@content}}#{linebreak(@crafter)}'
+		:latex	=> '#{linebreak(@crbefore)}\textsuperscript{#{@content}}#{linebreak(@crafter)}',
+		:wiki   => '#{linebreak(@crbefore)}^#{@content}^#{linebreak(@crafter)}',
+		:text   => '#{linebreak(@crbefore)}^#{@content}^#{linebreak(@crafter)}'
 	} )
 
 #
@@ -528,8 +508,12 @@ Element.create( [:centering ], {},false,
 #~ :option=> {:value=>nil}, #complete it
 #~ :select=> events.update({}), #complete it
 
-Element.create( :input, {}, true )
-Element.create( :include, {}, true )
+Element.create( :input, {}, true, {
+		:latex	=> '#{linebreak(@crbefore)}\input{#{@content}}#{linebreak(@crafter)}'
+    } )
+Element.create( :include, {}, true, {
+		:latex	=> '#{linebreak(@crbefore)}\include{#{@content}}#{linebreak(@crafter)}'
+  } )
 
 
 Element.create( [:img, :includegraphics],

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

@@ -1,14 +1,15 @@
 class Environment < Element
+	Element.add( [:environment],  Environment)
 	#Parameters are given as a string (or anything what gives a String with to_s).
 	#It is difficult to make a generic parameter interface.
 	#If needed, redefine the method.
-	def to_latex_environment( environment, parameter = nil)
+	def to_latex_environment( environment, parameter = nil, options={})
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
 		cmd	<<	"\n\\begin{#{environment}}"
 		cmd	<< parameter.to_s if parameter
 		cmd	<<	"\n" if @crmid
-		cmd	<< @content.to_s
+		cmd	<< @content.to_latex
 		cmd	<<	"\n" if @crmid and cmd[-1,1] != "\n"
 		cmd	<<	"\\end{#{environment}}\n"
 		cmd	<<	"\n" if @crafter
@@ -45,18 +46,22 @@ Element.create( [:landscape ], {}, true,
 		:latex	=> '#{linebreak(@crbefore)}\begin{landscape}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{landscape}#{linebreak(@crafter)}'
 	} )
 
-Element.create( [:verb ], {}, true, 
+Element.create( [:verb ], HTML_ATTR_CORE, true, 
 	{	:htmltag	=> 'pre',	#fixme
 		:latex	=> '#{linebreak(@crbefore)}\verb|#{@content}|#{linebreak(@crafter)}'
 	} )
+  
 class Verbatim < Environment
-	add_attributes( HTML_ATTR_ALL ) 
+	add_attributes( 		{
+		:width		=> Attribute.create( [ :html ], [Integer], 1 ), #Number of characters
+  }.update(HTML_ATTR_ALL))
+  
 	Element.add( [:verbatim, :pre],  Verbatim)
 	def htmltag(); 'pre'	end
-	def to_text(); "#{content}"	end
-	def to_wiki(); " #{content}"	end
-	def to_latex( )
-		return to_latex_environment( 'verbatim' )
+	def to_text(options = {}); "#{content}"	end
+	def to_wiki(options = {} ); " #{content}"	end
+	def to_latex(options = {}  )
+		return to_latex_environment( 'verbatim', options = {}  )
 	end
 end
 
@@ -64,10 +69,11 @@ class Figure < Environment
 	add_attributes( HTML_ATTR_ALL ) 
 	Element.add( [:figure],  Figure)
 	def htmltag(); 'div'; end
-	def to_latex( )
-		return to_latex_environment( 'figure' )
+	def to_latex( options = {} )
+		return to_latex_environment( 'figure', options = {}  )
 	end
 end
+
 Element.create( [:listoffigures], {},false, {
 		:latex	=> '#{linebreak(@crbefore)}\listoffigures #{linebreak(@crafter)}',
 			})

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

@@ -2,63 +2,85 @@
 # Footnotes
 #
 class Footnote < Element
-	@@group = Hash.new()
 	Element.add( [:footnote ],  Footnote)
 	add_attributes( 		{
 			:counter => Attribute.create(),
 			:groupid => Attribute.create()
 		}.update(HTML_ATTR_ALL)
-	) 
+	)
+  #The footnote group for the corresponding footnote
+  attr_reader :group
 	def counter()
 		if ! @attr[:counter].filled?
 			groupid = @attr[:groupid].content[0]
-			if  ! @@group[groupid]
-				@@group[groupid] = Footnotegroup.get( groupid )
-			end
-			@@group[groupid] << self
-			@attr[:counter]		<< @@group[groupid].size
+      Footnotegroup.get( groupid )  << self
+			@attr[:counter]		<< Footnotegroup.get( groupid ).size
 		end
-		return @attr[:counter]
+		return @attr[:counter].content
 	end
-	def to_html( )
+  def link()
+    link = "foot"
+    if @attr[:groupid].content[0]
+      link << "#{@attr[:groupid]}-"
+    end
+    link << self.counter().to_s
+    link
+  end
+	def to_html( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
 		if Footnotegroup.get( @attr[:groupid].content[0] ).html_link
-			cmd	<<	"<sup><a href=\"#foot#{counter}\">#{counter}</a></sup>"
+			cmd	<<	"<sup><a href=\"##{link}\">#{counter}</a></sup>"
 		else
 			cmd	<<	"<sup>#{counter}</sup>"
 		end
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-	def to_latex( )
+	def to_latex( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"\\footnote{#{@content}}"
+		cmd	<<	"\\footnote{#{@content.to_latex(options)}}"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-	def to_text()
-		return '#{linebreak(@crbefore)}' +  "- #{@content}" + ' #{linebreak(@crafter)}'
+	def to_text(options={})
+		cmd = ''
+		cmd	<<	"\n" if @crbefore
+    cmd << "(#{counter})"
+		cmd	<<	"\n" if @crafter
+    return cmd
 	end
+  alias :to_wiki :to_text
 	def get_content()
 		return @content
 	end
 end
 
+#Attention!
+#
+#This is a 'global' group.
+#All footnotes of the actual programm are collected, not of one document!
+#
+#may be fixed in the future.
 class Footnotegroup
 	@@all	= { }
 	#Use
 	#	Footnotegroup.get
 	#to get the collected footnotes.
 	#It is not a good idea to use this with LaTeX, because LaTeX makes it automatic.
-	#(But you can try it with tables.
+	#(But you can try it with tables).
 	def self.get( groupid = nil )
 		if ! @@all[groupid]
 			@@all[groupid] = self.new( groupid )
 		end
 		return @@all[groupid]
 	end
+  #Ugly -- When you create multiple documents, you get a common Footnotegroup.
+  #Here you can clear it.
+	def self.clear()
+    @@all	= { }    
+  end
 	def initialize( groupid )
 		@groupid		= groupid
 		@footnotes	= []
@@ -71,33 +93,33 @@ class Footnotegroup
 		@attr = attr
 	end
 	def <<( footnote )
-		@footnotes	<< footnote
+		@footnotes	<< footnote unless @footnotes.include?(footnote)
 	end
 	def size()
 		return @footnotes.size
 	end
-	def to_s()
+	def to_doc( target, options={} )
 		return '' if @footnotes.size == 0
 		ul = element(:p, @attr ).cr
 		@footnotes.each{|f|
 			#~ ul << element(:sup, {}, f.counter )
-			ul << footnotemark = element(:sup )
+			ul << footnotemark = element(:sup)
 			if @html_link
-				footnotemark  << element(:label, { :name => "foot#{f.counter}" }, f.counter )
+				footnotemark  << element(:label, { :name => "#{f.link}" }, f.counter )
 			else
 				footnotemark  << f.counter
 			end
 			ul << f.get_content
 			ul << element(:br).cr
 		}
-		return ul.to_s
+		return ul.to_doc(target, options )
 	end
-end
+end #Footnotegroup
 
 
 Element.create( [:footnotemark ], {}.update(HTML_ATTR_ALL),true, 
 	{	:htmltag	=> 'sup',
-		:latex	=> '#{linebreak(@crbefore)}\footnotemark[#{@content}]#{linebreak(@crafter)}'	#fixme
+		:latex	=> '#{linebreak(@crbefore)}\footnotemark[#{@content.to_latex}]#{linebreak(@crafter)}'	#fixme
 	} )
 
 

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

@@ -1,6 +1,7 @@
 
 #Generell class for list environments
 class ListEnvironment < Environment
+	Element.add( [:listenvironment],  ListEnvironment)
 	add_attributes( HTML_ATTR_ALL ) 
 	#Only items are allowed to be added.
 	#
@@ -12,35 +13,43 @@ class ListEnvironment < Environment
 			if self.class == Description
 				#fixme: Reihenfolge
 				if ! ( item.is_a?( Element.get(:dt) ) or item.is_a?( Element.get(:dd) ) )
-					puts "Add non-item to list (#{item.class} #{@called_by})"
+					@log.warn("Add non-item to list (#{item.class} #{@called_by})") if @log.warn
 				end
 			elsif ! item.is_a?( Element.get(:item) )
-				puts "Add non-item to list (#{item.class} #{@called_by})"
+				@log.warn("Add non-item to list (#{item.class} #{@called_by})") if @log.warn
 			end
 			@content << item
-			set_backlink( item )
 		end
 	end
-	def to_wiki( )
-		res = "#{@content}\n"
-		return res.gsub(/\n\n/, "\n")
+  #Add parent-information to options. Is used by the list elements to get the list type.
+	def to_doc( target, options = {} )
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_doc for #{self.inspect}") if o[:log].debug?
+    options[:parent] = self
+    super
+  end
+	def to_wiki( options={} )
+		return "#{@content.to_doc(:wiki, options)}\n".gsub(/\n\n/, "\n")
+	end
+	def to_text( options={} )
+		return "#{@content.to_doc(:text,options)}\n".gsub(/\n\n/, "\n")
 	end
-	alias :to_text :to_wiki
 end
+
 class Itemize < ListEnvironment
 	add_attributes( HTML_ATTR_ALL ) 
 	Element.add( [:ul, :itemize],  Itemize)
 	def htmltag(); 'ul'; end
-	def to_latex( )
-		return to_latex_environment( 'itemize' )
+	def to_latex( options={} )
+		return to_latex_environment( 'itemize', nil, options )
 	end
 end
 class Enumerate < ListEnvironment
 	add_attributes( HTML_ATTR_ALL ) 
 	Element.add( [:ol, :enumerate],  Enumerate)
 	def htmltag(); 'ol'; end
-	def to_latex( )
-		return to_latex_environment( 'enumerate' )
+	def to_latex( options={} )
+		return to_latex_environment( 'enumerate', nil, options )
 	end
 end
 #
@@ -53,8 +62,8 @@ class Description < ListEnvironment
 	add_attributes( HTML_ATTR_ALL ) 
 	Element.add( [:description, :dl],  Description)
 	def htmltag(); 'dl'; end
-	def to_latex( )
-		return to_latex_environment( 'description' )
+	def to_latex( options={} )
+		return to_latex_environment( 'description', nil, options )
 	end
 end
 
@@ -70,42 +79,38 @@ class Item < Element
 		}.update(HTML_ATTR_ALL)
 	)
 	def htmltag(); 'li'; end
-	def to_latex( )
+	def to_latex( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
 		cmd	<<	"\n\\item "
 		cmd	<<	"[#{@attr[:text]}] " if @attr[:text].filled?
-		cmd	<<	@content.to_s
+		cmd	<<	@content.to_doc(:latex, options)
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-	def to_text()
+	def to_text(options={})
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"- #{@content}"
+		cmd	<<	"- #{@content.to_doc(:text, options)}"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
 	#fixme geschachtete 
 	#-	** auf stufe 2
 	#-	kein * wenn als n�chstes eine Liste kommt.
-	def to_wiki()
+	def to_wiki(options={})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].debug("enter to_latex for row") if o[:log].debug?
 		cmd	= ''
-	#~ puts part_of.inspect
-		if part_of.size != 1
-			puts ":li/wiki: Unclear list type #{part_of.inspect}"
-		else
-			list = part_of[0]
-		end
 		#~ cmd	<<	"\n" if @crbefore
-		case list.class.to_s.to_sym
+		case o[:parent].class.to_s.to_sym
 		when :Itemize
-			cmd	<<	"\n* #{@content}"
+			cmd	<<	"\n* #{@content.to_doc(:wiki, options)}"
 		when :Enumerate
-			cmd	<<	"\n# #{@content}"
+			cmd	<<	"\n# #{@content.to_doc(:wiki, options)}"
 		else
-			puts ":li/wiki: Unknown list type #{part_of.inspect}"
-			cmd	<<	"\n* #{@content}"
+			o[:log].error(":li/wiki: Unknown list type #{o[:parent].inspect}") if o[:log].error?
+			cmd	<<	"\n* #{@content.to_doc(:wiki, options)}"
 		end
 		#~ cmd	<<	"\n" if cmd[-1,1] != "\n"
 		cmd	<<	"\n" if @crafter and cmd[-1,1] != "\n"
@@ -121,18 +126,18 @@ class DT < Element
 	Element.add( [:dt],  DT)
 	add_attributes( HTML_ATTR_ALL ) 
 	def htmltag(); 'dt'; end
-	def to_text();	"\n#{@content}: " end
-	def to_wiki()
+	def to_text(options={});	"\n#{@content.to_doc(:text, options )}: " end
+	def to_wiki(options={})
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"\n;#{@content}"
+		cmd	<<	"\n;#{@content.to_doc(:wiki, options )}"
 		cmd	<<	"\n"
 		return cmd
 	end
-	def to_latex( )
+	def to_latex( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"\n\\item[#{@content}] "
+		cmd	<<	"\n\\item[#{@content.to_doc(:latex, options)}] "
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
@@ -145,18 +150,18 @@ class DD < Element
 	Element.add( [:dd],  DD)
 	add_attributes( HTML_ATTR_ALL ) 
 	def htmltag(); 'dd'; end
-	def to_text(); "\n\t#{@content}\n" end
-	def to_wiki()
+	def to_text(options={}); "\n\t#{@content.to_doc(:text, options)}\n" end
+	def to_wiki(options={})
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	"\n:#{@content}"
+		cmd	<<	"\n:#{@content.to_doc(:wiki, options )}"
 		cmd	<<	"\n"
 		return cmd
 	end
-	def to_latex( )
+	def to_latex( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
-		cmd	<<	" #{@content} "
+		cmd	<<	" #{@content.to_doc(:latex, options )} "
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end