docgenerator 2.1.1 → 3.0.0

data/lib/creole/creole_characters.rb

@@ -1,120 +0,0 @@
-=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 'thinsp' as {{thinsp}}
-
-Could be used as Soft hypen (&shy;) without dash:
-http://stackoverflow.com/questions/5038920/html-soft-hypen-shy-without-dash
-=end
-      class Creole_thinsp < Creole_inclusion_and_plugin
-        set_inclusions_key 'thinsp'
-        
-        def to_doc(target, options = {})
-          element(:thinsp).to_doc(target, options)
-        end  
-      end #Creole_thinsp
-=begin rdoc
-Define a 'wbr' as {{wbr}}
-=end
-      class Creole_wbr < Creole_inclusion_and_plugin
-        set_inclusions_key 'wbr'
-        
-        def to_doc(target, options = {})
-          element(:wbr).to_doc(target, options)
-        end  
-      end #Creole_wbr
-=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
-
-=begin rdoc
-=end
-      class Creole_gt < Creole_inclusion_and_plugin
-        set_inclusions_key 'gt'
-        set_inclusions_key '>'
-        
-        def to_doc(target, options = {})
-          element(:gt).to_doc(target, options)
-        end  
-      end #Creole_gt
-=begin rdoc
-=end
-      class Creole_lt < Creole_inclusion_and_plugin
-        set_inclusions_key '<'
-        
-        def to_doc(target, options = {})
-          element(:lt).to_doc(target, options)
-        end  
-      end #Creole_lt
-
-=begin rdoc
-=end
-      class Creole_gg < Creole_inclusion_and_plugin
-        set_inclusions_key 'dgt'
-        set_inclusions_key '>>'
-        
-        def to_doc(target, options = {})
-          element(:gg).to_doc(target, options)
-        end  
-      end #Creole_gt
-=begin rdoc
-=end
-      class Creole_ll < Creole_inclusion_and_plugin
-        set_inclusions_key 'dlt'
-        set_inclusions_key '<<'
-        
-        def to_doc(target, options = {})
-          element(:ll).to_doc(target, options)
-        end  
-      end #Creole_lt
-      
-    end #module Characters
-  end #module Creole
-end #module Docgenerator

data/lib/creole/creole_inclusion_and_plugins.rb

@@ -1,96 +0,0 @@
-=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.
-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
-=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
-        @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
-
-=begin rdoc
-Define meta-methods for Creole_inclusion_and_plugin
-=end 
-      class << self
-=begin rdoc
-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
-Define class as a Plugin.
-You may use the class as:
-  <<key>>
-=end 
-        def set_plugin_key(key)
-          Plugins::Collection[key] = self
-        end
-
-      end #Meta-methods
-    end #Creole_inclusion_and_plugin
-
-    require_relative 'creole_inclusions.rb'
-    require_relative 'creole_characters.rb' #defined as inclusions
-    require_relative 'creole_plugins.rb'
-
-  end #module Creole
-end #module Docgenerator
-

data/lib/creole/creole_inclusions.rb

@@ -1,154 +0,0 @@
-=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 least 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 /^height\s*=\s*(.*)/
-                @img[:height] << $1
-              when /^texoption\s*=\s*(.*)/
-                @img[:texoption] << $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
-=begin
-Fixme for image:
-pack it into a figure-environment (HTML: div/span + float)
-{{test.jpg|description|beforetitle=vorher]]
-{{test.jpg|description|aftertitle=nachher}}
-{{test.jpg|description|figureclass=imgclass}}
-description = caption
-=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 be 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
-
-

data/lib/creole/creole_placeholder.rb

@@ -1,171 +0,0 @@
-module Docgenerator
-  module Creole
-
-=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::Placeholders::Dummy
-- Creole::Placeholders::Html
-- Creole::Placeholders::Latex
-- Creole::Creole_tabular
-- Creole::Creole_tab
-=end
-    class Placeholder
-=begin rdoc
-Define meta-methods for Creole_inclusion_and_plugin
-=end 
-        class << self
-=begin rdoc
-Define class as a placeholder.
-You may use the class as:
-  {{key}}
-=end 
-          def set_placeholder_key(key)
-            Placeholders::Collection[key] = self
-          end
-        end
-        
-        #Error is thrown, if the parameters don't fit the need of the placeholder
-        class ParameterError < ArgumentError; end;
-=begin rdoc
-Each placeholder get the wiki where it belongs to.
-
-Parameters is an optional string.
-
-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.
-        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 #Placeholder
-
-
-=begin rdoc
-Collection of Placeholder-children
-
-Placeholders are used via <<<...>>>.
-=end
-    module Placeholders  
-=begin rdoc
-Just a dummy for wrong definitions.
-
-This class is used by Creole a default placeholder.
-=end
-      class Dummy < Placeholder
-      end #Placeholder::Dummy
-
-      #List of defined Placeholders.
-      Collection = Hash.new( Dummy )
-      #Get a Placeholder.
-      def self.[](key)
-        Collection[key]
-      end
-
-
-=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 < Placeholder
-        set_placeholder_key 'html'
-        #Return content only for html
-        def to_doc( target, options = {})
-          target == :html ? @source.to_doc( target, options ) : ''
-        end  
-      end #Creole_html 
-
-=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 < Placeholder
-        set_placeholder_key 'latex'
-        #Return content only for latex
-        def to_doc( target, options = {})
-          target == :latex ? @source.to_doc( target, options ) : ''
-        end  
-      end #Creole_latex 
-
-      #
-      #Usage: 
-      #  <<<comment
-      #  This text is a comment.
-      #  >>>
-      #
-      class Creole_comment < Placeholder
-        set_placeholder_key 'comment'
-        #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_comment
-    end #module Placeholders
-  end #module Creole
-end #module Docgenerator
-
-
-__END__
-To be done:
-rubycode (see plugin  Creole_plugin_ruby )
-
-Steuerparameter mit | nach plugin-name?