docgenerator 2.1.0 → 2.1.1

data/lib/creole/creole_tabular.rb

@@ -1,21 +1,9 @@
 #encoding: UTF-8
 
-
-<<fixme
-taboptions:
-  - border=:  HTML
-  - .* = (.*): Used for CSS
-newline-options  
-  - toprule
-  - midrule
-  - hline
-  - .* = (.*): Used for CSS
-lineoptions:
-  - colspan = 
-  - pos
-  - .* = (.*): Used for CSS
-fixme
-
+if $0 == __FILE__ #for immediate tests  
+  $:.unshift('..')
+  require 'creole/creole2doc.rb' 
+end
 
 module Docgenerator
   module Creole
@@ -74,7 +62,6 @@ Usage:
         content.each{|line|
           @tab << row = element(:row).cr
           line.each{|cell|
-          #fixme cell to wiki/creole
             row << element(cell.type,{}, cell.content).cr
           }
         }
@@ -117,11 +104,30 @@ You can add additional settings to cells:
   |||class=empty
   >>>
 =end
-  class Creole_tabular < Placeholder
-    set_placeholder_key 'tabular'
-    
-    #Extend the class by a little structure
-    class Cell 
+    class Creole_tabular < Placeholder
+      set_placeholder_key 'tabular'
+      
+      #Define a container for cells
+      class Row 
+        #Flag for hline
+        attr_accessor :hline
+        #Flag for toprule
+        attr_accessor :toprule
+        #Flag for midrule
+        attr_accessor :midrule
+        #Add a cell to a row
+        def << (cell)
+          @cells = [] unless @cells
+          @cells << cell
+        end
+        def each
+          @cells.each{|cell| yield cell }
+        end
+        #Return number of cells
+        def size; @cells.size; end
+      end
+      #Extend the class by a little structure
+      class Cell 
 =begin rdoc
 The content of a cell is separated from settings by two ||
 
@@ -132,148 +138,246 @@ Supported additional settings:
 * class= define HTML-class
 * title= define a title (results in popup during mouse-over)
 =end
-      def initialize( content, type, wiki, local_options )
-        @content, options = content.split(/\|\|/,2)
-        @content = '' unless @content #just in case of empty content
-        @options = {}
-        options.split(/\|/).each{|option|
-          case option
-            when /class\s*=\s*/
-              @options[:class] = $~.post_match
-            when /css\s*=\s*/
-              @options[:style] = $~.post_match
-            when /title\s*=\s*/
-              @options[:title] = $~.post_match
-            when /pos\s*=\s*/ #only for multicol
-              @options[:pos] = $~.post_match
-            when /columns\s*=\s*/
-              wiki.log.debug("Creole_tabular::Cell #{type} converted to multicol")
-              type = :multicolumn #loose th/td-information -- fixme 
-              @options[:colspan] = $~.post_match.to_i
-            when '' #ignore them
-            else
-              wiki.log.warn("Creole_tabular::Cell: Undefined option #{option.inspect}")
+        def initialize( content, type, wiki, local_options )
+          @content, options = content.split(/\|\|/,2)
+          @content = '' unless @content #just in case of empty content
+          @options = {}
+          options.split(/\|/).each{|option|
+            case option
+              when /class\s*=\s*/
+                @options[:class] = $~.post_match
+              when /css\s*=\s*/
+                @options[:style] = $~.post_match
+              when /title\s*=\s*/
+                @options[:title] = $~.post_match
+              when /pos\s*=\s*/ #only for multicol
+                @options[:pos] = $~.post_match
+              when /columns\s*=\s*/
+                wiki.log.debug("Creole_tabular::Cell #{type} converted to multicol")
+                type = :multicolumn #loose th/td-information -- fixme 
+                @options[:colspan] = $~.post_match.to_i
+              when '' #ignore them
+              else
+                wiki.log.warn("Creole_tabular::Cell: Undefined option #{option.inspect}")
+              end
+          } if options
+          @type  = type #:td or :th
+          @wiki   = wiki
+          @local_options = local_options
+        end
+        #Return the content as a element.
+        def cell_element()
+          element(@type,@options, @wiki.inline(@content, @local_options)).cr
+        end
+      end #class Cell
+      
+      #Build the tabular.
+      def close()
+        #~ fixme:
+        #~ *CSS-format
+        #~ *generelle def
+        
+        step = 0  #start
+        head = []
+        content = [Row.new]
+        
+        options = { :log => @log }
+        local_options = {
+                        :log => @log,
+                        :inclusions => @wiki.inclusions,
+                        :plugins => @wiki.plugins.dup
+        }
+        #No footnotes inside tabulars
+        local_options[:plugins].delete('footnote')
+        local_options[:plugins].delete('footnotes')
+        
+        tab_css = CSS.new( :log => @log )
+        @source.each{|cell|
+          case cell
+            when /^\|!/   #generell cell definition
+              case $~.post_match().strip
+                when /columns\s*=\s*(.*)/
+                  options[:columns] = $1.to_i
+                when /border\s*=\s*(.*)/
+                  options[:border] = $1
+                when /columndescription\s*=\s*(.*)/
+                  options[:columndescription] = $1
+                when /css\s*=\s*(.*)\s*:\s*(.*)/
+                  tab_css[$1] = $2
+                when '' #
+                else
+                  @log.warn("#{self}: Unknown tabular option #{$1}") if @log.warn?
+              end
+            when /^\|-(.*)/   #new line
+              if $1 #there are options for the row
+                $1.split(/\|/).each{|option|
+                  case option
+                    when /hline/;     content.last.hline    = true
+                    when /toprule/; content.last.toprule = true
+                    when /midrule/; content.last.midrule = true
+                    when /\A\s*\Z/, nil
+                    else
+                      @log.warn("#{self}: Unknown row option #{option.inspect}") if @log.warn?
+                  end
+                }
+              end
+              content << Row.new  #Start new row
+            when /^\|=/  #header cell
+              #~ content.last << Cell.new(@wiki.inline($~.post_match.strip, local_options), :th)
+              content.last << Cell.new($~.post_match.strip, :th, @wiki, local_options)
+            when /^\|/    #content of a cell
+              #~ content.last << Cell.new(@wiki.inline($~.post_match.strip, local_options), :td)          
+              content.last << Cell.new($~.post_match.strip, :td, @wiki, local_options)
+            else  #error!
+              raise "cell/log-warning in #{cell.inspect}"
             end
-        } if options
-        @type  = type #:td or :th
-        @wiki   = wiki
-        @local_options = local_options
-      end
-      #Return the content as a element.
-      def cell_element()
-        element(@type,@options, @wiki.inline(@content, @local_options)).cr
+        }
+        
+        max_size = 0
+        content.each{|line|
+          max_size = [max_size, line.size].max
+        }
+        
+        if options[:columns] and options[:columns] < max_size
+          @log.warn("Creole-tabular: Defined size #{options[:columns]} < no of columns (#{max_size})") if @log.warn?
+        end
+        
+        if self.is_a?(Docgenerator::Creole::Creole_longtable)
+            @tab = element(:longtable, { :style => tab_css,
+                          }.merge(options) ).cR
+        #~ elsif self.is_a?(Docgenerator::Creole::Creole_supertabular)  #Not supported
+            #~ @tab = element(:supertabular, { :style => tab_css,
+                          #~ }.merge(options) ).cR
+        elsif self.is_a?(Docgenerator::Creole::Creole_tabular)
+            @tab = element(:tabular, { :style => tab_css,
+                                }.merge(options) ).cR
+        else
+          raise ArgumentError, "Unsupported tabular-class #{self.class}"
+        end
+        
+        content.each{|line|
+          @tab << row = element(:row).cr
+          row.hline if line.hline
+          row.toprule if line.toprule
+          row.midrule if line.midrule
+          line.each{|cell|
+            row << cell.cell_element.cr
+          }
+        }
+      end  
+      def to_doc( target, options = {})
+        @tab.to_doc( target, options )
       end
-    end #class Cell
+    end #Creole_tabular
+
+    class Creole_longtable < Creole_tabular
+      set_placeholder_key 'longtable'
+    end
     
-    #Build the tabular.
-    def close()
-      #~ fixme:
-      #~ *CSS-format
-      #~ *generelle def
-      
-      step = 0  #start
-      head = []
-      content = [[]]
-      
-      options = { :log => @log }
-      local_options = {
-                      :log => @log,
-                      :inclusions => @wiki.inclusions,
-                      :plugins => @wiki.plugins.dup
-      }
-      #No footnotes inside tabulars
-      local_options[:plugins].delete('footnote')
-      local_options[:plugins].delete('footnotes')
-      
-      tab_css = CSS.new( :log => @log )
-      @source.each{|cell|
-        case cell
-          when /^\|!/   #generell cell definition
-            case $~.post_match().strip
-              when /columns\s*=\s*(.*)/
-                options[:columns] = $1.to_i
-              when /border\s*=\s*(.*)/
-                options[:border] = $1
-              when /columndescription\s*=\s*(.*)/
-                options[:columndescription] = $1
-              when /css\s*=\s*(.*)\s*:\s*(.*)/
-                tab_css[$1] = $2
-              when '' #
-              else
-                @log.warn("#{self}: Unknown tabular option #{$1}") if @log.warn?
-            end
-          when /^\|-(.*)/   #new line
-            content << []
-          when /^\|=/  #header cell
-            #~ content.last << Cell.new(@wiki.inline($~.post_match.strip, local_options), :th)
-            content.last << Cell.new($~.post_match.strip, :th, @wiki, local_options)
-          when /^\|/    #content of a cell
-            #~ content.last << Cell.new(@wiki.inline($~.post_match.strip, local_options), :td)          
-            content.last << Cell.new($~.post_match.strip, :td, @wiki, local_options)
-          else  #error!
-            raise "cell/log-warning in #{cell.inspect}"
+    #~ class Creole_supertabular < Creole_tabular  ##Not supported
+      #~ set_placeholder_key 'supertabular'
+    #~ end
+=begin rdoc
+This class needs the CSV-package (the user is responsible to load it).
+
+The LaTeX document needs the booktabs-package
+
+Options:
+* headers=false: Firest line contains headers (default: true)
+* format or columndescription: LaTeX header description
+
+Fixmes:
+* More parameters:
+** toprule, hline, 
+** Other table (supertabular...)
+* Bug: CSV without header returns Array of array
+
+=end
+    class Creole_tabular_csv < Placeholder
+      set_placeholder_key 'tabular_csv'
+      def to_doc( target, options = {})
+         if ! defined? CSV
+          @log.fatal("tabular_csv needs CSV-package")
+          raise "tabular_csv needs CSV-package"
+        end
+        @log.fatal("tabular_csv needs parameters (format, col_sep)") unless @parameters.respond_to? :split
+        columndescription = nil
+        headers = true  #first CSV-line contains 
+        colsep = ';'
+        @parameters.split(/[|;]/).each{|parameter|
+          case parameter
+            when /headers=false/;     headers = false
+            when /(format|columndescription)=(.*)/; columndescription = $2
+            #Some separator get a name. This is made especially, of the separator is also used as parameter separator.
+            when /(col_sep)=(.*)/; colsep = {'semicolon' => ';', 'tab' => "\t", 'bar' => '|'}[$2] || $2  
+              @log.warn("tabular_csv with undefined separator (use semicolon, tab or bar)" % parameter) unless colsep
+            else
+              @log.warn("tabular_csv with unknown option %s" % parameter)
           end
-      }
-      
-      max_size = 0
-      content.each{|line|
-        max_size = [max_size, line.size].max
-      }
-      
-      if options[:columns] and options[:columns] < max_size
-        @log.warn("Creole-tabular: Defined size #{options[:columns]} < no of columns (#{max_size})") if @log.warn?
-      end
-      
-      if self.is_a?(Docgenerator::Creole::Creole_longtable)
-          @tab = element(:longtable, { :style => tab_css,
-                        }.merge(options) ).cR
-      elsif self.is_a?(Docgenerator::Creole::Creole_tabular)
-          @tab = element(:tabular, { :style => tab_css,
-                              }.merge(options) ).cR
-      else
-        raise ArgumentError, "Unsupported tabular-class #{self.class}"
-      end
-      
-      content.each{|line|
-        @tab << row = element(:row).cr
-        line.each{|cell|
-          row << cell.cell_element.cr
         }
-      }
-    end  
-    def to_doc( target, options = {})
-      @tab.to_doc( target, options )
-    end
-  end #Creole_tabular
 
-  class Creole_longtable < Creole_tabular
-    set_placeholder_key 'longtable'
-  end
+        csv = CSV.parse(@source.join, :col_sep => colsep, :headers => true)
+        if ! columndescription
+          columndescription = 'c' * csv.headers.size
+          @log.warn("tabular_csv without LaTeX columndescription. Use %s" % columndescription)
+        end
+        tab = element(:tabular, { :columns => csv.headers.size, :columndescription  => columndescription }).cR
+        tab << row = element(:row).cr.toprule
+        csv.headers.each{|title|row << element(:th,{}, title) }
+        csv.each{|line|
+          tab << row = element(:row).cr
+          line.each{|cell|
+            row << element(:td,{}, cell.last)
+          }
+        }
+        tab.to_doc( target, options )
+      end      
+    end
 
   end #module Creole
+
 end #module Docgenerator
 
 
 if $0 == __FILE__
-    creole = Docgenerator::Creole::Creole.new(
+  
+  creole = Docgenerator::Creole::Creole.new(
                     :name => 'tabular_creole',
                     :content => <<'creole'
 <<<tabular
-|
+|!columns=3
+|!columndescription=ccc
+|=a
+|=b
+|=c
+|-
+|a
+|b
+|c
 >>>
 creole
     )
-p creole.to_html #testcode
+  require 'csv'
+  creole = Docgenerator::Creole::Creole.new(
+                    :name => 'tabular_creole',
+                    :content => <<'creole'
+<<<tabular_csv|columndescription=rrr|col_sep=semicolon
+1;2;3
+yy;yy;yy;
+xx;xx;xx;
+>>>
+creole
+    ) #if false
+    
+  puts creole.to_html #testcode
+  puts creole.to_latex #testcode
 end    
 __END__
 
 class Creole_tabular_cvs
   include Placeholder
->>>tab
-|!  Tabdefinition crl
-|! implizit columns
-|! border=1px
-|=  -> th
+  
+<<<tabular_csv|CSV-Options
 yy;yy;yy;
 yy;yy;yy;
 yy;yy;yy;
@@ -293,3 +397,5 @@ Die Syntax:
   **hline:	Zusätzlicher Trennstrich über der Zeile
   **toprule, midrule, bottomrule:	Zusätzlicher Trennstrich über der Zeile (erfordert booktabs.sty)
   *|}	beendet eine Tabelle
+
+

data/lib/creole/plugins/todonotes.rb

@@ -1,77 +1,77 @@
 require 'docgenerator/packages/todonotes.rb'
 
 module Docgenerator
-module Creole
+  module Creole
 
 =begin rdoc
 Classes to provide support for the todonotes-package.
 
 * http://ctan.org/tex-archive/macros/latex/contrib/todonotes/
 =end
-module Todo
+    module Todo
 
-class Creole_todolist < Creole_inclusion_and_plugin
-  set_plugin_key('listoftodos')  #use <<todo|..>>
-  def to_doc(target, options = {})
-    element(:listoftodos, options).to_doc(target, options)
-  end    
-end
+      class Creole_todolist < Creole_inclusion_and_plugin
+        set_plugin_key('listoftodos')  #use <<todo|..>>
+        def to_doc(target, options = {})
+          element(:listoftodos, options).to_doc(target, options)
+        end    
+      end
 =begin rdoc
 Define a plugin for the todonotes-package.
 =end
-class Creole_todo < Creole_inclusion_and_plugin
-  
-  set_plugin_key('todo')  #use <<todo|..>>
-  
-  #define default options for todonotes. may be redefined for children of this class.
-  def default_options; {}; end
+      class Creole_todo < Creole_inclusion_and_plugin
+        
+        set_plugin_key('todo')  #use <<todo|..>>
+        
+        #define default options for todonotes. may be redefined for children of this class.
+        def default_options; {}; end
 
 =begin rdoc
 Usage:
   <<todo|what to do|color=red>>
 =end
-  def initialize( inclusionname, description, options, wiki )
-    #~ @inclusionname = inclusionname #fix 'todo'
-    @description = description
-    @options = default_options.dup
-    options.each{|opt|
-      case opt
-        when /color\s*=\s*/
-          @options[:color] = $~.post_match
-        when /inline/
-          @options[:inline] = true
-        else
-          wiki.log.warn("Todo #{@description} with undefined option #{opt}")
+        def initialize( inclusionname, description, options, wiki )
+          #~ @inclusionname = inclusionname #fix 'todo'
+          @description = description
+          @options = default_options.dup
+          options.each{|opt|
+            case opt
+              when /color\s*=\s*/
+                @options[:color] = $~.post_match
+              when /inline/
+                @options[:inline] = true
+              else
+                wiki.log.warn("Todo #{@description} with undefined option #{opt}")
+              end
+            }
+          @wiki = wiki
+          
+          raise "Inclusion received no wiki but #{wiki.inspect}" unless wiki.is_a?(Creole)
         end
-      }
-    @wiki = wiki
-    
-    raise "Inclusion received no wiki but #{wiki.inspect}" unless wiki.is_a?(Creole)
-  end
-  
-  def to_doc(target, options = {})
-    element(:todo, @options, @description).to_doc(target, options)
-  end  
-end #Creole_todo
+        
+        def to_doc(target, options = {})
+          element(:todo, @options, @description).to_doc(target, options)
+        end  
+      end #Creole_todo
 
 =begin rdoc
 A variant of Creole_todo with green color.
 =end
-class Creole_todo_green < Creole_todo
-    set_plugin_key('todo_green') #use <<todo_green|..>>
-  #define default options for todonotes. may be redefined for children of this class.
-  def default_options; {:color => 'green'}; end
-end
+      class Creole_todo_green < Creole_todo
+          set_plugin_key('todo_green') #use <<todo_green|..>>
+        #define default options for todonotes. may be redefined for children of this class.
+        def default_options; {:color => 'green'}; end
+      end
 
 =begin rdoc
 A variant of Creole_todo with inline-layout.
 =end
-class Creole_todo_inline < Creole_todo
-  set_plugin_key('todo_inline') #use <<todo_inline|..>>
-  #define default options for todonotes. may be redefined for children of this class.
-  def default_options; {:inline => true}; end
-end
+      class Creole_todo_inline < Creole_todo
+        set_plugin_key('todo_inline') #use <<todo_inline|..>>
+        #define default options for todonotes. may be redefined for children of this class.
+        def default_options; {:inline => true}; end
+      end
 
-end #module Todo
-end #module Creole
+    end #module Todo
+  end #module Creole
 end #module Docgenerator