docgenerator 2.1.0 → 2.1.1

data/lib/creole/creole_plugins.rb

@@ -15,7 +15,7 @@ You can extend Wikis with additional Plugin:
 #
 
 module Docgenerator
-module Creole
+  module Creole
 
 =begin rdoc
 Creole plugins
@@ -30,21 +30,21 @@ You can extend Wikis with additional Plugin:
  wiki = Creole.new()
  wiki.plugin['xxx'] = Creole_plugin_xxx
 =end
-module Plugins
+    module Plugins
 
 =begin rdoc
 Default Plugin for Creole.
   <<xx>>
 =end
-class Creole_default_plugin < Creole_inclusion_and_plugin
-  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
+      class Creole_default_plugin < Creole_inclusion_and_plugin
+        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
 
-#Collection of Plugins
-Collection = Hash.new(Creole_default_plugin)
+      #Collection of Plugins
+      Collection = Hash.new(Creole_default_plugin)
 
 
 =begin rdoc
@@ -54,28 +54,28 @@ Makes sense for HTML-output.
 
 For LaTeX the support of bigfoot/manyfoot... may be an idea.
 =end
-class Creole_footnote_group < Creole_inclusion_and_plugin
-  #
-  
-  Collection['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
+      class Creole_footnote_group < Creole_inclusion_and_plugin
+        #
+        
+        Collection['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
 =begin rdoc
 Call Docgenerator::Footnotegroup#to_doc
 =end
-  def to_doc(target, options = {})
-    #remove options for Docgenerator::Footnotegroup
-    l_options = options.dup
-    l_options.delete(:plugins)
-    l_options.delete(:inclusions)
-    @footnotesgroup.to_doc(target, l_options)
-  end  
-end #Creole_inclusion_footnote_group
+        def to_doc(target, options = {})
+          #remove options for Docgenerator::Footnotegroup
+          l_options = options.dup
+          l_options.delete(:plugins)
+          l_options.delete(:inclusions)
+          @footnotesgroup.to_doc(target, l_options)
+        end  
+      end #Creole_inclusion_footnote_group
 
 =begin rdoc
 One footnote
@@ -91,43 +91,77 @@ Solution:
 * LaTeX: no problem, LaTeX has it's own output mechanism.
 * HTML: Use grouping.
 =end
-class Creole_footnote < Creole_inclusion_and_plugin
-  Collection['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
+      class Creole_footnote < Creole_inclusion_and_plugin
+        Collection['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
+
+=begin rdoc
+Some short latex
+
+Usage: 
+  <<latex|code>>
+
+Note:
+There is also a placeholder for larger latex:
+  <<<latex
+  content
+  >>>
+=end
+      class Creole_short_latex < Creole_inclusion_and_plugin
+        #We don't use it as inclusion. Closing } from latex may be confusing as in:
+        # {{latex|\texttt{kursuiv}}}
+        set_plugin_key 'latex'
+        
+        def initialize( inclusionname, description, options, wiki )
+          super
+          options.each{|option|
+            #~ case option
+              #~ else
+              @wiki.log.warn("latex with unknown option #{option.inspect} not found") if @wiki.log.warn?
+            #~ end
+          }
+          @source = description
+          
+        end
+        #Return content only for latex
+        def to_doc( target, options = {})
+          target == :latex ? @source.to_doc( target, options ) : ''
+        end  
+      end #Creole_short_latex
 
 
 =begin rdoc
@@ -136,28 +170,28 @@ 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
-  set_plugin_key 'ruby_raw'
-  
-  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
+      class Creole_plugin_ruby_raw < Creole_inclusion_and_plugin
+        set_plugin_key 'ruby_raw'
+        
+        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 #initialize
+        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.
@@ -166,33 +200,31 @@ This is defined as a plugin.
 
 Ideas for further development: eval later, at doc generation.
 =end
-class Creole_plugin_ruby < Creole_inclusion_and_plugin
-  set_plugin_key 'ruby'
-  
-  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 Plugins
-end #module Creole
+      class Creole_plugin_ruby < Creole_inclusion_and_plugin
+        set_plugin_key 'ruby'
+        
+        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 #initialize  
+        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 Plugins
+  end #module Creole
 end #module Docgenerator