docgenerator 1.1.1 → 1.2.1

data/lib/creole/creole_inclusion_and_plugins.rb

@@ -16,23 +16,26 @@
 #
 
 
-#
-#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.
+=begin rdoc
+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.
+=end
 class Creole_inclusion_and_plugin
+  include Docgenerator  #get VERSION
+  
   def initialize( inclusionname, description, options, wiki )
     @inclusionname = inclusionname
     @description = description
@@ -52,22 +55,67 @@ 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?
+    @wiki.log.warn("Use Default plugin instead requested #{pluginname}- 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.
+#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
+
 #
-#This is also the default for inclusions.
+#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
+=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).
 
-  #Define an image.
-  #The existence of the picture is checked.
+=end
   def initialize( picname, alt_text, options, wiki )
     super
     @img = element(:img,{  :src => @inclusionname })
@@ -77,6 +125,16 @@ class Creole_inclusion_img < Creole_inclusion_and_plugin
 
     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*(.*)/
@@ -86,6 +144,10 @@ class Creole_inclusion_img < Creole_inclusion_and_plugin
           }
         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
@@ -117,11 +179,15 @@ class Creole_footnote_group < Creole_inclusion_and_plugin
   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.
+=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
@@ -160,11 +226,47 @@ class Creole_footnote < Creole_inclusion_and_plugin
   end  
 end #Creole_inclusion_footnote
 
-#
-#Eval the given ruby-code and put it as "raw text".
-#
-#
-#This is defined as a plugin.
+=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>>>
+  #~ 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
+    
+  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
@@ -189,12 +291,13 @@ class Creole_plugin_ruby_raw < Creole_inclusion_and_plugin
   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.
+=begin rdoc
+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.
+=end
 class Creole_plugin_ruby < Creole_inclusion_and_plugin
   #~ Creole::Inclusions['ruby'] = self
   Creole::Plugins['ruby'] = self

data/lib/creole/creole_placeholder.rb

@@ -1,43 +1,76 @@
-#
-#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
+=begin rdoc
+Placeholder are defined in Creole-Syntax via <<< >>>
+
+Placeholders get a name and optional parameters:
+ <<<name|parameter
+
+Placeholders collect the content between <<< and >>>. 
+
+Derived classes are:
+- Creole_dummy_placeholder
+- Creole_html
+- Creole_latex
+- Creole_tabular
+- Creole_creoletab
+=end
 class Creole_placeholder
-  
-  def initialize( wiki )
+  include Docgenerator  #get VERSION  
+=begin rdoc
+Each placeholder get the wiki where it belongs to.
+
+Parameters are optional.
+
+Definition inside the wiki:
+ <<<name|parameters
+ content
+ >>>
+Placeholders collect the content between <<< and >>>.
+=end
+  def initialize( wiki, parameters = nil )
     @wiki = wiki
+    #
+    @parameters = parameters
     @log  = @wiki.log
   end
+  #
+  #Add the content between <<< and >>>.
   def << (content)
     @source = [] unless @source
     @source << content
   end
   #
-  #possibility to analyse the content.
+  #Possibility to analyse the content.
   def close()
+    @source.freeze
   end
+  #Export it. Should be redefined by sub classes.
   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.
+=begin rdoc
+Just a dummy for wrong definitions.
+
+This class is used by Creole a default placeholder.
+=end
 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.
+=begin rdoc
+Placeholder for pure HTML-output.
+This content is ignored in LaTeX, Wiki... documents.
+
+Usage: 
+  <<<html
+  content
+  >>>
+
+Note:
+There is also a plugin for short html:
+  {{html|code}}
+=end
 class Creole_html < Creole_placeholder
   Creole::Placeholders['html'] = self
   #Return content only for html
@@ -46,16 +79,17 @@ class Creole_html < Creole_placeholder
   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?
+=begin
+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?
+=end
 class Creole_latex < Creole_placeholder
   Creole::Placeholders['latex'] = self
   #Return content only for latex
@@ -64,6 +98,34 @@ class Creole_latex < Creole_placeholder
   end  
 end #Creole_latex 
 
+#
+#Collect 
+#
+class Creole_comment < Creole_placeholder
+  Creole::Placeholders['comment'] = self
+  #Return content as a comment
+  def to_doc( target, options = {})
+    case target
+      when :html; to_html( options )
+      when :latex; to_latex( options )
+      when :context; to_latex( options )
+      when :creole; to_creole( options )
+      else
+        @log.error("Creole_comment not supported for target #{target.inspect}") if @log.error?
+    end
+  end  
+  def to_html(options = {})
+    return "<!-- #{@source.join} -->"
+  end
+  alias :to_context :to_latex
+  def to_latex(options = {})
+    return @source.map{|l| "%#{l}" }.join
+  end
+  def to_creole(options = {})
+    return "<<<comment\n#{@source.join}>>>"
+  end
+end #Creole_html 
+
 
 __END__
 To be done:

data/lib/creole/creole_tabular.rb

@@ -16,21 +16,29 @@ lineoptions:
 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
+
+=begin
+"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
+
+Usage:
+  Tables are done like this:
+  |=header col1|=header col2| 
+  |col1|col2| 
+  |you         |can         | 
+  |also        |align\\ it. | 
+
+=end
 class Creole_creoletab < Creole_placeholder
   Creole::Placeholders['creole_tabular'] = self #original creole-tab definition
+
+  #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)
@@ -75,10 +83,78 @@ class Creole_creoletab < Creole_placeholder
   end  
 end #Creole_tab
 
-#
-#Create tabulars analog to Wikimedia.
+=begin rdoc
+Create tabulars analog to Wikimedia.
+
+Usage:
+  before
+  <<<tabular
+  |!columns=3
+  |!columndescription=ccc
+  |=1
+  |=2
+  |=3
+  |-
+  |eins
+  |zwei
+  |drei
+  |-
+  |one
+  |two
+  |three
+  >>>
+  after
+
+You can add additional settings to cells:
+  <<<tabular
+  |!columns=3
+  |eins||css=color: red
+  |css = zwei
+  |||class=empty
+  >>>
+=end
 class Creole_tabular < Creole_placeholder
   Creole::Placeholders['tabular'] = self
+  
+  #Extend the class by a little structure
+  class Cell 
+=begin rdoc
+The content of a cell is separated from settings by two ||
+
+If you have an empty cell with additional setting, you must write three |
+
+Supported additional settings:
+* css= define css-style options
+* 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:
@@ -88,7 +164,17 @@ class Creole_tabular < Creole_placeholder
     step = 0  #start
     head = []
     content = [[]]
-    options = {}
+    
+    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
@@ -107,9 +193,11 @@ class Creole_tabular < Creole_placeholder
         when /^\|-(.*)/   #new line
           content << []
         when /^\|=/  #header cell
-          content.last << Cell.new(@wiki.inline($~.post_match.strip, options), :th)
+          #~ 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, options), :td)
+          #~ 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
@@ -130,8 +218,7 @@ class Creole_tabular < Creole_placeholder
     content.each{|line|
       @tab << row = element(:row).cr
       line.each{|cell|
-      #fixme cell to wiki/creole
-        row << element(cell.type,{}, cell.content).cr
+        row << cell.cell_element.cr
       }
     }
   end  
@@ -141,6 +228,18 @@ class Creole_tabular < Creole_placeholder
   
 end
 
+
+if $0 == __FILE__
+    creole = Creole.new(
+                    :name => 'tabular_creole',
+                    :content => <<'creole'
+<<<tabular
+|
+>>>
+creole
+    )
+puts creole.to_html
+end    
 __END__
 
 class Creole_tabular_cvs