docgenerator 1.2.1 → 2.0.0

data/lib/creole/creole_characters.rb

@@ -0,0 +1,56 @@
+=begin rdoc
+Creole characters
+
+This classes define special characters as inclusions.
+
+* Inclusions are used later with {{xx}}
+  more at http://www.wikicreole.org/wiki/Inclusion
+=end
+
+#
+
+module Docgenerator
+module Creole
+
+=begin rdoc
+Define special characters as inclusions.
+
+See also Creole::CHARACTERS
+=end
+module Characters
+=begin rdoc
+Define a 'shy' as {{shy}}
+=end
+class Creole_shy < Creole_inclusion_and_plugin
+  set_inclusions_key '-'
+  set_inclusions_key 'shy'
+  
+  def to_doc(target, options = {})
+    element(:shy).to_doc(target, options)
+  end  
+end #Creole_shy
+
+=begin rdoc
+Define a 'radic' as {{radic}}
+=end
+class Creole_radic < Creole_inclusion_and_plugin
+  set_inclusions_key 'radic'
+  
+  def to_doc(target, options = {})
+    element(:radic).to_doc(target, options)
+  end  
+end #Creole_shy
+
+=begin rdoc
+Define a 'nil' as {{nil}}
+=end
+class Creole_nil < Creole_inclusion_and_plugin
+  set_inclusions_key  'nil'
+  
+  def to_doc(target, options = {})
+    ''
+  end  
+end   #Creole_nil
+end #module Characters
+end #module Creole
+end #module Docgenerator

data/lib/creole/creole_inclusion_and_plugins.rb

@@ -1,20 +1,25 @@
-#
-#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
+=begin rdoc
+Creole inclusions and plugins
+
+This classes are defined to implement transclusions (http://en.wikipedia.org/wiki/Transclusion)
+
+* Inclusions are used later with {{xx}}
+  more at http://www.wikicreole.org/wiki/Inclusion
+* Plugins are used later with <<xx>>
+  more at http://www.wikicreole.org/wiki/Plugin
+
+By default, an inclusion expects a pictures, unless it es defined something else.
+
+You can extend Wikis with additional inclusions:
+
+ wiki = Creole.new()
+ wiki.inclusion['xxx'] = Creole_inclusion_xxx
+=end
+
 #
 
+module Docgenerator
+module Creole
 
 =begin rdoc
 Dummy class for all inclusions and plugins.
@@ -27,6 +32,7 @@ Derived classes (Inclusions):
 - Creole_inclusion_img
 - Creole_inclusion_footnote_group
 - Creole_inclusion_footnote
+
 Derived classes (Plugins):
 - Creole_default_plugin
 - Creole_plugin_ruby
@@ -34,8 +40,18 @@ Derived classes (Plugins):
 More subclasses may be possible.
 =end
 class Creole_inclusion_and_plugin
-  include Docgenerator  #get VERSION
-  
+=begin rdoc
+Example:
+  {{inclusionname|description|option1=1,option2=2}}
+
+Parameters:
+*  inclusionname: Name of the inclusion (normally fix for an instance, unless e.g. Creole_inclusion_img)
+*  description: First parameter of the plugin.
+*  options: Array with the comma separated values. 
+   In the example:
+    ['option1=1','option2=2']
+*  wiki: creole-instance, where the plugin/inclusion is defined.
+=end
   def initialize( inclusionname, description, options, wiki )
     @inclusionname = inclusionname
     @description = description
@@ -43,286 +59,45 @@ class Creole_inclusion_and_plugin
     @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 instead requested #{pluginname}- nothing special done.") if @wiki.log.warn?
-  end
-end
-
-
-#
-#Define a 'shy' as {{shy}}
-#
-class Creole_shy < Creole_inclusion_and_plugin
-  #
-  #~ Creole::Plugins['-'] = self
-  Creole::Inclusions['-'] = self
-  Creole::Inclusions['shy'] = self
-  
-  def to_doc(target, options = {})
-    element(:shy).to_doc(target, options)
-  end  
-end #Creole_inclusion_footnote_group
-
-#
-#Define a 'nil' as {{nil}}
-#
-class Creole_nil < Creole_inclusion_and_plugin
-  #
-  #~ Creole::Plugins['-'] = self
-  #~ Creole::Inclusions['-'] = self
-  Creole::Inclusions['nil'] = self
-  
-  def to_doc(target, options = {})
-    ''
-  end  
-end #Creole_inclusion_footnote_group
-
 
 =begin rdoc
-Include images.
-http://www.wikicreole.org/wiki/Images
-
-There are yet more features than in standard.
-
-This is also the default for inclusions.
-
-Usage:
- {{picurl.jpg|Alternate text|class=cc}}
- {{picurl.jpg|Alternate text|css=width:50%}}
- 
-=end
-class Creole_inclusion_img < Creole_inclusion_and_plugin
-  Creole::Inclusions.default = self
+Define meta-methods for Creole_inclusion_and_plugin
+=end 
+  class << self
 =begin rdoc
-Define an image.
-The existence of the picture is checked.
-
-Supported options:
-* alt	(2nd parameter of {{picsrc|...}}
-* css or imgcss
-* class or imgclass
-* longdesc  (can take a url, at leas opera offers to call the description)
-* width    (only LaTeX. For HTML, use css-option).
-
-=end
-  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 )
-
-    #
-    #Check for options
-    #
-    #Missing options:
-    #* align
-    #* border
-    #* height
-    #* hspace	
-    #* name	
-    #* vspace	
-    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
-        when /^width\s*=\s*(.*)/
-          @img[:width] << $1
-        when /^longdesc\s*=\s*(.*)/ #gibt einen URI (nach RFC 2396) an, wo eine Langbeschreibung der Grafik zu finden ist
-          @img[:longdesc] << $1
-        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
-
+Define class as a Inclusion.
+You may use the class as:
+  {{key}}
+=end 
+    def set_inclusions_key(key)
+      Inclusions::Collection[key] = self
+    end
 =begin rdoc
-One footnote
-
-Usage: 
-  <<footnote|text>>
-
-Bug: If you create more documents, you get a common footnote counting.
-Has to be repaired one day.
-=end
-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)
+Define class as a Plugin.
+You may use the class as:
+  <<key>>
+=end 
+    def set_plugin_key(key)
+      Plugins::Collection[key] = self
     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
-
 =begin rdoc
-Some short html
-
-Usage: 
-  {{html|code}}
+fixme
 
-Note:
-There is also a placeholder for larger html:
-  <<<html
-  content
-  >>>
-=end
-class Creole_short_html < Creole_inclusion_and_plugin
-  #We don't use it as plugin. Closing > from html may e confusing as in:
-  # <<html|<em>kursuiv</em>>>
-  #~ Creole::Plugins['html'] = self
-  Creole::Inclusions['html'] = self
-  #~ Creole::Inclusions['footnote'] = self
-  def initialize( inclusionname, description, options, wiki )
-    super
-    options.each{|option|
-      #~ case option
-        #~ else
-        @wiki.log.warn("HTML with unknown option #{option.inspect} not found") if @wiki.log.warn?
-      #~ end
-    }
-    @source = description
+define to_doc...
+=end 
     
-  end
-  #Return content only for html
-  def to_doc( target, options = {})
-    target == :html ? @source.to_doc( target, options ) : ''
-  end  
-end #Creole_inclusion_html
-
-=begin rdoc
-Eval the given ruby-code and put it as "raw text".
-
-
-This is defined as a plugin.
-=end
-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
-
-=begin rdoc
-Eval the given ruby-code and add it as a interpreted code.
+  end #Meta-methods
+end #Creole_inclusion_and_plugin
 
-This is defined as a plugin.
+require_relative 'creole_inclusions.rb'
+require_relative 'creole_characters.rb' #inclusions
+require_relative 'creole_plugins.rb'
 
-Ideas for further development: eval later, at doc generation.
-=end
-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
+end #module Creole
+end #module Docgenerator
 
 #~ if $0 == __FILE__
   #~ require 'quicktest'

data/lib/creole/creole_inclusions.rb

@@ -0,0 +1,142 @@
+=begin rdoc
+Creole inclusions.
+
+This classes are defined to implement inclusions.
+
+* Inclusions are used later with {{xx}}
+  more at http://www.wikicreole.org/wiki/Inclusion
+
+By default, an inclusion expects a pictures, unless it es defined something else.
+
+You can extend Wikis with additional inclusions:
+
+ wiki = Creole.new()
+ wiki.inclusion['xxx'] = Creole_inclusion_xxx
+=end
+
+#
+
+module Docgenerator
+module Creole
+
+=begin rdoc
+Define Inclusions
+
+Inclusions are used via {{...}}
+
+Default: Creole_inclusion_img (defined in class definition Creole_inclusion_img)
+=end
+module Inclusions
+  Collection = Hash.new()
+
+
+=begin rdoc
+Include images.
+http://www.wikicreole.org/wiki/Images
+
+There are yet more features than in standard.
+
+This is also the default for inclusions.
+
+Usage:
+ {{picurl.jpg|Alternate text|class=cc}}
+ {{picurl.jpg|Alternate text|css=width:50%}}
+ 
+=end
+class Creole_inclusion_img < Creole_inclusion_and_plugin
+  Collection.default = self
+=begin rdoc
+Define an image.
+The existence of the picture is checked.
+
+Supported options:
+* alt	(2nd parameter of {{picsrc|...}}
+* css or imgcss
+* class or imgclass
+* longdesc  (can take a url, at leas opera offers to call the description)
+* width    (only LaTeX. For HTML, use css-option).
+
+=end
+  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 )
+
+    #
+    #Check for options
+    #
+    #Missing options:
+    #* align
+    #* border
+    #* height
+    #* hspace	
+    #* name	
+    #* vspace	
+    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
+        when /^width\s*=\s*(.*)/
+          @img[:width] << $1
+        when /^longdesc\s*=\s*(.*)/ #gibt einen URI (nach RFC 2396) an, wo eine Langbeschreibung der Grafik zu finden ist
+          @img[:longdesc] << $1
+        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
+
+=begin rdoc
+Some short html
+
+Usage: 
+  {{html|code}}
+
+Note:
+There is also a placeholder for larger html:
+  <<<html
+  content
+  >>>
+=end
+class Creole_short_html < Creole_inclusion_and_plugin
+  #We don't use it as plugin. Closing > from html may e confusing as in:
+  # <<html|<em>kursuiv</em>>>
+  set_inclusions_key 'html'
+  
+  
+  def initialize( inclusionname, description, options, wiki )
+    super
+    options.each{|option|
+      #~ case option
+        #~ else
+        @wiki.log.warn("HTML with unknown option #{option.inspect} not found") if @wiki.log.warn?
+      #~ end
+    }
+    @source = description
+    
+  end
+  #Return content only for html
+  def to_doc( target, options = {})
+    target == :html ? @source.to_doc( target, options ) : ''
+  end  
+end #Creole_inclusion_html
+
+
+end #module Inclusions
+end #module Creole
+end #module Docgenerator