docgenerator 2.0.0 → 2.1.0

data/lib/docgenerator/element_meta.rb

@@ -18,60 +18,60 @@ Details see
   * Element.add_wiki_output
   * Element.add_text_output
 =end
-class Element
-  
-  #Hash with all ids and their corresponding classes.
-  @@ids = Hash.new( )
-  
+  class Element
+    
+    #Hash with all ids and their corresponding classes.
+    @@ids = Hash.new( )
+    
 =begin rdoc
 Meta-class for metaprogramming
 =end
-  class << self #Meta-class Element
+    class << self #Meta-class Element
 =begin rdoc
 This method is called, when a subclass of this class is defined.
 
 The class will be added to the element list with class name, converted to a symbol 
-(modules are extracted in adcance).
-The element ma be created with element-method.
+(modules are extracted in advance).
+The element may be created with element-method.
 =end
-  def inherited( subclass )
-    DOCGENERATOR_LOGGER.info("New Element class: #{subclass}") if DOCGENERATOR_LOGGER.debug?
-    if subclass.name
-      subclass.add_id(subclass.name.split('::').last.downcase.to_sym)
-    else
-      DOCGENERATOR_LOGGER.warn("New Element class without name: #{subclass}") if DOCGENERATOR_LOGGER.warn?
+    def inherited( subclass )
+      DOCGENERATOR_LOGGER.info("New Element class: #{subclass}") if DOCGENERATOR_LOGGER.debug?
+      if subclass.name
+        subclass.add_id(subclass.name.split('::').last.downcase.to_sym)
+      else
+        DOCGENERATOR_LOGGER.warn("New Element class without name: #{subclass}") if DOCGENERATOR_LOGGER.warn?
+      end
     end
-  end
 =begin rdoc
 Define meta/class accessor to element_ids.
 
 @element_ids isd defined in Element.add_id
 
 =end
-  def element_ids; @element_ids; end
+    def element_ids; @element_ids; end
 =begin rdoc
 Add a new element class or assign another name (synonym) for a class.
 The initial call is made by Element.inherited.
 =end
-  def add_id(id)
-    @element_ids ||= []
-    if @@ids[ id ] == nil
-      DOCGENERATOR_LOGGER.debug("Element id '#{id}' is new for #{self}") if DOCGENERATOR_LOGGER.debug?
-      #All new ids are collected
-      @@ids[ id ] = self
-      @element_ids << id
-    elsif  @@ids[ id ] == self
-      DOCGENERATOR_LOGGER.warn("Element class '#{id}' is defined double: #{self}") if DOCGENERATOR_LOGGER.warn?
-    else
-      DOCGENERATOR_LOGGER.error("Error: ID '#{id}' is redefined #{@@ids[id]} -> #{self}") if DOCGENERATOR_LOGGER.error?
-      @@ids[id] = self
-      @element_ids << id
+    def add_id(id)
+      @element_ids ||= []
+      if @@ids[ id ] == nil
+        DOCGENERATOR_LOGGER.debug("Element id '#{id}' is new for #{self}") if DOCGENERATOR_LOGGER.debug?
+        #All new ids are collected
+        @@ids[ id ] = self
+        @element_ids << id
+      elsif  @@ids[ id ] == self
+        DOCGENERATOR_LOGGER.warn("Element class '#{id}' is defined double: #{self}") if DOCGENERATOR_LOGGER.warn?
+      else
+        DOCGENERATOR_LOGGER.error("Error: ID '#{id}' is redefined #{@@ids[id]} -> #{self}") if DOCGENERATOR_LOGGER.error?
+        @@ids[id] = self
+        @element_ids << id
+      end
+    end
+    #Return a element class.
+    def get( name )
+      return @@ids[name]
     end
-  end
-  #Return a element class.
-  def get( name )
-    return @@ids[name]
-  end
 
 =begin rdoc
 Set flag, that the element does not support content.
@@ -110,11 +110,11 @@ Example:
       }
   end
 =end
-  def add_attributes( attr )
-    attr.each{ |k,a |
-      self.add_attribute(k,a)
-    }
-  end    
+    def add_attributes( attr )
+      attr.each{ |k,a |
+        self.add_attribute(k,a)
+      }
+    end    
 =begin rdoc
 Return the attributes for the metaclass.
 =end
@@ -126,9 +126,9 @@ Return the attributes for the metaclass.
 Returns list of attributes.
 Can be used for copying attributes from one class to another class.
 =end
-  def get_attribute_list()
-    return self.attributes
-  end
+    def get_attribute_list()
+      return self.attributes
+    end
   
 =begin rdoc
 Add an output routine.
@@ -189,115 +189,115 @@ Attributes can be accessed with @attr[:key]
 #texkeyval add all attributes with flag :texkeyval. (see Attribute#texkeyval?)
 
 =end
-  def add_output( target, string = nil, &proc )
-    
-    if ! [ :latex, :context, :html, :text, :wiki, :creole ].include?(target)
-      DOCGENERATOR_LOGGER.error("#{self}: Undefined target format #{target}") if DOCGENERATOR_LOGGER.error?
-    end
-    
-    if block_given?
-      if string
-        DOCGENERATOR_LOGGER.error("add_output #{target} contains result string and block. Use the block definietion #{self.inspect}") if DOCGENERATOR_LOGGER.error?
+    def add_output( target, string = nil, &proc )
+      
+      if ! [ :latex, :context, :html, :text, :wiki, :creole ].include?(target)
+        DOCGENERATOR_LOGGER.error("#{self}: Undefined target format #{target}") if DOCGENERATOR_LOGGER.error?
       end
-      #The (optional) parameter should be {} by default.
-      if proc.respond_to?(:parameters) #since ruby 1.9.2
-        if proc.parameters.size != 1  #Proc#parameters introduced with ruby 1.9.2
-          DOCGENERATOR_LOGGER.error("add_output #{target}: Arity of block not 1 but #{proc.parameters.inspect} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
-        elsif proc.parameters.first.first != :opt
-          DOCGENERATOR_LOGGER.error("add_output #{target}: Block parameter is not optional #{proc.parameters.inspect} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
-          #the optional parameter should have the default {}
-          #no way to test it, see http://forum.ruby-portal.de/viewtopic.php?f=22&t=12384
+      
+      if block_given?
+        if string
+          DOCGENERATOR_LOGGER.error("add_output #{target} contains result string and block. Use the block definietion #{self.inspect}") if DOCGENERATOR_LOGGER.error?
         end
-      else  #Proc#parameters not supported
-        if proc.arity > 1  #makes arity 0 also for optional parameters.
-          DOCGENERATOR_LOGGER.error("add_output #{target}: Arity of block not 1 but #{proc.arity} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
+        #The (optional) parameter should be {} by default.
+        if proc.respond_to?(:parameters) #since ruby 1.9.2
+          if proc.parameters.size != 1  #Proc#parameters introduced with ruby 1.9.2
+            DOCGENERATOR_LOGGER.error("add_output #{target}: Arity of block not 1 but #{proc.parameters.inspect} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
+          elsif proc.parameters.first.first != :opt
+            DOCGENERATOR_LOGGER.error("add_output #{target}: Block parameter is not optional #{proc.parameters.inspect} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
+            #the optional parameter should have the default {}
+            #no way to test it, see http://forum.ruby-portal.de/viewtopic.php?f=22&t=12384
+          end
+        else  #Proc#parameters not supported
+          if proc.arity > 1  #makes arity 0 also for optional parameters.
+            DOCGENERATOR_LOGGER.error("add_output #{target}: Arity of block not 1 but #{proc.arity} #{self.inspect}") if DOCGENERATOR_LOGGER.error?
+          end
         end
-      end
-      #Define the method.
-      define_method( "to_#{target}".to_sym, &proc )
-    else      #block_given?
+        #Define the method.
+        define_method( "to_#{target}".to_sym, &proc )
+      else      #block_given?
 =begin
 Define the output routine, based on a string.
 =end
-      if ! string.kind_of?( String )
-        DOCGENERATOR_LOGGER.error("<#{self.inspect}>#add_output: #{string.inspect} is no String")
-      end
-      cmd = <<-code
-      def to_#{target}(options = {})
-        o = set_option_defaults(options)
-        o[:log].debug("enter to_doc(#{target}) for #{self.inspect}, options: \#{options.keys.inspect}") if o[:log].debug?
-      code
-      template = string.gsub(/\\/, '\\\\\\')
-      template.gsub!(/"/, '\"')
-      #define recursive to_doc for content.
-      #the closing \} is important. Else you replace '@content.to_latex' with @content.to_doc.to_latex'
-      template.gsub!(/@content\}/, "@content.to_doc(#{target.inspect}, o)}")
-      cmd << "    \"#{template}\"\n"
-      cmd << "end\n"
-      class_eval( cmd )
-      cmd #return cmd for unit test
-    end #block_given? 
-  end
+        if ! string.kind_of?( String )
+          DOCGENERATOR_LOGGER.error("<#{self.inspect}>#add_output: #{string.inspect} is no String")
+        end
+        cmd = <<-code
+        def to_#{target}(options = {})
+          o = set_option_defaults(options)
+          o[:log].debug("enter to_doc(#{target}) for #{self.inspect}, options: \#{options.keys.inspect}") if o[:log].debug?
+        code
+        template = string.gsub(/\\/, '\\\\\\')
+        template.gsub!(/"/, '\"')
+        #define recursive to_doc for content.
+        #the closing \} is important. Else you replace '@content.to_latex' with @content.to_doc.to_latex'
+        template.gsub!(/@content\}/, "@content.to_doc(#{target.inspect}, o)}")
+        cmd << "    \"#{template}\"\n"
+        cmd << "end\n"
+        class_eval( cmd )
+        cmd #return cmd for unit test
+      end #block_given? 
+    end
 =begin rdoc
 Define the HTML-tag for the to_html method.
 =end
-  def add_html_tag( tag )
-    self.class_eval( "def htmltag()\n'#{tag}'\nend" )
-  end
+    def add_html_tag( tag )
+      self.class_eval( "def htmltag()\n'#{tag}'\nend" )
+    end
 =begin rdoc
 Define the output routine for html.
 See Element.add_output for details.
 =end
-  def add_html_output( output = nil, &cmd )
-    self.add_output(:html, output, &cmd )
-  end
+    def add_html_output( output = nil, &cmd )
+      self.add_output(:html, output, &cmd )
+    end
 =begin rdoc
 Define the output routine for LaTeX.
 See Element.add_output for details.
 =end
-  def add_latex_output( output = nil, &cmd )
-    self.add_output(:latex, output, &cmd )
-  end
+    def add_latex_output( output = nil, &cmd )
+      self.add_output(:latex, output, &cmd )
+    end
 =begin rdoc
 Define the output routine for conTeXt.
 See Element.add_output for details.
 =end
-  def add_context_output( output = nil, &cmd )
-    self.add_output(:context, output, &cmd )
-  end
+    def add_context_output( output = nil, &cmd )
+      self.add_output(:context, output, &cmd )
+    end
 =begin rdoc
 Define the output routine for text.
 See Element.add_output for details.
 =end
-  def add_text_output( output = nil, &cmd )
-    self.add_output(:text, output, &cmd )
-  end
+    def add_text_output( output = nil, &cmd )
+      self.add_output(:text, output, &cmd )
+    end
 =begin rdoc
 Define the output routine for wiki.
 See Element.add_output for details.
 =end
-  def add_wiki_output( output = nil, &cmd )
-    self.add_output(:wiki, output, &cmd )
-  end
+    def add_wiki_output( output = nil, &cmd )
+      self.add_output(:wiki, output, &cmd )
+    end
 =begin rdoc
 Define the output routine for creole.
 See Element.add_output for details.
 =end
-  def add_creole_output( output = nil, &cmd )
-    self.add_output(:creole, output, &cmd )
-  end
-  
-end #Meta-class Element
+    def add_creole_output( output = nil, &cmd )
+      self.add_output(:creole, output, &cmd )
+    end
+    
+  end #Meta-class Element
 
 =begin rdoc  
 Return all id's of the class.
 The ids are filled via Element.add_id
 =end
-  def element_ids()
-    #~ myids = []
-    #~ @@ids.each{|k,v| myids << k if v == self.class and k.class != Class }
-    return self.class.element_ids
-  end
+    def element_ids()
+      #~ myids = []
+      #~ @@ids.each{|k,v| myids << k if v == self.class and k.class != Class }
+      return self.class.element_ids
+    end
 
-end #Element
+  end #Element
 end #Docgenerator

data/lib/docgenerator/elements.rb

@@ -72,7 +72,7 @@ Define Element :htmldummy, :htmlonly
 =end
 class Htmldummy < Element
   add_id :htmlonly
-  add_html_output '#{@content}'
+  add_html_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
   add_latex_output ''
   add_context_output ''
   add_text_output ''
@@ -157,7 +157,7 @@ Define Element :meta2
 Like Meta, but without name.
 =end
 class Meta2 < Element
-  has_no_content ENDTAG
+  has_no_content ENDTAG   #meta w/o name
   add_attribute :"http-equiv", Attribute.create( [ :html, :required ], nil, 1 )
   add_attribute :content, Attribute.create( [ :html, :required ], nil, 2 )
   add_html_tag 'meta'
@@ -431,7 +431,7 @@ class Newline < Element
   add_id "br/"
   add_id "br"
   add_id :br
-  has_no_content ENDTAG
+  has_no_content ENDTAG #br
   add_attribute :clear, Attribute.create( [ :html ], ['all'] )
   add_html_tag 'br'
   add_latex_output '#{linebreak(@crbefore)}\newline #{linebreak(@crafter)}'
@@ -457,7 +457,7 @@ class Hrulefill < Element
   add_id "hr/"
   add_id "hr"
   add_id :hr
-  has_no_content ENDTAG
+  has_no_content ENDTAG #hr
   add_attribute :clear, Attribute.create( [ :html ], ['all'] )
   add_html_tag 'hr'
   add_wiki_output '----'
@@ -587,6 +587,7 @@ class Div < Element
   add_latex_output '#{linebreak(@crbefore)}\begingroup #{linebreak(@crmid)}#{@content}#{linebreak(@crmid)}\endgroup #{linebreak(@crafter)}'
   add_text_output '#{@content}'
   add_wiki_output '#{@content}'
+  add_creole_output '#{@content}'
 end #Div
 
 
@@ -645,8 +646,9 @@ class Url < Element
   add_attributes HTML_ATTR_I18N
   add_attributes HTML_ATTR_EVENTS
   add_attribute :lang, ATTR_LANG
-  add_html_output '#{linebreak(@crbefore)}<a href="#{@content}">#{@content}</a>#{linebreak(@crafter)}'
+  add_html_output '#{linebreak(@crbefore)}<a href = "#{@content}">#{@content}</a>#{linebreak(@crafter)}'
   add_latex_output '#{linebreak(@crbefore)}\url{#{@content}}#{linebreak(@crafter)}'
+  add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
 end #Url
 
 =begin rdoc
@@ -687,12 +689,16 @@ class Href < Element
   def to_wiki( options = {} )
     "[#{@attr[:href].to_s} #{@content.to_doc(:wiki, options)}]"
   end
+  def to_creole( options = {} )
+    "[[#{@attr[:href].to_s}|#{@content.to_doc(:creole, options)}]]"
+  end
   def to_latex( options = {} )
     cmd = linebreak(@crbefore)
     reference = @attr[:href].to_s
-    if reference.sub!(/\#/, '')  #Internal reference
+    if reference.sub!(/\A\#/, '')  #Internal reference
       cmd << "\\hyperlink{#{reference}}{#{@content.to_doc(:latex, options)}}"
     else  #external reference
+      #reference may not contain unmasked % or #
       cmd << "\\href{#{reference}}{#{@content.to_doc(:latex, options)}}"
     end
     cmd << linebreak(@crafter)
@@ -1013,6 +1019,8 @@ class Textbf < Element
   add_html_tag 'strong'
   add_latex_output '#{linebreak(@crbefore)}\textbf{#{@content}}#{linebreak(@crafter)}'
   add_wiki_output '#{linebreak(@crbefore)}'''#{@content}'''#{linebreak(@crafter)}'
+  #The additional space is wanted (else ** may be a itemize-list)
+  add_creole_output '#{linebreak(@crbefore)} **#{@content}**#{linebreak(@crafter)}'
   add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
 end #Textbf
 
@@ -1028,7 +1036,8 @@ Attributes are not defined for this element.
 class Emph < Element
   add_html_tag 'em'
   add_latex_output '#{linebreak(@crbefore)}\emph{#{@content}}#{linebreak(@crafter)}'
-  add_wiki_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
+  #~ add_wiki_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
+  add_creole_output '#{linebreak(@crbefore)}//#{@content}//#{linebreak(@crafter)}'
   add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
 end #Emph
 
@@ -1221,7 +1230,7 @@ Attributes may be:
 =end
 class Img < Element
   add_id :includegraphics
-  has_no_content ENDTAG
+  has_no_content ENDTAG   #img"
   add_attributes HTML_ATTR_CORE
   add_attribute :align, HTML_ATTR_ALIGN
   add_attribute :src, Attribute.create([:html, :latex, :required], [ String ], 1)
@@ -1259,7 +1268,8 @@ class Verb < Element
     #fixme font tt
     #~ :html	=> '#{linebreak(@crbefore)}<span style = "display: inline;white-space:pre;font-family:monospace">#{@content}</span>#{linebreak(@crafter)}',
   add_html_output	'#{linebreak(@crbefore)}<span style = "display: inline;white-space:pre;font-family:monospace">#{@content.join.gsub(/</, \'&lt;\').gsub(/>/, \'&gt;\')}</span>#{linebreak(@crafter)}'
-  add_latex_output '#{linebreak(@crbefore)}\verb|#{@content}|#{linebreak(@crafter)}'
+  add_latex_output '#{linebreak(@crbefore)}\verb|#{@content}|#{linebreak(@crafter)}' #\verb| |
+  #~ add_latex_output '#{linebreak(@crbefore)}\verb{#{@content}}#{linebreak(@crafter)}' #\verb{ }
   add_text_output '#{linebreak(@crbefore)}#{@content}#{linebreak(@crafter)}'
 end #Verb
 

data/lib/docgenerator/environments.rb

@@ -76,12 +76,14 @@ or
   Minipage.new( [ attributes, [content]] )
 Attributes may be:
 * :width: 
+* :pos: Optional position for LaTeX
 =end
 class Minipage < Element
   add_attribute :width, Attribute.create( [ :latex, :html ], [ String ] )
+  add_attribute :pos, Attribute.create( [ :latex ], [ 'b', 't' ] )
   add_html_tag 'div'
   add_latex_output '#{linebreak(@crbefore)}' +  
-					'\begin{minipage}{#{@attr[:width]}}'	+ '#{linebreak(@crmid)}' + 
+					'\begin{minipage}[#{@attr[:pos]}]{#{@attr[:width]}}'	+ '#{linebreak(@crmid)}' + 
 					'#{@content}'		+ '#{linebreak(@crmid)}' + 
 					'\end{minipage}'	+ '#{linebreak(@crafter)}'
 end #Minipage