docgenerator 2.0.0 → 2.1.0

data/examples/creole_example_tabular.rb

@@ -0,0 +1,95 @@
+#encoding: cp1252
+=begin rdoc
+Example for creole/creole2doc
+=end
+
+
+require 'rubygems'
+$:.unshift("../lib")  #for local tests with uninstalled gem
+#~ require 'docgenerator'
+require 'creole/creole2doc'	
+include Docgenerator
+
+begin 
+  require 'rake4latex_pdflatex' 
+rescue LoadError 
+  puts "rake4latex not installed -> no translation of LaTeX-file"
+end
+
+#
+# Move all results to anothe folder
+#
+Dir.chdir('results')
+
+
+=begin
+Create document
+=end
+doc = Document.new(
+  :title	=>	'creole2doc_example_tabular.rb: Test for tabulars with creole'
+)
+
+=begin
+Add creole-content.
+=end
+doc.body << Creole::Creole.new(:content => DATA)
+
+# ###############################
+# Save the files
+# ###############
+doc.save( __FILE__.sub(/\.rb/, ".html"))
+doc.save( __FILE__.sub(/\.rb/, ".tex"),
+  :runtex => [:statistic, :clean]
+  )
+
+
+__END__
+=Normal tabular
+
+|one | two
+|1 | 2
+|1.0 | 2.0
+
+==tabular with heading
+|=header col1|=header col2| 
+|col1|col2| 
+|you         |can         | 
+|also        |align\\ it. | 
+
+
+=tabular as placeholder
+<<<tabular
+|!columns=3
+|!columndescription=ccc
+|=1
+|=2
+|=3
+|-
+|eins
+|zwei
+|drei
+|-
+|one
+|two
+|three
+>>>
+
+=tabular with cell option
+
+After || you may define special data
+
+<<<tabular
+|!columns=3
+|!columndescription=ccc
+|eins||css=color: red
+|css = zwei
+|||class=empty
+|-
+|normal
+|//italic//
+|//italic//||class=it
+|-
+|text with | nice! ||class = it
+|||css = 
+|
+>>>

data/examples/docgenerator_example.rb

@@ -17,7 +17,7 @@ rescue LoadError
 end
 
 #
-# Move all results to anothe folder
+# Move all results to another folder
 #
 Dir.chdir('results')
 
@@ -34,18 +34,18 @@ doc = Docgenerator::Document.new(
   )
 
 #
-#   Alternative psooibility to define settings:
+#   Alternative possibility to define settings:
 #~ doc.title	='Titel'
 #~ doc.author	= 'Authorname'
 #~ doc.date	= 'Datum'
 #~ doc.keywords	= 'Test, DocGenerator.rb'
 #~ doc.description	= 'Testdokument for DocGenerator.rb'
 
-doc.add_option('ngerman')
+doc.add_option('english')
 
 #
 doc.body	<< element(:maketitle)  #Only LaTeX
-doc.body[:lang] << 'de' #language flag for HTML
+doc.body[:lang] << 'en' #language flag for HTML
 
 # ###############################
 doc.body	<< element(:h1, {}, 'Sections and paragraphs').cr
@@ -104,7 +104,7 @@ doc.body.insertbefore( par, 'This is inserted before the paragraph.' )
 doc.body.insertafter( par, 'This is inserted after the paragraph.' )
 
 #
-# This would give yo an error
+# This would give you an error
 #
 #~ puts "!And now an error: insertbefore with a non-existing target"
 #~ doc.body.insertbefore( 'a', 'Before List' )

data/lib/creole/creole2doc.rb

@@ -175,13 +175,16 @@ Define a creole document. The settings are forwarded to Document#new()
 Some settings are used only directly in Creole_document.
 - :with_toc: Add a table of contents at the beginning of the document.
 - :content: Wiki-text. Same as Creole_document#<<
+- :logname: Name for Creole#log
 =end
   def initialize( settings = {} )
     @with_toc  = settings[:with_toc ]
     settings.delete(:with_toc)  #Avoid error message in Document.new
-
+    settings[:logname] ||= 'CreoleDoc'  #Just a name for easier debugging/logging
+    
     @creole = Creole.new( 
         #Get content if available and delete setting to avoid error message in Document.new
+        :logname      => settings.delete(:logname), #for logger
         :content  => settings.delete(:content),
         :ignore     => settings.delete(:ignore),
         :targetdir => settings.delete(:targetdir)
@@ -277,7 +280,7 @@ Options:
 =end
   def initialize( options = {} )
     @options = {
-      :name => 'Creole',  #Just a name for easier debugging/logging
+      :logname => 'Creole',  #Just a name for easier debugging/logging
       :targetdir  => '.',
       :wrap_at  => 75,    #Default line wrapping
       #~ :parsetest             => false  #Make an immediate test for parsing #fixme
@@ -309,7 +312,7 @@ Options:
     @targetdir  = @options[:targetdir] if @options[:targetdir]
     
     @log  = @options[:log]
-    @log = Log4r::Logger.new(@options[:name], Log4r::INFO) unless @log
+    @log = Log4r::Logger.new(@options[:logname], Log4r::INFO) unless @log
     @log.outputters = Log4r::StdoutOutputter.new('log_stdout') if  @log.outputters.empty?
 
     @creation_caller = caller.first
@@ -374,8 +377,12 @@ multiple paragraphs, lists...
     else
       raise InputError, "Don't know, how to handle #{input.class} in Creole#<<"      
     end
-    
-    source_enc = source.encode(@options[:encoding])
+    begin
+      source_enc = source.encode(@options[:encoding])
+    rescue Encoding::UndefinedConversionError => err
+      @log.warn("Encoding conversion error <#{err}>") if @log.warn?
+      source_enc = source.encode(@options[:encoding], :undef => :replace)
+    end
     @source << source_enc 
     #Parse the given source.
     #This is done immediate, so you have a chance to localize the line, where an error occurs.
@@ -549,12 +556,8 @@ Return a table of contents as a list.
     
     @toc.each{|tocentry|
         level = tocentry.add_info[:level]
-
-#
-#fixme:
-#Ebenenfehler (fehlende ebene resultiert in:
-# ERROR Creole: List ** with missing sublist
-# --> bessere meldung
+        #Skip deeper levels then wanted.
+        next if level > options[:level]
 
         #Build the label
         if level > toclabel.size
@@ -562,9 +565,12 @@ Return a table of contents as a list.
         elsif level < toclabel.size
           toclabel.pop
         end
+        #Happens if there is a jump gap on section levels (subsubsection inside section without subsection)
         if ! toclabel[level-1]
-          @log.fatal("toclevel error: #{__FILE__}##{__LINE__}")
-          return nil
+          @log.warn("Missing toclevel for <#{tocentry.content}> #{tocentry.add_info.inspect}")
+          #add dummy level 
+          toclabel << 0
+          toclist << "#{listtype * ( level - 1)} ---"
         end
         toclabel[level-1] = toclabel[level-1] + 1 
 
@@ -575,8 +581,6 @@ Return a table of contents as a list.
         else
           label = tocentry.add_info[:label] = toclabel.join('-')
         end
-        #Skip deeper levels then wanted.
-        next if level > options[:level]
         
         #Feature to create the toc if higher levels are missing /start at h3...)
         #~ if level < options[:startlevel]
@@ -602,6 +606,9 @@ toc
 Wrapping mechanism for texts.
 
 Don't do anything, if line_width is 0.
+
+See also http://stackoverflow.com/questions/7548968/format-output-to-40-characters-long-per-line/7549032#7549032
+and http://forum.ruby-portal.de/viewtopic.php?t=3844&p=24578
 =end
   def word_wrap(text, line_width = @options[:wrap_at] ) 
     return text if line_width <= 0
@@ -783,9 +790,10 @@ Options is a Hash and may contain:
           options[:log].error("Lost link <#{el}>") if options[:log].error?
         #fixme: there are obsolete 2 additional spaces in the result.
         when /^http/ #implicit link
-          href = element(:a, {:href=>el.strip}, el.strip )
+          #~ href = element(:a, {:href=>el.strip}, el.strip ) #This makes problems with TeX (unmasked _,%...)
+          href = element(:url, {}, el.strip )
           el =~ /(\s|\Z)$/  #get the end-space/newline if available
-          endspace = ( ! $1.empty? ? $1 : nil )
+          endspace = ( $1.empty? ? nil : $1 )
           if stack.last  
             stack.last << href
             #~ stack.last << last_char #add again the 
@@ -878,10 +886,12 @@ Check for links and pictures if the target exist.
 
 Absolute DOS-Pathes are detected (C:\...).
 Relative pathes are searched from @options[:targetdir] (default '.').
+
+Different locations are not supported (e.g. to implement LaTeXs \graphicspath)
 =end
   def check_link_existence( filename, log )
     case filename
-      when /^.:/#absolute DOS-path
+      when /^.:/#absolute DOS-path (e.g. c:\...)
         path = filename.dup
       else  #relative path
         path = "#{@options[:targetdir]}/#{filename}".sub(/^\//, '')

data/lib/creole/creole_inclusions.rb

@@ -50,7 +50,7 @@ Define an image.
 The existence of the picture is checked.
 
 Supported options:
-* alt	(2nd parameter of {{picsrc|...}}
+* alt (2nd parameter of {{picsrc|...}}
 * css or imgcss
 * class or imgclass
 * longdesc  (can take a url, at leas opera offers to call the description)
@@ -73,9 +73,9 @@ Supported options:
     #* align
     #* border
     #* height
-    #* hspace	
-    #* name	
-    #* vspace	
+    #* hspace
+    #* name
+    #* vspace
     options.each{|option|
       case option
         when /^(img)?css\s*=\s*(.*)/

data/lib/creole/creole_placeholder.rb

@@ -130,7 +130,10 @@ class Creole_latex < Placeholder
 end #Creole_latex 
 
 #
-#Collect 
+#Usage: 
+#  <<<comment
+#  This text is a comment.
+#  >>>
 #
 class Creole_comment < Placeholder
   set_placeholder_key 'comment'

data/lib/creole/creole_tabular.rb

@@ -1,4 +1,5 @@
-require 'creole2doc' if __FILE__ == $0
+#encoding: UTF-8
+
 
 <<fixme
 taboptions:
@@ -17,8 +18,7 @@ fixme
 
 
 module Docgenerator
-module Creole
-
+  module Creole
 =begin
 "Original" creole tab. 
 
@@ -35,55 +35,55 @@ Usage:
   |also        |align\\ it. | 
 
 =end
-class Creole_tab < Placeholder
-  set_placeholder_key 'creole_tabular' #original creole-tab definition
+    class Creole_tab < Placeholder
+      set_placeholder_key 'creole_tabular' #original creole-tab definition
 
-  #Extend the class by a little structure
-  Cell = Struct.new('Cell', :content, :type )  
+      #Extend the class by a little structure
+      Cell = Struct.new('Cell', :content, :type )  
 
-  #Finish the tabular.
-  #Each cell is added left justified.
-  def close(options)
-    #~ @log.error("Standard creole tabulars not supported yet" )
-    
-    step = 0  #start
-    head = []
-    content = []
-    @source.each{|line|
-      content << []
-      #delete trailing empty cells
-      line.chomp.gsub(/\|\s*$/,'').split(/\|/)[1..-1].each{|cell|
-        case cell
-          when /^=/
-          content.last << Cell.new(@wiki.inline($~.post_match.strip, options),:th)
-        else
-          content.last << Cell.new(@wiki.inline(cell.strip, options), :td)
-        end
-      }
-    }
-    
-    max_size = 0
-    content.each{|line|
-      max_size = [max_size, line.size].max
-    }
-    
-    @tab = element(:tabular, {#:style => tab_css,
-                            :columns => max_size,
-                            :columndescription => 'l' * max_size,
-                        }).cR
-    content.each{|line|
-      @tab << row = element(:row).cr
-      line.each{|cell|
-      #fixme cell to wiki/creole
-        row << element(cell.type,{}, cell.content).cr
-      }
-    }
-  end
-  def to_doc( target, options = {})
-    self.close(options) unless @tab
-    @tab.to_doc( target, options )
-  end  
-end #Creole_tab
+      #Finish the tabular.
+      #Each cell is added left justified.
+      def close(options)
+        #~ @log.error("Standard creole tabulars not supported yet" )
+        
+        step = 0  #start
+        head = []
+        content = []
+        @source.each{|line|
+          content << []
+          #delete trailing empty cells
+          line.chomp.gsub(/\|\s*$/,'').split(/\|/)[1..-1].each{|cell|
+            case cell
+              when /^=/
+              content.last << Cell.new(@wiki.inline($~.post_match.strip, options),:th)
+            else
+              content.last << Cell.new(@wiki.inline(cell.strip, options), :td)
+            end
+          }
+        }
+        
+        max_size = 0
+        content.each{|line|
+          max_size = [max_size, line.size].max
+        }
+        
+        @tab = element(:tabular, {#:style => tab_css,
+                                :columns => max_size,
+                                :columndescription => 'l' * max_size,
+                            }).cR
+        content.each{|line|
+          @tab << row = element(:row).cr
+          line.each{|cell|
+          #fixme cell to wiki/creole
+            row << element(cell.type,{}, cell.content).cr
+          }
+        }
+      end
+      def to_doc( target, options = {})
+        self.close(options) unless @tab
+        @tab.to_doc( target, options )
+      end  
+  end #Creole_tab
 
 =begin rdoc
 Create tabulars analog to Wikimedia.
@@ -117,11 +117,11 @@ 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'
+    
+    #Extend the class by a little structure
+    class Cell 
 =begin rdoc
 The content of a cell is separated from settings by two ||
 
@@ -132,107 +132,125 @@ 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 '' #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
-  
-  #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 '' #
+      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
-              @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'
-        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
+              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
     
-    @tab = element(:tabular, { :style => tab_css,
-                                  
+    #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}"
+          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
-    content.each{|line|
-      @tab << row = element(:row).cr
-      line.each{|cell|
-        row << cell.cell_element.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  
+    def to_doc( target, options = {})
+      @tab.to_doc( target, options )
+    end
+  end #Creole_tabular
+
+  class Creole_longtable < Creole_tabular
+    set_placeholder_key 'longtable'
   end
-end
-end #module Creole
+
+  end #module Creole
 end #module Docgenerator
 
 
@@ -262,8 +280,8 @@ yy;yy;yy;
 <<<
 
 
- Die Syntax:
-  *{|	beginnt eine Tabelle. Hier k�nnen zus�tzliche Formatierungseigenschaften kommen.
+Die Syntax:
+  *{|	beginnt eine Tabelle. Hier können zusätzliche Formatierungseigenschaften kommen.
   **Zumindest columns==__ sollte gesetzt sein
   *!		beginnt eine neue Zelle einer Titelzeile
   *|		beginnt eine neue Zelle
@@ -272,6 +290,6 @@ yy;yy;yy;
     Dann sinnvoll, wenn im Text selbst ein | vorkommt
     (z.B. ein Macro verwendet wird)
   *|-	trennt zwei Zeilen der Tabelle
-  **hline:	Zus�tzlicher Trennstrich �ber der Zeile
-  **toprule, midrule, bottomrule:	Zus�tzlicher Trennstrich �ber der Zeile (erfordert booktabs.sty)
+  **hline:	Zusätzlicher Trennstrich über der Zeile
+  **toprule, midrule, bottomrule:	Zusätzlicher Trennstrich über der Zeile (erfordert booktabs.sty)
   *|}	beendet eine Tabelle