xhtml_report_generator 1.1.0 → 2.0.0

data/README.md

@@ -1,2 +1,75 @@
 xhtml-report-generator
 ======================
+
+This project was written to provide an easy way to create valid xhtml documents.
+Usecases are the automatic creation of reports (e.g. program logs) with automatically created table of contents.
+xhtml-report-generator is not a Logger replacement, since the complete document is always kept in memory and
+only written to disk on demand. Hence in case of crashes the data might be lost.
+
+
+Example usage
+-------------
+In the following you can find a quick start on how to use xhtml-report-generator.
+Basically the project is built in a way that lets you supply your own methods for everything.
+By default "custom.rb" is loaded through instance eval, so you can check the corresponding documentation for available methods.
+
+Note that there is a major syntax change for "custom.rb" between version 1.x and 2.x of the gem.
+Here an example for version >= 2 of this gem is provided.
+
+Basically starting from version 2 the syntax for each method of custom.rb is unified. It accepts an hash of html attributes as argument, and the actual contents as block argument.
+
+def method({"attribute" => "value", "attribute" => "value"}) {contents}
+
+in addition the method naming convention was changed from camelCase to underscore to comply more with ruby conventions.
+ 
+<pre>
+require 'xhtml-report-generator'
+
+gen1 = XhtmlReportGenerator::Generator.new
+gen1.create_layout("Title")
+gen1.heading("h1", {"class" => "bothtoc"}) {"titel"}
+gen1.heading("h2") {"subtitel"}
+gen1.heading("h3") {"section"}
+gen1.content() {"content function: Hallo welt <br /> html test <span class=\"r\" >red span test</span>", {"class"=>"bold"}}
+gen1.html("<p class="italic">html function: Hallo welt <br /> html test <span class=\"r\" >red span test</span></p>")
+gen1.highlight(/Ha.*lt/)
+
+</pre>
+
+Changes from version 1.x to 2.x
+-------------------------------
+To ease with migration here is a list with the changed function names, please also check the new synopsis
+
+XhtmlReportGenerator::Generator :
+
+<pre>
+createXhtmlDoc  -> create_xhtml_document
+
+writeToFile	    -> write(file=@file, mode='w')
+</pre>
+
+Custom :
+
+<pre>
+createLayout 	-> create_layout(title, layout=3)
+
+setTitle		-> set_title(title)
+
+getTitle		-> get_title
+
+setCurrent!		-> set_current!(xpath)
+
+getCurrent		-> get_current
+
+highlightCaptures -> highlight_captures(regex, color="y", el = @current)
+
+code 			-> code(attrs={}, &block)
+
+content			-> content(attrs={}, &block)
+
+heading			-> heading(tag_type="h1", attrs={}, &block)
+
+headingTop		-> heading_top(tag_type="h1", attrs={}, &block)
+
+</pre>
+

data/lib/xhtml_report_generator.rb

@@ -9,7 +9,7 @@ module XhtmlReportGenerator
   # This is the main generator class. It can be instanced with custom javascript, css, and ruby files to allow
   # generation of arbitrary reports.
   class Generator
-    attr_accessor :document
+    attr_accessor :document, :file
     # @param opts [Hash] See the example for an explanation of the valid symbols
     # @example Valid symbols for the opts Hash
     #   :jquery       if specified, path to a version of jquery, that will be inlined into the html header section
@@ -21,9 +21,9 @@ module XhtmlReportGenerator
       # define the default values
       path = File.expand_path("../xhtml_report_generator", __FILE__)
       symbols = {
-        :jquery => File.expand_path("jquery.js",path),
-        :toc => File.expand_path("toc.js",path),
-        :css => File.expand_path("style_template.css",path),
+        :jquery    => File.expand_path("jquery.js",path),
+        :toc       => File.expand_path("toc.js",path),
+        :css       => File.expand_path("style_template.css",path),
         :css_print => File.expand_path("print_template.css",path),
         :custom_rb => File.expand_path("custom.rb",path)
       }
@@ -37,7 +37,7 @@ module XhtmlReportGenerator
       # all existing Generator classes
       instance_eval symbols[:custom_rb]
 
-      @document = Generator.createXhtmlDoc("Title")
+      @document = Generator.create_xhtml_document("Title")
       head = @document.elements["//head"]
       # insert the custom css, and javascript files
       style = head.add_element("style", {"type" => "text/css"})
@@ -56,7 +56,7 @@ module XhtmlReportGenerator
 
     # Creates a minimal valid xhtml document including header title and body elements
     # @param title [String] Title in the header section
-    def self.createXhtmlDoc(title)
+    def self.create_xhtml_document(title)
       header = '<?xml version="1.0" encoding="UTF-8" standalone="no"?>'
       header += '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">'
 
@@ -74,7 +74,7 @@ module XhtmlReportGenerator
     # @param indent [Number] indent for child elements. defaults to 0.
     def to_s(indent = 0)
       output = ""
-      # note transitive is needed to preserve newlines in <pre> tags
+      # note :  transitive is needed to preserve newlines in <pre> tags
       # note2:  the hash options syntax is supported only from ruby version >= 2.0.0 we need the old style
       #         for compatibility with 1.9.3
       #@document.write({:output=>output, :indent=>indent, :transitive=>true})
@@ -82,12 +82,19 @@ module XhtmlReportGenerator
       return output
     end
     
-    # saves the xml document as a file
-    # @param file [String] absolute or relative path to the file to which will be written.
+    # Saves the xml document to a file. If no file is given, the file which was used most recently for this Generator
+    # object will be overwritten.
+    # @param file [String] absolute or relative path to the file to which will be written. Default: last file used.
     # @param mode [String] defaults to 'w', one of the file open modes that allows writing ['r+','w','w+','a','a+']
-    def writeToFile(file, mode='w')
+    def write(file=@file, mode='w')
+      # instance variables are nil if they were never initialized
+      if file == nil
+        raise "no valid file given"
+      end
+      @file = file
       File.open(file, "#{mode}:UTF-8") {|f| f.write(self.to_s)}
     end
+    
   end
 end
 

data/lib/xhtml_report_generator/custom.rb

@@ -5,28 +5,42 @@ module Custom
   # creates the basic page layout and sets the current Element to the main content area (middle div)
   # @example The middle div is matched by the following xPath
   #   //body/div[@class='middle']
-  def createLayout
+  # @param title [String] the title of the document
+  # @param layout [Fixnum] one of 0,1,2,3 where 0 means minimal layout without left and right table of contents,
+  #   1 means only left toc, 2 means only right toc, and 3 means full layout with left and right toc.
+  def create_layout(title, layout=3)
+    raise "invalid layout selector, choose from 0..3" if (layout < 0) || (layout > 3)
+    
     @body = @document.elements["//body"]
     # only add the layout if it is not already there
     if !@layout
       @body.add_element("div", {"class" => "head"})
+      
+      if (layout & 0x1) != 0
       div = @body.add_element("div", {"class" => "lefttoc", "id" => "ltoc"})
       div.add_text("Table of Contents")
       div.add_element("br")
+      end
+      
+      if (layout & 0x2) != 0
       div = @body.add_element("div", {"class" => "righttoc", "id" => "rtoc"})
       div.add_text("Quick Links")
       div.add_element("br");div.add_element("br")
+      end
+      
       @div_middle = @body.add_element("div", {"class" => "middle"})
       @layout = true
     end
     @current = @document.elements["//body/div[@class='middle']"]
+    set_title(title)
   end
 
-  # sets the title of the document in the header section as well as in the layout.
-  # createLayout must be called before!
-  def setTitle(title)
-    if !@layout 
-      raise "call createLayout first"
+  # sets the title of the document in the <head> section as well as in the layout header div  
+  # create_layout must be called before!
+  # @param title [String] the text which will be insertead
+  def set_title(title)
+    if !@layout
+      raise "call create_layout first"
     end
     pagetitle = @document.elements["//head/title"]
     pagetitle.text = title
@@ -35,48 +49,64 @@ module Custom
   end
 
   # returns the title text of the report
-  def getTitle()
+  # @return [String] The title of the report
+  def get_title()
     pagetitle = @document.elements["//head/title"]
     return pagetitle.text
   end
 
   # set the current element to the element or first element matched by the xpath expression.
   # The current element is the one which can be modified through highlighting.
-  # @param xpath [REXML::Element|String] the element or a string
-  def setCurrent!(xpath)
+  # @param xpath [REXML::Element|String] the element or an xpath string
+  def set_current!(xpath)
     if xpath.is_a?(REXML::Element)
       @current = xpath
-    else
+    elsif xpath.is_a?(String)
       @current = @document.elements[xpath]
+    else 
+      raise "xpath is neither a String nor a REXML::Element"
     end
   end
 
   # returns the current xml element
-  def getCurrent()
+  # @return [REXML::Element] the xml element after which the following elements will be added
+  def get_current()
     return @current
   end
 
   # Appends a <pre> node after the @current node
-  def code(text, attrs={})
+  # @param attrs [Hash] attributes for the <pre> element
+  # @yieldreturn [String] the text to be added to the <pre> element
+  # @return [REXML::Element] the Element which was just added
+  def code(attrs={}, &block)
     temp = REXML::Element.new("pre")
     temp.add_attributes(attrs)
     @div_middle.insert_after(@current, temp)
     @current = temp
+    raise "Block argument is mandatory" unless block_given?
+    text = block.call()
     @current.add_text(text)
     return @current
   end
 
   # Appends a <p> node after the @current node
-  def content(text, attrs={})
+  # @param attrs [Hash] attributes for the <p> element
+  # @yieldreturn [String] the text to be added to the <p> element
+  # @return [REXML::Element] the Element which was just added
+  def content(attrs={}, &block)
     temp = REXML::Element.new("p")
     temp.add_attributes(attrs)
     @div_middle.insert_after(@current, temp)
     @current = temp
+    raise "Block argument is mandatory" unless block_given?
+    text = block.call()
     @current.add_text(text)
     return @current
   end
 
   # insert arbitrary xml code after the @current element in the content pane (div middle)
+  # @param text [String] valid xhtml code which is included into the document
+  # @return [REXML::Element] the Element which was just added 
   def html(text)
     # we need to create a new document with a pseudo root
     doc = REXML::Document.new("<root>"+text+"</root>")
@@ -87,15 +117,22 @@ module Custom
     end
     return @current
   end
-
-  # puts a <span> </span> tag around all captures of the regex
+  
+  # Scans all REXML::Text children of an REXML::Element for any occurrences of regex.
+  # The text will be matched as one, not line by line as you might think.
+  # If you want to write a regexp matching multiple lines keep in mind that the dot "." by default doesn't 
+  # match newline characters. Consider using the "m" option (e.g. /regex/m ) which makes dot match newlines
+  # or match newlines explicitly.
+  # highlight_captures then puts a <span> </span> tag around all captures of the regex
   # NOTE: nested captures are not supported and don't make sense in this context!!
   # @param regex [Regexp] a regular expression that will be matched
   # @param color [String] at this point one of "y", "r", "g", "b" (yellow, red, green, blue) is supported
-  # @param el [REXML::Element] the Element (scope) which will be searched for pattern matches
-  def highlightCaptures(regex, color="y", el = @current)
+  # @param el [REXML::Element] the Element (scope) which will be searched for pattern matches, by default the last inserted element will be scanned
+  # @return [Fixnum] the number of highlighted captures
+  def highlight_captures(regex, color="y", el = @current)
     # get all children of the current node
     arr = el.to_a()
+    num_matches = 0
     # depth first recursion into grand-children
     for i in arr do
       # detach from current
@@ -106,32 +143,40 @@ module Custom
 
         # We get an array of [[start,length], [start,length], ...] for all our regex SUB-matches
         positions = i.value().enum_for(:scan, regex).flat_map {
-          # Regexp.last_match is a MatchData object, the index 0 is the entire match and
-          # indices 1..n are the captures (sub expressions)
+          # Regexp.last_match is a MatchData object, the index 0 is the entire match, 1 to n are captures
           array = Array.new
           for k in 1..Regexp.last_match.length - 1 do
             array.push([Regexp.last_match.begin(k),
               Regexp.last_match.end(k)-Regexp.last_match.begin(k)])
           end
+          # return the array for the flat_map
           array
         }
-        replaceTextWithElements(el, i, "span", {"class" => color}, positions)
+        num_matches += positions.length
+        replace_text_with_elements(el, i, "span", {"class" => color}, positions)
       else
         # for non-text nodes we recurse into it and finally reattach to our parent to preserve ordering
-        highlight(regex, color, i)
+        num_matches += highlight_captures(regex, color, i)
         el.add(i)
       end # if  i.class.to_s()  == "REXML::Text"
     end # for i in arr do
-
+    return num_matches
   end
 
-  # puts a <span> </span> tag around all matches of regex
+  # Scans all REXML::Text children of an REXML::Element for any occurrences of regex.
+  # The text will be matched as one, not line by line as you might think.
+  # If you want to write a regexp matching multiple lines keep in mind that the dot "." by default doesn't 
+  # match newline characters. Consider using the "m" option (e.g. /regex/m ) which makes dot match newlines
+  # or match newlines explicitly.
+  # highlight then puts a <span> </span> tag around all matches of regex
   # @param regex [Regexp] a regular expression that will be matched
   # @param color [String] at this point one of "y", "r", "g", "b" (yellow, red, green, blue) is supported
   # @param el [REXML::Element] the Element (scope) which will be searched for pattern matches
+  # @return [Fixnum] the number of highlighted captures
   def highlight(regex, color="y", el = @current)
     # get all children of the current node
     arr = el.to_a()
+    num_matches = 0
     #puts arr.inspect
     # depth first recursion into grand-children
     for i in arr do
@@ -147,23 +192,26 @@ module Custom
           [Regexp.last_match.begin(0),
             Regexp.last_match.end(0)-Regexp.last_match.begin(0)]
         }
-        replaceTextWithElements(el, i, "span", {"class" => color}, positions)
+        num_matches += positions.length
+        replace_text_with_elements(el, i, "span", {"class" => color}, positions)
       else
         # for non-text nodes we recurse into it and finally reattach to our parent to preserve ordering
         # puts "recurse"
-        highlight(regex, color, i)
+        num_matches += highlight(regex, color, i)
         el.add(i)
       end # if  i.class.to_s()  == "REXML::Text"
     end # for i in arr do
+    return num_matches
   end
 
   # creates a html table from two dimensional array of the form Array[row][col]
-  # @param table_data [Array] containing all data, the '.to_s' method will be called on each element
+  # @param table_data [Array<Array>] of the form Array[row][column] containing all data, the '.to_s' method will be called on each element, 
   # @param headers [Number] either of 0, 1, 2, 3. Where 0 is no headers (<th>) at all, 1 is only the first row,
   #   2 is only the first column and 3 is both, first row and first column as <th> elements. Every other number
   #   is equivalent to the bitwise AND of the two least significant bits with 1, 2 or 3
-  def table (table_data, headers=0, table_attrs={}, tr_attrs={}, th_attrs={}, td_attrs={})
-    
+  # @return [REXML::Element] the Element which was just added 
+  def table(table_data, headers=0, table_attrs={}, tr_attrs={}, th_attrs={}, td_attrs={})
+
     temp = REXML::Element.new("table")
     temp.add_attributes(table_attrs)
 
@@ -189,60 +237,63 @@ module Custom
   end
 
   # Appends a new heading element to body, and sets current to this new heading
-  # @param text [String] the heading text
-  # @param type [String] specifiy "h1", "h2", "h3" for the heading
-  # @param toc [symbol] one of :ltoc, :rtoc, :btoc  depending on in which toc you want to display the heading
-  # @return the added element
-  def heading(text, type="h1", toc=:ltoc)
-    case toc
-    when :rtoc
-      opts = {"class" => "onlyrtoc"}
-    when :btoc
-      opts = {"class" => "bothtoc"}
-    else
-      opts = {}
-    end
-
-    temp = REXML::Element.new(type)
-    temp.add_attributes(opts)
+  # @param tag_type [String] specifiy "h1", "h2", "h3" for the heading, defaults to "h1"
+  # @param attrs [Hash] attributes for the <h#> element, any valid html attributes can be specified
+  # @option attrs [String] "class" by default every heading is added to the left table of contents (toc)
+  #   use the class "onlyrtoc" or "bothtoc" to add a heading only to the right toc or to both tocs respectively
+  # @yieldreturn [String] the text to be added to the <h#> element
+  # @return [REXML::Element] the Element which was just added
+  def heading(tag_type="h1", attrs={}, &block)
+    temp = REXML::Element.new(tag_type)
+    temp.add_attributes(attrs)
 
     @div_middle.insert_after(@current, temp)
     @current = temp
+    raise "Block argument is mandatory" unless block_given?
+    text = block.call()
     @current.text = text
     return @current
   end
-  
-# Inserts a new heading element at the very beginning of the middle div section, and points @current to this heading
-# @param text [String] the heading text
-# @param type [String] specifiy "h1", "h2", "h3" for the heading
-# @param toc [symbol] one of :ltoc, :rtoc, :btoc  depending on in which toc you want to display the heading
-# @return the added element
-def headingTop(text, type="h1", toc=:ltoc)
-  case toc
-  when :rtoc
-    opts = {"class" => "onlyrtoc"}
-  when :btoc
-    opts = {"class" => "bothtoc"}
-  else
-    opts = {}
-  end
 
-  temp = REXML::Element.new(type)
-  temp.add_attributes(opts)
-  # insert before the first child of div middle
-  @div_middle.insert_before("//div[@class='middle']/*[1]", temp)
-  @current = temp
-  @current.text = text
-  return @current
-end
+  # Inserts a new heading element at the very beginning of the middle div section, and points @current to this heading
+  # @param tag_type [String] specifiy "h1", "h2", "h3" for the heading, defaults to "h1"
+  # @param attrs [Hash] attributes for the <h#> element, any valid html attributes can be specified
+  # @option attrs [String] "class" by default every heading is added to the left table of contents (toc)
+  #   use the class "onlyrtoc" or "bothtoc" to add a heading only to the right toc or to both tocs respectively
+  # @yieldreturn [String] the text to be added to the <h#> element
+  # @return [REXML::Element] the Element which was just added
+  def heading_top(tag_type="h1", attrs={}, &block)
+    temp = REXML::Element.new(tag_type)
+    temp.add_attributes(attrs)
+    # insert before the first child of div middle
+    @div_middle.insert_before("//div[@class='middle']/*[1]", temp)
+    @current = temp
+    raise "Block argument is mandatory" unless block_given?
+    text = block.call()
+    @current.text = text
+    return @current
+  end
 
+  # Helper Method for the highlight methods. it will introduce specific xhtml tags around parts of a text child of an xml element.
+  # @example
+  #   we have the following xml part
+  #   <test>
+  #     some arbitrary
+  #     text child content
+  #   </test>
+  #   now we call replace_text_with_elements to place <span> around the word "arbitrary" 
+  #   =>
+  #   <test>
+  #     some <span>arbitrary</span>
+  #     text child content
+  #   </test>
   # @param element [REXML::Element] the element in whose text tags will be added at the specified indices of @index_length_array
   # @param parent [REXML::Element] the parent to which @element should be attached after parsing
   # @param tagname [String] the tag that will be introduced as <tagname> at the indices specified
   # @param attribs [Hash] Attributes that will be added to the inserted tag e.g. <tagname attrib="test">
   # @param index_length_array [Array] Array of the form [[index, lenght], [index, lenght], ...] that specifies
   #                                   the start position and length of the substring around which the tags will be introduced
-  def replaceTextWithElements(parent, element, tagname, attribs, index_length_array)
+  def replace_text_with_elements(parent, element, tagname, attribs, index_length_array)
     last_end = 0
     index = 0
     #puts index_length_array.inspect
@@ -275,7 +326,7 @@ end
 
   end
 
-  #private_instance_methods(:replaceTextWithElements)
+  #private_instance_methods(:replace_text_with_elements)
 
 end
 

data/lib/xhtml_report_generator/toc.js

@@ -1,2 +1 @@
-// "THE BEER-WARE LICENSE" (Revision 42): m-widmer@gmx wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return Manuel Widmer
-$(document).ready(function(){$("td").each(function(b){b=$(this);null!==b.html().match(/passed/)&&b.attr("style","background-color:#00FF00;");null!==b.html().match(/failed/)&&b.attr("style","background-color:#FF0000;")});$("[class=rtoconly],[class=bothtoc]").each(function(b){var a=$(this);type=a.attr("class");a.attr("id",type+b);$("#rtoc").append("<a href='#"+type+b+"'>"+a.html()+"</a> <br />\n")});h3index=h2index=h1index=0;$("h1, h2, h3, a.h2, a.h1").each(function(b){var a=$(this);void 0==a.attr("id")&& a.attr("id","title"+b);if("h1"==a.prop("tagName"))h1index+=1,h3index=h2index=0,a.prepend(h1index+" "),$("#ltoc").append("<br />\n"),lasth1="#"+a.attr("id"),lasth1cont=a.html();else if("h2"==a.prop("tagName"))h2index+=1,h3index=0,a.prepend(h1index+"."+h2index+" "),lasth2="#"+a.attr("id"),lasth2cont=a.html();else if("h3"==a.prop("tagName"))h3index+=1,a.prepend(h1index+"."+h2index+"."+h3index+" ");else{if("h1"==a.attr("class"))return a.attr("href",lasth1),a.html(lasth1cont),0;if("h2"==a.attr("class"))return a.attr("href", lasth2),a.html(lasth2cont),0}if("rtoconly"==a.attr("class"))return 0;$("#ltoc").append("<a id='link"+b+"' href='#"+a.attr("id")+"' >"+a.html()+"</a> <br />\n");return 0})});
+$(document).ready(function(){$("td").each(function(b){b=$(this);null!==b.html().match(/passed/)&&b.attr("style","background-color:#00FF00;");null!==b.html().match(/failed/)&&b.attr("style","background-color:#FF0000;")});$("[class=rtoconly],[class=bothtoc]").each(function(b){var a=$(this);type=a.attr("class");a.attr("id",type+b);$("#rtoc").append("<a href='#"+type+b+"'>"+a.html()+"</a> <br />\n")});h3index=h2index=h1index=0;$("h1, h2, h3, a.h2, a.h1").each(function(b){var a=$(this);void 0==a.attr("id")&&a.attr("id","title"+b);if("h1"==a.prop("tagName"))h1index+=1,h3index=h2index=0,a.prepend(h1index+" "),$("#ltoc").append("<br />\n"),lasth1="#"+a.attr("id"),lasth1cont=a.html();else if("h2"==a.prop("tagName"))h2index+=1,h3index=0,a.prepend(h1index+"."+h2index+" "),lasth2="#"+a.attr("id"),lasth2cont=a.html();else if("h3"==a.prop("tagName"))h3index+=1,a.prepend(h1index+"."+h2index+"."+h3index+" ");else{if("h1"==a.attr("class"))return a.attr("href",lasth1),a.html(lasth1cont),0;if("h2"==a.attr("class"))return a.attr("href",lasth2),a.html(lasth2cont),0}if("rtoconly"==a.attr("class"))return 0;$("#ltoc").append("<a id='link"+b+"' href='#"+a.attr("id")+"' >"+a.html()+"</a> <br />\n");return 0})});

data/lib/xhtml_report_generator/version.rb

@@ -1,5 +1,5 @@
 module XhtmlReportGenerator
-  VERSION = '1.1.0'
+  VERSION = '2.0.0'
 end
 
 # puts XhtmlReportGenerator::VERSION

metadata

@@ -1,61 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: xhtml_report_generator
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Manuel Widmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-08-19 00:00:00.000000000 Z
 dependencies: []
-description: "The generator can be used to create xhtml files. It comes with some
+description: ! "The generator can be used to create xhtml files. It comes with some
   default utility functions.\n== Here is an example usage\n  gen1 = XhtmlReportGenerator::Generator.new\n
-  \ gen1.createLayout\n  gen1.setTitle(\"Example Report\")\n  gen1.heading(\"titel\",
-  \"h1\", :btoc)\n  gen1.heading(\"subtitel\", \"h2\", :ltoc)\n  gen1.heading(\"section\",
-  \"h3\")\n  gen1.content(\"content function: Hallo welt <br /> html test <span class=\"r\"
-  >red span test</span>\", {\"class\"=>\"bold\"})\n  gen1.html(\"<p class=\"italic\">html
-  function: Hallo welt <br /> html test <span class=\"r\" >red span test</span></p>\")\n\nThe
-  javascript to render the table of contents, the custom generator functions and style
-  sheet all can be\nsupplied by your own, if necessary. \n"
+  \ gen1.create_layout(\"Title\")\n  gen1.heading(\"h1\", {\"class\" => \"bothtoc\"})
+  {\"titel\"}\n  gen1.heading(\"h2\") {\"subtitel\"}\n  gen1.heading(\"h3\") {\"section\"}\n
+  \ gen1.content() {\"content function: Hallo welt <br /> html test <span class=\"r\"
+  >red span test</span>\", {\"class\"=>\"bold\"}}\n  gen1.html(\"<p class=\"italic\">html
+  function: Hallo welt <br /> html test <span class=\"r\" >red span test</span></p>\")\n
+  \ gen1.highlight(/Ha.*lt/)\n  \nThe javascript to render the table of contents,
+  the custom generator functions and style sheet all can be\nsupplied by your own,
+  if necessary. \n"
 email: m-widmer@gmx.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
-- README.md
-- lib/xhtml_report_generator.rb
 - lib/xhtml_report_generator/custom.rb
 - lib/xhtml_report_generator/jquery.js
 - lib/xhtml_report_generator/print_template.css
 - lib/xhtml_report_generator/style_template.css
 - lib/xhtml_report_generator/toc.js
 - lib/xhtml_report_generator/version.rb
+- lib/xhtml_report_generator.rb
+- LICENSE
+- README.md
 homepage: https://rubygems.org/gems/xhtml_report_generator
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 1.8.30
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: A simple and quick xhtml report generator
 test_files: []
 has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 8245325d398df596821aad2471b7fe703e541f1c
-  data.tar.gz: 8090a12abf591da6ee1f7af51483f142228dd029
-SHA512:
-  metadata.gz: f1195b1d581cfc0c25c47d077603e8f53a77e85d79e0ad28f5805a62464bd7427f040fafd6405fd112f390f69f6428b721c109e2dfdb9d9481796ddb1f8095ef
-  data.tar.gz: 39a0c261ac28951b05c1ed55bea11111f0cb00f66e0696cde7b800ee07ba1b9a0e6b1b55b3f9af1c27809d0c1b00e0569a44643edc826bb87ac18b24f5640316