docgenerator 1.1.1 → 1.2.1

data/lib/{docgenerator_element.rb → docgenerator/element.rb}

@@ -1,70 +1,4 @@
-#Extend all objects by the methods 
-#- to_doc
-#- to_html
-#- to_latex
-#- to_wiki
-#- to_text
-#Redefine is_a?:
-#Return true, when you test with a symbol.
-class Object
-  alias :old_is_a? :is_a?
-  #Redefine the standard is_a?
-  #Returns also true, if one of the ids is in testvalue
-  def is_a?( testvalue)
-    if testvalue.old_is_a?(Symbol)
-      if old_is_a?(Element)
-        return ids.include?(testvalue) 
-      else
-        return false
-      end
-    else
-      return old_is_a?(testvalue)
-    end
-  end
-  #
-  # to_doc returns the object as a string.
-  # will be redefined for Element
-  #
-  def to_doc(target, options = {})
-    o = Docgenerator_logger.set_option_defaults(options)
-    str = ""
-    if self.is_a?(Element) and ! self.respond_to?(:to_doc)
-      o[:log].error( "Missing to_doc routine for #{self.class}") if o[:log].error?
-    end
-    if self.respond_to?(:to_str)
-      str << self.to_str
-    else
-      str << self.to_s
-    end
-    str
-  end
-  def to_text(options = {}); to_doc(:text, options);  end
-  def to_latex(options = {}); to_doc(:latex, options);  end
-  def to_html(options = {}); to_doc(:html, options);  end
-  def to_wiki(options = {}); to_doc(:wiki, options);  end
-end
-
-class Array
-  #
-  # Returns the element for each parameter
-  #
-  def to_doc(target, options = {})
-    o = Docgenerator_logger.set_option_defaults(options)
-    o[:log].debug("enter to_doc(#{target}) for Array, options: #{options.keys.inspect}") if o[:log].debug?
-    str = ""
-    self.each{|el|
-      begin
-        str << el.to_doc(target, o)
-      rescue ArgumentError
-        o[:log].fatal("ArgumentError to_doc for element <#{el.class}>") if o[:log].fatal?
-        str << el.to_doc(target)
-      end
-    }
-    return str
-  end
-end
-
-
+#encoding: utf-8
 #This class defines possible elements of a document.
 #For each type of elements a class is defined.
 #The definition can be done explicite or generic with Element.create.
@@ -77,17 +11,13 @@ end
 #But the error is done, when the element is created.
 #When you redefine ELEMENTS_TRACE, some tracing information are stored during creation.
 class Element
+  include Docgenerator  #get VERSION
   #Hash with all ids and their corresponding classes.
   @@ids = Hash.new( )
   #All attributes are stored in this hash.
   #The key is the corresponding class.
   @@attr  = { Element => {} }
-  #All output routines are stored in this hash.
-  #The key is the corresponding class.
-  @@log  = false
-  def Element.log=( log )
-    @@log = log
-  end
+
   #Flag, if the calling stack should be analysed for each Element
   #Only for document debbuging
   @@trace  = nil
@@ -97,6 +27,9 @@ class Element
   end
 
   SUPPORTED_TARGETS = [ :latex, :html, :wiki, :text, :debug ]
+  SUPPORTED_TARGETS << :context #Added later
+  SUPPORTED_TARGETS << :creole #Added later
+  
 
   #Return a element class.
   def Element.get( name )
@@ -107,7 +40,7 @@ class Element
   #
   #Add subclasses to the list of all element classes and initialize some internal hashes.
   def Element.inherited( subclass )
-    puts "New subclass for 'Element' created: '#{subclass}'" if @@log
+    DOCGENERATOR_LOGGER.debug("New subclass for 'Element' created: '#{subclass}'") if DOCGENERATOR_LOGGER.debug?
     #All attributes of a class are collected in a hash.
     @@attr[subclass]  = {}
     #Fill @@ids
@@ -128,13 +61,13 @@ class Element
     
     idlist.each{|id|
       if @@ids[ id ] == nil
-        puts "Element class '#{id}' is new: #{elementClass}" if @@log
+        DOCGENERATOR_LOGGER.debug("Element class '#{id}' is new: #{elementClass}") if DOCGENERATOR_LOGGER.debug?
         #All new ids are collected
         @@ids[ id ] = elementClass
       elsif  @@ids[ id ] == elementClass
-        puts "Element class '#{id}' is defined double: #{elementClass}" if @@log
+        DOCGENERATOR_LOGGER.warn("Element class '#{id}' is defined double: #{elementClass}") if DOCGENERATOR_LOGGER.warn?
       else
-        puts "Error: ID '#{id}' is redefined #{@@ids[id]} -> #{elementClass}"
+        DOCGENERATOR_LOGGER.error("Error: ID '#{id}' is redefined #{@@ids[id]} -> #{elementClass}") if DOCGENERATOR_LOGGER.error?
         @@ids[id] = elementClass
       end
     }
@@ -178,12 +111,16 @@ class Element
       case k
       when :latex
         elementclass.add_output( :latex,  v )
+      when :context
+        elementclass.add_output( :context,  v )
       when :html
         elementclass.add_output( :html,  v )
       when :text
         elementclass.add_output( :text,  v )
       when :wiki
         elementclass.add_output( :wiki,  v )
+      when :creole
+        elementclass.add_output( :creole,  v )
       when :htmltag
         if v
           elementclass.class_eval( "def htmltag()\n'#{v}'\nend" )
@@ -191,7 +128,7 @@ class Element
           elementclass.class_eval( "def htmltag()\nnil\nend" )
         end
       else
-        puts "Unknown format #{k} for #{name}"
+        puts "#{__FILE__}##{__LINE__}: Unknown format #{k} for #{name}"
       end
     }
     elementclass.add_attributes( attr )
@@ -252,12 +189,16 @@ class Element
     case target
     when :latex
       cmd = "def to_latex(options = {})\n"
+    when :context
+      cmd = "def to_context(options = {})\n"
     when :html
       cmd = "def to_html(options = {})\n"
     when :text
       cmd = "def to_text(options = {})\n"
     when :wiki
       cmd = "def to_wiki(options = {})\n"
+    when :creole
+      cmd = "def to_creole(options = {})\n"
     else
       puts "#{self}: Undefined target format #{target}"
     end
@@ -493,8 +434,13 @@ code
   end
   @@level = 0
   #Build a String to be used for the target document.
-  #Calls Element#to_latex (target :latex) 
-  #and Element#to_html (target :html).
+  #Calls 
+  #-Element#to_latex (target :latex), 
+  #-Element#to_context (target :context) 
+  #-Element#to_html (target :html)
+  #-Element#to_wiki (target :wiki) (support stopped)
+  #-Element#to_creole (target :creole)  (not really good results)
+  #-Element#to_text (target :text) (not really good results)
   #
   #Via the options-hash, you can transport additional information.
   def to_doc( target, options = {} )
@@ -517,13 +463,18 @@ code
     }
     #Build the string.
     result = ''
+
     case target
     when :latex
       result = to_latex(o)  
+    when :context
+      result = to_context(o)  
     when :html
       result = to_html(o)
     when :wiki
       result = to_wiki(o)
+    when :creole
+      result = to_creole(o)
     when :text
       result = to_text(o)
     else
@@ -551,6 +502,22 @@ code
     cmd  <<  "\n" if @crafter
     return cmd
   end
+  #Create context-output.
+  #
+  #ConTeXt-support is added later and there are a lot of gaps (2009-07-01)
+  def to_context(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].error("Missing output routine for ConTeXt (#{self.ids.join(',')}) [#{@called_by}]") if o[:log].error?
+    makroname = 'dummy'
+    self.ids.each{|id|
+      makroname = id if id.is_a?(Symbol) or id.is_a?(String)
+    }
+    cmd  =  ''
+    cmd  <<  "\n" if @crbefore
+    cmd  <<  "\\#{makroname}{#{@content}}"
+    cmd  <<  "\n" if @crafter
+    return cmd
+  end
   #Method for definition inside Element.create.
   def linebreak( flag = true )
     flag ? "\n" : ''
@@ -621,6 +588,11 @@ code
     o[:log].error("Missing output routine for Wiki (#{self.ids.join(',')}) [#{@called_by}]") if o[:log].error?
     return "#{@content.to_wiki(options)}\n"
   end
+  def to_creole(options = {})
+    o = Docgenerator_logger.set_option_defaults(options)
+    o[:log].error("Missing output routine for creole (#{self.ids.join(',')}) [#{@called_by}]") if o[:log].error?
+    return "#{@content.to_creole(options)}\n"
+  end
   def to_text(options = {})
     o = Docgenerator_logger.set_option_defaults(options)
     o[:log].error("Missing output routine for Text (#{self.ids.join(',')}) [#{@called_by}]") if o[:log].error?

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

@@ -13,8 +13,10 @@
 Element.create( [:head], {}, true, 
   {  :htmltag => 'head',
     :latex  => '#{@content}',
+    :context  => '#{@content}',
     :text    => '#{@content}',
     :wiki    => '#{@content}',
+    :creole   => '#{@content}',
   } )
 Element.create( [:body],  {
     :bgcolor  => Attribute.create( [ :html ] ),
@@ -26,43 +28,57 @@ Element.create( [:body],  {
   true, 
   {  :htmltag  => 'body',
     :latex  => '#{@content}',
+    :context => '#{@content}',
     :text    => '#{@content}',
     :wiki    => '#{@content}',
+    :creole    => '#{@content}',
   } )
 
 Element.create( [:latexdummy, :latexonly ], {},true, 
   {  :htmltag  => nil,
     :html  => '',
-    :latex  => '#{@content}'
+    :latex  => '#{@content}',
+    :context  => '',
   } )
 Element.create( [:htmldummy, :htmlonly ], {},true, 
   {  :html  => '#{@content}',
-    :latex  => ''
+    :latex  => '',
+    :context  => '',
   } )
 
 
-#
-#Titlepage
-#
-#This parameter are better set with Document.title.
-#
+=begin rdoc
+Titlepage
+
+This parameter are better set with Document.title.
+=end
 class Title < Element
   Element.add( [:title],  Title)
   add_attributes( {
       :short  => Attribute.create( [ :html ], nil, 1 )
     }.update(HTML_ATTR_ALL)
     )
-  #Unsaubere realisierung .. fixme
+=begin rdoc
+Does the LaTeX-class support the shorttitle-option?
+
+beamer.sty does it, others not.
+
+#Unsaubere realisierung .. fixme
+=end
   def shortoption( options = {} )
     @attr[:short].content.compact!  #delete nils.
     return nil  if ! @attr[:short].filled?
     o = Docgenerator_logger.set_option_defaults(options)
     o[:log].debug("enter shortoption") if o[:log].debug?
-    if o[:document]
-      if o[:document].template[:latex].template.include?('Beamer')
-        return "[#{@attr[:short].content}]" 
+    if o[:document]      
+      #Check for known classes, which support the optional short title
+      case o[:document].template[:latex].template
+        when /beamer/i, /festodoc/
+          return "[#{@attr[:short].content.join}]" 
+        else
+          o[:log].info("No usage of option short in title") if o[:log].info?          
       end      
-    else
+    else  #no related document
       o[:log].info("No related document for shortoption") if o[:log].info?
     end
     return nil
@@ -79,7 +95,9 @@ class Title < Element
   
   add_output( :text,  "\n" + '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}' + "\n")
   add_output( :wiki,  '#{linebreak(@crbefore)}' + '=#{@content}=' + ' #{linebreak(@crafter)}')
-end
+  add_output( :creole,  '#{linebreak(@crbefore)}' + '=#{@content}' + ' #{linebreak(@crafter)}')
+end #Title
+
 Element.create( [:meta], {
     :name  => Attribute.create( [ :html, :required ], nil, 1 ),
     :content  => Attribute.create( [ :html, :required ], nil, 2 ),
@@ -88,7 +106,11 @@ Element.create( [:meta], {
     :htmltag  => 'meta',
     #~ :html  => '<meta name="#{@attr[:name]}" content="#{@attr[:content]}">',
     :latex  => '',
+    :context  => '',
 #    :latex  => '#{linebreak(@crbefore)}' +  '\author{#{@content}}\hypersetup{pdfauthor={#{@content}}}' + ' #{linebreak(@crafter)}'
+    :wiki  => '',
+    :creole  => '',
+    :text  => '',
   } )
 #Like Meta, but not name...
 Element.create( [:meta2], {
@@ -220,8 +242,10 @@ Element.create( [:addtocontents], {
 Element.create( [:par, :p],  HTML_ATTR_ALL,  true, 
   {  :htmltag  =>  'p',
     :latex    =>  "\n\n" + '#{@content}' + "\n\n",
+    :context    =>  "\n\n" + '#{@content}' + "\n\n",
     :text    =>  "\n" +  '#{@content}' + "\n",  #siehe experimente/textformat.rb
-    :wiki    =>  "\n" +  '#{@content}' + "\n",
+    :wiki    =>  "\n" +  '#{@content}' + "\n",  #
+    :creole  =>  "\n" +  '#{@content}' + "\n\n",
   } )
 #~ par.add_output( :html,  '<p>#{@attr[:content]}</p>')
 #~ par.add_output( :latex,  '#{@content}\par')
@@ -437,11 +461,13 @@ class Usepackage < Element
   #Here we load this special commands/elements if available.
   def << ( content )
     @content << content
-    #Load new makros if available
-    makrodefinitions = 'docgenerator_' + content + '.rb'
+    #Load new additionals makros if available
+    makrodefinitions = 'packages/docgenerator_' + content + '.rb'
     begin
+      @log.debug("usepackage: Try to load #{makrodefinitions}") if @log.debug?
       require makrodefinitions 
     rescue LoadError 
+      @log.info("usepackage: No supporting definitions #{makrodefinitions} found") if @log.info?
     end 
   end  
   
@@ -453,7 +479,7 @@ class Usepackage < Element
     cmd << '\usepackage'
     opt = @attr[:option].content
     cmd << '[' + opt.join(',') + ']' if opt.size > 0
-    cmd << "{#{@content}}"
+    cmd << "{#{@content.join}}"
     cmd << linebreak(@crafter)
     return cmd
   end

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

@@ -15,7 +15,21 @@ class Environment < Element
 		cmd	<<	"\n" if @crafter
 		return cmd
 	end
-	#~ def htmltag()
+  #ConTeXt-environments start with start and end with stop.
+  #
+  #Fixme: Parameters
+	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	<<	"\n" if @crmid and cmd[-1,1] != "\n"
+		cmd	<<	"\n\\stop#{environment}\n"
+		cmd	<<	"\n" if @crafter
+		return cmd
+	end	#~ def htmltag()
 		#~ return 'table'
 	#~ end
 	#~ def to_latex( )
@@ -55,8 +69,8 @@ Element.create( [:verb ], HTML_ATTR_CORE, true,
     #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)}'
-		#~ :latex	=> '#{linebreak(@crbefore)}\verb{#{@content}}#{linebreak(@crafter)}'
+		:latex	=> '#{linebreak(@crbefore)}\verb|#{@content}|#{linebreak(@crafter)}',
+		:text	=> '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}',
 	} )
   
 class Verbatim < Environment
@@ -84,10 +98,10 @@ class Verbatim < Environment
     return html
   end  #to_html
   
-	def to_text(options = {}); "#{content}"	end
-	def to_wiki(options = {} ); " #{content}"	end
+	def to_text(options = {}); "#{content.join}"	end
+	def to_wiki(options = {} ); " #{content.join}"	end
 	def to_latex(options = {}  )
-		return to_latex_environment( 'verbatim', options = {}  )
+		return to_latex_environment( 'verbatim', nil, options = {}  )
 	end
 end
 

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

@@ -1,20 +1,29 @@
-#Attention!
-#
-#This is a 'global' group.
-#All footnotes of the actual programm are collected, not of one document!
-#
-#may be fixed in the future.
+=begin rdoc
+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
   #Define a default key for the footnotes.
   #Used as part of the link.
   DEFAULTGROUPID = 'footnote'
   DEFAULTGROUPID.freeze
-  #Build a new footnote group.
+  @@all = {}
+=begin rdoc
+=end
+  def self.[](key=DEFAULTGROUPID)
+    @@all[key]
+  end
+=begin rdoc
+Build a new footnote group.
+=end
 	def initialize( groupid = DEFAULTGROUPID)
 		@groupid		= groupid
 		@footnotes	= []
 		@attr		= {}
 		@html_link	= true
+    @@all[@groupid] = self
 	end
 	#Flag, if the footnote and the footnote mark should be linked.
 	attr_accessor :html_link
@@ -29,7 +38,7 @@ class Footnotegroup
 		return @footnotes.size
 	end
 	def to_doc( target, options={} )
-		return '' if @footnotes.size == 0
+		return '' if @footnotes.empty?
 		ul = element(:p, @attr ).cr
 		@footnotes.each{|f|
 			#~ ul << element(:sup, {}, f.counter )
@@ -46,9 +55,9 @@ class Footnotegroup
 	end
 end #Footnotegroup
 
-#
-# Footnotes
-#
+=begin rdoc
+Footnotes
+=end
 class Footnote < Element
 	Element.add( [:footnote ],  Footnote)
 	add_attributes( 		{
@@ -63,12 +72,12 @@ class Footnote < Element
   
   def initialize( attr={}, content = nil)
     super
-    @group = attr[:group]
+    @group = attr[:group] || Footnotegroup[]
     #@group must be defined!
     #This is only a dummy group. it will be lost for overviews.
     if ! @group.is_a?(Footnotegroup)
       @group = Footnotegroup.new()
-      @log.error( "Footnote: No group assigned. Build a new group") if @log.error?
+      #~ @log.error( "Footnote: No group assigned. Build a new group") if @log.error?
     end
     
     @group << self
@@ -109,13 +118,8 @@ class Footnote < Element
 end #Footnote
 
 
-
 Element.create( [:footnotemark ], {}.update(HTML_ATTR_ALL),true, 
 	{	:htmltag	=> 'sup',
 		:latex	=> '#{linebreak(@crbefore)}\footnotemark[#{@content.to_latex}]#{linebreak(@crafter)}'	#fixme
 	} )
 
-
-__END__
-	txt << f = element(:footnote,{:groupid=>1}, 'eins/Gruppe 1')
-	txt << Footnotegroup.get()