docgenerator 1.2.1 → 2.0.0

data/lib/docgenerator/environments.rb

@@ -1,30 +1,60 @@
+module Docgenerator   
+=begin rdoc
+Collection of Environments.
+
+Enviroment are special LaTeX-constructs.
+
+Instead
+  \makro{content}
+environments are coded as 
+  \begin{makro}
+  content
+  \end{makro}
+=end
+module Environments
+=begin rdoc
+Define Element :environment
+
+This class is used for further class definitions.
+Only for LaTeX
+
+Create an instance with
+  element( :environment, [ attributes, [content]] )
+or
+  Environment.new( [ attributes, [content]] )
+=end
 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.
+=begin rdoc
+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.
+=end
 	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_latex
+		cmd	<< @content.to_latex(options)
 		cmd	<<	"\n" if @crmid and cmd[-1,1] != "\n"
 		cmd	<<	"\\end{#{environment}}\n"
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-  #ConTeXt-environments start with start and end with stop.
-  #
-  #Fixme: Parameters
+=begin rdoc
+ConTeXt-environments start with start and end with stop.
+
+Fixme: Parameters
+=end
 	def to_context_environment( environment, parameter = nil, options={})
 		cmd	=	''
 		cmd	<<	"\n" if @crbefore
 		cmd	<<	"\n\\start#{environment}"
 		cmd	<< parameter.to_s if parameter
 		cmd	<<	"\n" if @crmid
-		cmd	<< @content.to_latex
+		cmd	<< @content.to_latex(options)
 		#~ cmd	<<	"\n" if @crmid and cmd[-1,1] != "\n"
 		cmd	<<	"\n\\stop#{environment}\n"
 		cmd	<<	"\n" if @crafter
@@ -32,56 +62,94 @@ class Environment < Element
 	end	#~ def htmltag()
 		#~ return 'table'
 	#~ end
-	#~ def to_latex( )
-		#~ return to_latex_environment( 'itemize' )
+	#~ def to_latex( options={} )
+		#~ return to_latex_environment( 'itemize', nil, options )
 	#~ end
 end
 
-Element.create( [:minipage],	{ :width => Attribute.create( [ :latex, :html ], [ String ] ), },
-	true, 
-	{	:htmltag	=> 'div',
-		:latex	=>	'#{linebreak(@crbefore)}' +  
+=begin rdoc
+Define Element :minipage
+
+Create an instance with
+  element( :minipage, [ attributes, [content]] )
+or
+  Minipage.new( [ attributes, [content]] )
+Attributes may be:
+* :width: 
+=end
+class Minipage < Element
+  add_attribute :width, Attribute.create( [ :latex, :html ], [ String ] )
+  add_html_tag 'div'
+  add_latex_output '#{linebreak(@crbefore)}' +  
 					'\begin{minipage}{#{@attr[:width]}}'	+ '#{linebreak(@crmid)}' + 
 					'#{@content}'		+ '#{linebreak(@crmid)}' + 
-					'\end{minipage}'	+ '#{linebreak(@crafter)}' 
-	} )
-
-Element.create( [:center ], HTML_ATTR_CORE, true, 
-	{	:htmltag	=> 'center',
-		:latex	=> '#{linebreak(@crbefore)}\begin{center}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\\end{center}#{linebreak(@crafter)}'
-	} )
-Element.create( [:quote, :blockquote ], HTML_ATTR_CORE, true, 
-	{	:htmltag	=> 'blockquote',
-		:latex	=> '#{linebreak(@crbefore)}\begin{quote}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{quote}#{linebreak(@crafter)}'
-	} )
-
-Element.create( [:landscape ], {}, true, 
-	{	#:htmltag	=> 'center',
-		:latex	=> '#{linebreak(@crbefore)}\begin{landscape}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{landscape}#{linebreak(@crafter)}'
-	} )
-
-Element.create( [:verb ], HTML_ATTR_CORE, true, 
-	{	
-    #This builds a new block
-    #~ :htmltag	=> 'pre',
-    #With "display: inline" the element is continued correct, but <pre starts on new line. 
-    #~ :html	=> '#{linebreak(@crbefore)}<pre style = "display: inline">#{@content}</pre>#{linebreak(@crafter)}',
-    #fixme font tt
-    #~ :html	=> '#{linebreak(@crbefore)}<span style = "display: inline;white-space:pre;font-family:monospace">#{@content}</span>#{linebreak(@crafter)}',
-    :html	=> '#{linebreak(@crbefore)}<span style = "display: inline;white-space:pre;font-family:monospace">#{@content.join.gsub(/</, \'&lt;\').gsub(/>/, \'&gt;\')}</span>#{linebreak(@crafter)}',
-		:latex	=> '#{linebreak(@crbefore)}\verb|#{@content}|#{linebreak(@crafter)}',
-		:text	=> '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}',
-	} )
-  
+					'\end{minipage}'	+ '#{linebreak(@crafter)}'
+end #Minipage
+
+=begin rdoc
+Define Element :center
+
+Create an instance with
+  element( :center, [ attributes, [content]] )
+or
+  Center.new( [ attributes, [content]] )
+Attributes may be:
+* HTML_ATTR_CORE
+
+=end
+class Center < Element
+  add_attributes HTML_ATTR_CORE
+  add_html_tag 'center'
+  add_latex_output '#{linebreak(@crbefore)}\begin{center}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{center}#{linebreak(@crafter)}'
+end #Center
+
+=begin rdoc
+Define Element :quote, :blockquote
+
+Create an instance with
+  element( :quote, [ attributes, [content]] )
+  element( :blockquote, [ attributes, [content]] )
+or
+  Quote.new( [ attributes, [content]] )
+Attributes may be:
+* HTML_ATTR_CORE
+=end
+class Quote < Element
+  add_id :blockquote
+  add_attributes HTML_ATTR_CORE
+  add_html_tag 'blockquote'
+  add_latex_output '#{linebreak(@crbefore)}\begin{quote}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{quote}#{linebreak(@crafter)}'
+end #Quote
+
+=begin rdoc
+Define Element :landscape
+
+Only LaTeX
+
+Create an instance with
+  element( :landscape, [ attributes, [content]] )
+or
+  Landscape.new( [ attributes, [content]] )
+Attributes are not defined for this element.
+=end
+class Landscape < Element
+  add_latex_output '#{linebreak(@crbefore)}\begin{landscape}#{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\end{landscape}#{linebreak(@crafter)}'
+end #Landscape
+
+
+=begin rdoc
+Environment Verbatim
+
+See also Elements::Verb
+=end
 class Verbatim < Environment
-	add_attributes( 		{
-		:width		=> Attribute.create( [ :html ], [Integer], 1 ), #Number of characters
-  }.update(HTML_ATTR_ALL))
-  
-	Element.add( [:verbatim, :pre],  Verbatim)
-	#~ def htmltag(); 'pre'	end
+	add_attribute :width, Attribute.create( [ :html ], [Integer], 1 ) #Number of characters
+  add_attributes HTML_ATTR_ALL
+  add_id :pre
+=begin rdoc
+=end
   def to_html(options = {})
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = set_option_defaults(options)
     html  = String.new()
     html  <<  "\n" if @crbefore
     html  << "<pre"
@@ -98,22 +166,45 @@ class Verbatim < Environment
     return html
   end  #to_html
   
-	def to_text(options = {}); "#{content.join}"	end
-	def to_wiki(options = {} ); " #{content.join}"	end
-	def to_latex(options = {}  )
-		return to_latex_environment( 'verbatim', nil, options = {}  )
+=begin rdoc
+=end	
+  def to_text(options = {}); "#{@content.join}"	end
+=begin rdoc
+=end
+  def to_wiki(options = {} ); " #{@content.join}"	end
+=begin rdoc
+=end
+  def to_creole(options = {} ); "{{{\n#{@content.join}\n}}}"	end
+=begin rdoc
+=end
+  def to_latex(options = {}  )
+		return to_latex_environment( 'verbatim', nil, options )
 	end
 end
 
+=begin rdoc
+=end
 class Figure < Environment
-	add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:figure],  Figure)
+	add_attributes HTML_ATTR_ALL
 	def htmltag(); 'div'; end
 	def to_latex( options = {} )
-		return to_latex_environment( 'figure', options = {}  )
+		return to_latex_environment( 'figure', nil, options )
 	end
 end
 
-Element.create( [:listoffigures], {},false, {
-		:latex	=> '#{linebreak(@crbefore)}\listoffigures #{linebreak(@crafter)}',
-			})
+=begin rdoc
+Environment Abstract.
+
+Only LaTeX
+=end
+class Abstract < Environment
+	#~ add_attributes( HTML_ATTR_ALL ) 
+	#~ def htmltag(); ''; end
+=begin rdoc
+=end
+	def to_latex( options = {} )
+		return to_latex_environment( 'abstract', nil, options )
+	end
+end
+end  #module Environments
+end #module Docgenerator

data/lib/docgenerator/footnote.rb

@@ -1,7 +1,8 @@
+module Docgenerator   
 =begin rdoc
 Footnotegroup.
 
-A Footnote without group-attribute get it#s own Footnotegroup.
+A Footnote without group-attribute get it's own Footnotegroup.
 For LaTeX it is ok, for HTML the content of the footnote will disappear.
 =end
 class Footnotegroup
@@ -42,9 +43,9 @@ Build a new footnote group.
 		ul = element(:p, @attr ).cr
 		@footnotes.each{|f|
 			#~ ul << element(:sup, {}, f.counter )
-			ul << footnotemark = element(:sup)
+			ul << footnotemark = element(:sup, { :log => options[:log] })
 			if @html_link
-				footnotemark  << element(:label, { :name => "#{f.link}" }, f.label )
+				footnotemark  << element(:label, { :name => "#{f.link}", :log => options[:log] }, f.label )
 			else
 				footnotemark  << f.label
 			end
@@ -56,10 +57,12 @@ Build a new footnote group.
 end #Footnotegroup
 
 =begin rdoc
-Footnotes
+A Footnote.
+
+==HTML
+Footnotes should be assigned to a Footnotegroup
 =end
 class Footnote < Element
-	Element.add( [:footnote ],  Footnote)
 	add_attributes( 		{
 			:label   => Attribute.create(),
 			:group  => Attribute.create([:required], [Footnotegroup] )
@@ -117,9 +120,27 @@ class Footnote < Element
 	end
 end #Footnote
 
+=begin rdoc
+Define Element :footnotemark
+
+Create an instance with
+  element( :footnotemark, [ attributes, [content]] )
+or
+  Footnotemark.new( [ attributes, [content]] )
+Attributes may be:
+* HTML_ATTR_CORE
+* HTML_ATTR_I18N
+* HTML_ATTR_EVENTS
+* :lang, ATTR_LANG
+=end
+class Footnotemark < Element
+  add_attributes HTML_ATTR_CORE
+  add_attributes HTML_ATTR_I18N
+  add_attributes HTML_ATTR_EVENTS
+  add_attribute :lang, ATTR_LANG
+  add_html_tag 'sup'
+  add_latex_output '#{linebreak(@crbefore)}\footnotemark[#{@content}]#{linebreak(@crafter)}'
+end #Footnotemark
 
-Element.create( [:footnotemark ], {}.update(HTML_ATTR_ALL),true, 
-	{	:htmltag	=> 'sup',
-		:latex	=> '#{linebreak(@crbefore)}\footnotemark[#{@content.to_latex}]#{linebreak(@crafter)}'	#fixme
-	} )
 
+end #module Docgenerator

data/lib/docgenerator/lists.rb

@@ -1,7 +1,11 @@
+module Docgenerator
+module Lists
+=begin rdoc
+Generic class for list environments.
 
-#Generell class for list environments
-class ListEnvironment < Environment
-	Element.add( [:listenvironment],  ListEnvironment)
+Used to define Itemize, Enumerate...
+=end
+class ListEnvironment < Environments::Environment
 	add_attributes( HTML_ATTR_ALL ) 
 	#Only items are allowed to be added.
 	#
@@ -13,22 +17,25 @@ class ListEnvironment < Environment
 			if self.class == Description
 				#fixme: Reihenfolge
 				if ! ( item.is_a?( Element.get(:dt) ) or item.is_a?( Element.get(:dd) ) )
-					@log.warn("Add non-item to list (#{item.class} #{@called_by})") if @log.warn
+					@log.warn("Add non-item to list (#{item.inspect})") if @log.warn
 				end
 			elsif ! item.is_a?( Element.get(:item) )
-				@log.warn("Add non-item to list (#{item.class} #{@called_by})") if @log.warn
+				@log.warn("Add non-item to list (#{item.inspect})") if @log.warn
 			end
 			@content << item
 		end
 	end
   #Add parent-information to options. This is used by the list elements to get the list type.
 	def to_doc( target, options = {} )
-    o = Docgenerator_logger.set_option_defaults(options)
+    o = 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={} )
+	def to_wiki( options= {} )
+		return "#{@content.to_doc(:wiki, options)}\n".gsub(/\n\n/, "\n")
+	end
+	def to_creole( options= {} )
 		return "#{@content.to_doc(:wiki, options)}\n".gsub(/\n\n/, "\n")
 	end
 	def to_text( options={} )
@@ -36,9 +43,12 @@ class ListEnvironment < Environment
 	end
 end
 
+=begin rdoc
+Unnumbered list
+=end
 class Itemize < ListEnvironment
-	add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:ul, :itemize],  Itemize)
+	add_attributes HTML_ATTR_ALL
+	add_id :ul
 	def htmltag(); 'ul'; end
 	def to_latex( options={} )
 		return to_latex_environment( 'itemize', nil, options )
@@ -47,10 +57,13 @@ class Itemize < ListEnvironment
 		return to_context_environment( 'itemize', '[1]', options )
 	end
 end
+=begin rdoc
+Numbered lists.
+=end
 class Enumerate < ListEnvironment
-	add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:ol, :enumerate],  Enumerate)
-	def htmltag(); 'ol'; end
+	add_attributes HTML_ATTR_ALL
+	add_id :ol
+	add_html_tag 'ol'
 	def to_latex( options={} )
 		return to_latex_environment( 'enumerate', nil, options )
 	end
@@ -58,33 +71,32 @@ class Enumerate < ListEnvironment
 		return to_context_environment( 'itemize', '[n]', options )
 	end
 end
-#
-#
-#HTML:
-#	<dl>
-#	<dt> <dd>
-#	</dl>
+
+=begin rdoc
+HTML:
+	<dl>
+	<dt> <dd>
+	</dl>
+=end
 class Description < ListEnvironment
 	add_attributes( HTML_ATTR_ALL ) 
-	Element.add( [:description, :dl],  Description)
-	def htmltag(); 'dl'; end
+	add_id :dl
+	add_html_tag 'dl'
 	def to_latex( options={} )
 		return to_latex_environment( 'description', nil, options )
 	end
 end
 
-#
-#Item line in a list.
-#The look will be defined by the environment where it is in (itemize/ul, enumerate/ol)
-#
-#bug to_html 
+=begin rdoc
+Item line in a list.
+
+The look will be defined by the environment where it is in (itemize/ul, enumerate/ol)
+=end
 class Item < Element
-	Element.add( [:li, :item],  Item)
-	add_attributes( 		{
-			:text => Attribute.create( [ :latex ] )
-		}.update(HTML_ATTR_ALL)
-	)
-	def htmltag(); 'li'; end
+	add_id :li
+	add_attribute :text, Attribute.create( [ :latex ] )
+	add_attributes HTML_ATTR_ALL
+	add_html_tag 'li'
 	def to_latex( options={} )
 		cmd	= ''
 		cmd	<<	"\n" if @crbefore
@@ -115,14 +127,14 @@ class Item < Element
 	#-	** auf stufe 2
 	#-	kein * wenn als n�chstes eine Liste kommt.
 	def to_wiki(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
-		case o[:parent].class.to_s.to_sym
-		when :Itemize
+		case o[:parent] #check for class to get the item type
+		when Docgenerator::Lists::Itemize
 			cmd	<<	"\n* #{@content.to_doc(:wiki, options)}"
-		when :Enumerate
+		when Docgenerator::Lists::Enumerate
 			cmd	<<	"\n# #{@content.to_doc(:wiki, options)}"
 		else
 			o[:log].error(":li/wiki: Unknown list type #{o[:parent].inspect}") if o[:log].error?
@@ -132,16 +144,23 @@ class Item < Element
 		cmd	<<	"\n" if @crafter and cmd[-1,1] != "\n"
 		return cmd
 	end
+  #
+  alias :to_creole :to_wiki  #fixme/to_doc(:wiki falsch
 end	#Item
 
-#HTML:
-#	<dl>
-#	<dt> <dd>
-#	</dl>
+=begin rdoc
+HTML:
+	<dl>
+	<dt> <dd>
+	</dl>
+  
+LaTeX:
+item with optional parameter.
+Should be used only inside List::Description.
+=end
 class DT < Element
-	Element.add( [:dt],  DT)
-	add_attributes( HTML_ATTR_ALL ) 
-	def htmltag(); 'dt'; end
+	add_attributes  HTML_ATTR_ALL
+	add_html_tag 'dt'
 	def to_text(options={});	"\n#{@content.to_doc(:text, options )}: " end
 	def to_wiki(options={})
 		cmd	= ''
@@ -158,12 +177,15 @@ class DT < Element
 		return cmd
 	end
 end
-#HTML:
-#	<dl>
-#	<dt> <dd>
-#	</dl>
+=begin rdoc
+HTML:
+	<dl>
+	<dt> <dd>
+	</dl>
+
+Data for a description list.
+=end
 class DD < Element
-	Element.add( [:dd],  DD)
 	add_attributes( HTML_ATTR_ALL ) 
 	def htmltag(); 'dd'; end
 	def to_text(options={}); "\n\t#{@content.to_doc(:text, options)}\n" end
@@ -182,3 +204,5 @@ class DD < Element
 		return cmd
 	end
 end
+end #module Lists
+end #module Docgenerator