docgenerator 1.0.4 → 1.1.1

data/lib/creole/creole_inclusion_and_plugins.rb

@@ -0,0 +1,236 @@
+#
+#Creole inclusions and plugins
+#
+#
+#This classes are defined to implement transclusions (http://en.wikipedia.org/wiki/Transclusion)
+#
+#- http://www.wikicreole.org/wiki/Inclusion
+#- http://www.wikicreole.org/wiki/Plugin
+#
+#By default, Pictures are expected.
+#
+#You can extend Wikis with additional inclusions:
+#
+# wiki = Creole.new()
+# wiki.inclusion['xxx'] = Creole_inclusion_xxx
+#
+
+
+#
+#Dummy class for all inclusions and plugins.
+#Used to check the correct definition.
+#
+#- Inclusions are used later with {{xx}}
+#- Plugins are used later with <<xx>>
+#
+#Derived classes (Inclusions):
+#- Creole_inclusion_img
+#- Creole_inclusion_footnote_group
+#- Creole_inclusion_footnote
+#Derived classes (Plugins):
+#- Creole_default_plugin
+#- Creole_plugin_ruby
+#- Creole_plugin_ruby_raw
+#More subclasses may be possible.
+class Creole_inclusion_and_plugin
+  def initialize( inclusionname, description, options, wiki )
+    @inclusionname = inclusionname
+    @description = description
+    @options = options
+    @wiki = wiki
+    
+    raise "Inclusion received no wiki but #{wiki.inspect}" unless wiki.is_a?(Creole)
+    
+  end
+  #Reader for the wiki.
+  attr_reader :wiki
+end #Creole_inclusion
+
+#
+#Default Plugin.
+class Creole_default_plugin < Creole_inclusion_and_plugin
+  Creole::Plugins.default = self
+  def initialize( pluginname, description, options, wiki )
+    super
+    @wiki.log.warn("Use Default plugin - nothing special done.") if @wiki.log.warn?
+  end
+end
+
+
+#Include images.
+#http://www.wikicreole.org/wiki/Images
+#
+#There are yet more features than in standard.
+#
+#This is also the default for inclusions.
+class Creole_inclusion_img < Creole_inclusion_and_plugin
+  Creole::Inclusions.default = self
+
+  #Define an image.
+  #The existence of the picture is checked.
+  def initialize( picname, alt_text, options, wiki )
+    super
+    @img = element(:img,{  :src => @inclusionname })
+    @img[:alt] << alt_text if alt_text
+    #Check existence of Picture. Only possible if the related wiki is available.
+    wiki.check_link_existence( @inclusionname, wiki.log )
+
+    css = CSS.new( :log => wiki.log )
+
+    options.each{|option|
+      case option
+        when /^(img)?css\s*=\s*(.*)/
+          $2.split(/\s*;\s*/).each{|css_assignment|
+            css_assignment =~ /(.+?)\s*:\s*(.+)/
+            css[$1] = $2
+          }
+        when /^(img)?class\s*=\s*(.*)/
+          @img[:class] << $2
+        else
+          wiki.log.warn("Img: Undefined option #{option}") if wiki.log.warn?
+        end #case option
+    } if options
+    @img.attr[:style] << css 
+
+  end
+  def to_doc(target, options = {})
+    @img.to_doc(target, options)
+  end
+end #Creole_inclusion_img
+
+#
+#Collection of footnotes.
+#
+class Creole_footnote_group < Creole_inclusion_and_plugin
+  #
+  Creole::Plugins['footnotes'] = self
+  #~ Creole::Inclusions['footnotes'] = self
+  
+  def initialize( inclusionname, description, options, wiki )
+    super
+    description = Footnotegroup::DEFAULTGROUPID unless description
+    @footnotesgroup = wiki.footnotegroups[description]
+    wiki.log.error("Footnotesgroup #{description.inspect} not found") if ! @footnotesgroup and wiki.log.error?
+  end
+  def to_doc(target, options = {})
+    @footnotesgroup.to_doc(target, options)
+  end  
+end #Creole_inclusion_footnote_group
+
+#
+#One footnote
+#
+#Bug: If you create more documents, you get a common footnote counting.
+#Has to be repaired one day.
+class Creole_footnote < Creole_inclusion_and_plugin
+  Creole::Plugins['footnote'] = self
+  #~ Creole::Inclusions['footnote'] = self
+  def initialize( inclusionname, description, options, wiki )
+    super
+    
+    @groupid = Footnotegroup::DEFAULTGROUPID
+    label = nil
+    
+    options.each{|option|
+      case option
+        when /label\s*=\s*(.*)/
+          label = $1
+        when /groupid\s*=\s*(.*)/
+          @groupid = $1
+        else
+        @wiki.log.warn("Footnote with unknown option #{option.inspect} not found") if @wiki.log.warn?
+      end
+    }
+    
+    if ! wiki.footnotegroups[@groupid]
+      wiki.footnotegroups[@groupid] = Footnotegroup.new(@groupid)
+    end
+
+    group = wiki.footnotegroups[@groupid]
+    
+    @footnote = element(:footnote,{ 
+      :group => group,
+      :label => label,
+      }, description )
+    
+    
+  end
+  def to_doc(target, options ={})
+    @footnote.to_doc(target, options)
+  end  
+end #Creole_inclusion_footnote
+
+#
+#Eval the given ruby-code and put it as "raw text".
+#
+#
+#This is defined as a plugin.
+class Creole_plugin_ruby_raw < Creole_inclusion_and_plugin
+  #~ Creole::Inclusions['ruby'] = self
+  Creole::Plugins['ruby_raw'] = self
+  
+  def initialize( inclusionname, description, options, wiki )
+    #The ruby-code may contain | - so we have to ad it again
+    description << "|#{options.join('|')}" unless options.empty?
+    options = nil
+    super
+    @code = description
+    begin
+      @result = eval(@code)
+    rescue => bang
+      wiki.log.error("Plugin ruby_raw: <#{@code}> results in #{bang.class}/#{bang}") if wiki.log.error?
+    end
+  end #initioliaze
+  def to_doc(target, options ={})
+    @result.to_s
+  end  
+  def inspect()
+    "#<Creole_plugin_ruby_raw:#{@code}>"
+  end
+end #Creole_plugin_ruby
+
+#
+#Eval the given ruby-code and add it as a interpreted code.
+#
+#This is defined as a plugin.
+#
+#Ideas for further development: eval later, at doc generation.
+class Creole_plugin_ruby < Creole_inclusion_and_plugin
+  #~ Creole::Inclusions['ruby'] = self
+  Creole::Plugins['ruby'] = self
+  def initialize( inclusionname, description, options, wiki )
+    #The ruby-code may contain | - so we have to ad it again
+    description << "|#{options.join('|')}" unless options.empty?
+    options = nil
+    super
+    
+    @code = description
+    begin
+      @result = eval(@code)
+    rescue => bang
+      wiki.log.error("Plugin ruby: <#{@code}> results in #{bang.class}/#{bang}") if wiki.log.error?
+    end
+  end #initioliaze  
+  def to_doc(target, options = {})
+    @wiki.normsource2elements( 
+                  @wiki.parse(@result.to_s ), options
+            ).to_doc(target, options )
+  end  
+  def inspect()
+    "#<Creole_plugin_ruby:#{@code}>"
+  end
+end #Creole_plugin_ruby
+
+#~ if $0 == __FILE__
+  #~ require 'quicktest'
+#~ end
+
+
+__END__
+Fixme for image:
+pack it for a figure-environment (HTML: div/span + float)
+{{test.jpg|description|beforetitle=vorher]]
+{{test.jpg|description|aftertitle=nachher}}
+{{test.jpg|description|figureclass=imgclass}}
+description = caption
+

data/lib/creole/creole_placeholder.rb

@@ -0,0 +1,74 @@
+#
+#Placeholder are defined in Creole-Syntax via <<< >>>
+#
+#Placeholders collect the content between <<< and >>>. 
+#
+#Derived classes are:
+#- Creole_dummy_placeholder
+#- Creole_html
+#- Creole_latex
+#- Creole_tabular
+#- Creole_creoletab
+class Creole_placeholder
+  
+  def initialize( wiki )
+    @wiki = wiki
+    @log  = @wiki.log
+  end
+  def << (content)
+    @source = [] unless @source
+    @source << content
+  end
+  #
+  #possibility to analyse the content.
+  def close()
+  end
+  def to_doc( target, options = {})
+    @source.to_doc( target, options )
+  end
+end #Creole_placeholder
+
+#Just a dummy for wrong definitions.
+#
+#This class is used by Creole a default placeholder.
+class Creole_dummy_placeholder < Creole_placeholder
+  Creole::Placeholders.default = self
+end #Creole_dummy_placeholder
+
+#
+#Placeholder for pure HTML-output.
+#This content is ignored in LaTeX, Wiki... documents.
+class Creole_html < Creole_placeholder
+  Creole::Placeholders['html'] = self
+  #Return content only for html
+  def to_doc( target, options = {})
+    target == :html ? @source.to_doc( target, options ) : ''
+  end  
+end #Creole_html 
+
+#
+#Placeholder for pure LaTeX-output.
+#This content is ignored in HTML, Wiki... documents.
+#
+#Idea for option: Parse the content by the wiki.
+#
+#Pro:
+#-allows the usage of <<ruby|... 
+#Cons:
+#-unexpected conversions?
+class Creole_latex < Creole_placeholder
+  Creole::Placeholders['latex'] = self
+  #Return content only for latex
+  def to_doc( target, options = {})
+    target == :latex ? @source.to_doc( target, options ) : ''
+  end  
+end #Creole_latex 
+
+
+__END__
+To be done:
+class Creole_rail
+class Creole_struktogramm
+rubycode (see plugin  Creole_plugin_ruby )
+
+Steuerparameter mit | nach plugin-name?

data/lib/creole/creole_tabular.rb

@@ -0,0 +1,170 @@
+require 'creole2doc' if __FILE__ == $0
+
+<<fixme
+taboptions:
+  - border=:  HTML
+  - .* = (.*): Used for CSS
+newline-options  
+  - toprule
+  - midrule
+  - hline
+  - .* = (.*): Used for CSS
+lineoptions:
+  - colspan = 
+  - pos
+  - .* = (.*): Used for CSS
+fixme
+
+
+#
+#Extend the class by a little structure
+class Creole_placeholder
+  Cell = Struct.new('Cell', :content, :type )  
+end #Creole_placeholder
+
+#
+#"Original" creole tab. 
+#
+#Defined as a collector, so we can collect the content first and 
+#build the tabular later.
+#
+#Details see http://www.wikicreole.org/wiki/Tables
+class Creole_creoletab < Creole_placeholder
+  Creole::Placeholders['creole_tabular'] = self #original creole-tab definition
+  #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
+
+#
+#Create tabulars analog to Wikimedia.
+class Creole_tabular < Creole_placeholder
+  Creole::Placeholders['tabular'] = self
+  #Build the tabular.
+  def close()
+    #~ fixme:
+    #~ *CSS-format
+    #~ *generelle def
+    
+    step = 0  #start
+    head = []
+    content = [[]]
+    options = {}
+    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 /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, options), :th)
+        when /^\|/    #content of a cell
+          content.last << Cell.new(@wiki.inline($~.post_match.strip, options), :td)
+        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
+    
+    @tab = element(:tabular, { :style => tab_css,
+                                  
+                        }.merge(options) ).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 = {})
+    @tab.to_doc( target, options )
+  end
+  
+end
+
+__END__
+
+class Creole_tabular_cvs
+  include Creole_placeholder
+>>>tab
+|!  Tabdefinition crl
+|! implizit columns
+|=  -> th
+yy;yy;yy;
+yy;yy;yy;
+yy;yy;yy;
+<<<
+
+
+ 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
+  *|format|	z.B. rowspan...
+  *|format||	Zwei || beenden die Parameter der Zelle.
+    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)
+  *|}	beendet eine Tabelle

data/lib/docgenerator.rb

@@ -3,8 +3,17 @@
 #Plain text and a Wiki-version exist also, but they are not well maintained.
 #
 #
+#==Wiki
+#Docgenerator is also the base for two Wiki-analyser.
+#Both parse a wiki-source and build a docgenerator tree.
+#In combination, you get a wiki to html and wiki to LaTeX converter.
+#
+#Details see
+#- Creole (Creole-syntax)
+#- Wikitext (Wikimedia-syntax, no longer supported.)
+#
 #==Elements
-#A document is structured by elements.
+#A document is structured by Element.
 #Each element contains attributes/parameters and content. 
 #(Think of HTML-attributes and TeX-Parameters and the content of HTML-Tags and TeX-Environments.).
 #
@@ -17,7 +26,7 @@
 #Some elements (in fact, most of them) are generated dynamic,
 #so they will not occur in this generated documentation).
 #
-#==	Examples
+#===	Examples
 #A document with a paragraph:
 # doc = Document.new
 # doc.body << element(:p,{}, 'Content')
@@ -34,6 +43,7 @@
 #
 #See the unit tests and the examples-folder of the docgenerator distribution for more examples.
 #
+#
 #== Known problems
 #This program is developed under Windows.
 #I expect encoding problems on other systems
@@ -60,12 +70,11 @@ require 'yaml'  #needed by docgenerator_template.rb
 #How to handle the End-Tag for br/hr...
 #- false:	set <br />	(XHTML)
 #- nil:	set <br>	(HTML)
+#
 #Problem:
 #HTML may have no endtags, XHTML requires it.
-#~ Die Konstante ENDTAG macht es einstellbar.
-#~ Zu machen: Flag im Dokument ob HTML oder XHTML.
-#~ Aber woher weiss element in welches Dokument es geh�rt?
-#~ Gleiche Problem bei to_s, bzw. Document.target
+#This constant defines it global.
+#Fixme: Flag it in the HTML-template what you need.
 ENDTAG	= false	if ! defined?( ENDTAG )
 
 

data/lib/docgenerator_attribute.rb

@@ -39,7 +39,7 @@ class Attribute
 			when :wiki
 				attributeclass.class_eval('def wiki?();  true; end')
 			else
-				puts "Attribute: Unknown setting <#{setting.inspect}>"
+				DOCGENERATOR_LOGGER.error("Attribute: Unknown setting <#{setting.inspect}>") if DOCGENERATOR_LOGGER.error?
 			end
 		}
 		if values
@@ -74,7 +74,7 @@ class Attribute
 	#Sometimes the content of an attribute is needed directly.
 	def content();  @attr_content; end
 	#Check if content was added
-	def filled?();  return @attr_content.size > 0; end
+	def filled?();  return @attr_content.compact.size > 0; end
 	#Attribut is used for HTML.
 	def html?();  false; end
 	#Attribut is used for Text.

data/lib/docgenerator_characters.rb

@@ -41,6 +41,11 @@ Element.create( [:percent, :'%'], {},false,
 		:latex	=> '\%'
 	} )
 
+Element.create( [:dollar, :'$'], {},false, 
+	{	:html => '$',
+		:latex	=> '\$'
+	} )
+
 Element.create( [:'^'], {},false, 
 	{	:html => '^',
 		:latex	=> '\hat{}'
@@ -78,21 +83,25 @@ Element.create( [:radic], {},false,
 
 Element.create( [:rarr, :rightarrow, :'->'], {},false, 
 	{	:html => '→',
-		:latex	=> '\ensuremath{\rightarrow}'
+		:latex	=> '\ensuremath{\rightarrow}',
+    :text => '->',
 	} )
 
 Element.create( [:rArr, :Rightarrow, :'=>'], {},false, 
 	{	:html => '⇒',
-		:latex	=> '\ensuremath{\Rightarrow}'
+		:latex	=> '\ensuremath{\Rightarrow}',
+    :text => '=>',
 	} )
 Element.create( [:larr, :leftarrow, :'<-'], {},false, 
 	{	:html => '&larr;',
-		:latex	=> '\ensuremath{\leftarrow}'
+		:latex	=> '\ensuremath{\leftarrow}',
+    :text => '<-',
 	} )
 
 Element.create( [:lArr, :Leftarrow, :'<='], {},false, 
 	{	:html => '&lArr;',
-		:latex	=> '\ensuremath{\Lefttarrow}'
+		:latex	=> '\ensuremath{\Lefttarrow}',
+    :text => '<=',
 	} )
 
 Element.create( [:uArr, :Uparrow ], {},false, 
@@ -164,8 +173,15 @@ Element.create( [:empty], {},false,
 Element.create( [:'_', :underscore], {},false, 
 	{	:html => '_',
 		:latex	=> '\_',
+		:wiki	=> '_',
+		:text	=> '_',
 	} )
 
+Element.create( [:'...', :ldots], {},false, 
+	{	:html => '&hellip;',
+		:latex	=> '\ldots ',
+	} )
+  
 Element.create( [:bullet], {},false, 
 	{	:html => '&#149;',
 		:latex	=> '\ensuremath{\bullet}'