docgenerator 2.0.0 → 2.1.0

data/lib/creole/plugins/rail.rb

@@ -1,3 +1,4 @@
+#encoding: utf-8
 =begin rdoc
 Support for the rail package.
 
@@ -8,7 +9,7 @@ Don't be confused with ruby on rails - there is no intersection of the two packa
 require 'creole/creole2doc'
 
 module Docgenerator
-module Creole
+  module Creole
 =begin rdoc
 Support for the rail package.
 
@@ -16,100 +17,99 @@ This is support for LaTeX-style rail.
 
 * http://www.ctan.org/tex-archive/support/rail/
 =end
-module Rail
+    module Rail
 
-#
-#A Wrapper for the Creole-placeholder for Rail-diagramms.
-#
-class Diagramm4Creole < Placeholder
-  set_placeholder_key 'rail'
-
-  def initialize( wiki, name = 'Raildiagramm')
-    super
-    @name = name
-    raise ParameterError, "Missing id for rail-diagramm" unless @name
-    raise ParameterError, "Id for rail-diagramm contains no-letter" unless @name =~ /\A\w+\Z/
-  end
-  
-#fixme
-    #Check if the rail-diagramm is available as a picture.
-    #~ @filename = "#{@key}.png"
-    #~ if ! File.exist?( @filename )
-      #~ @filename = nil
-    #~ end
+      #
+      #A Wrapper for the Creole-placeholder for Rail-diagramms.
+      #
+      class Diagramm4Creole < Placeholder
+        set_placeholder_key 'rail'
 
+        def initialize( wiki, name = 'Raildiagramm')
+          super
+          @name = name
+          raise ParameterError, "Missing id for rail-diagramm" unless @name
+          raise ParameterError, "Id for rail-diagramm contains no-letter" unless @name =~ /\A\w+\Z/
+        end
+        
+      #fixme
+          #Check if the rail-diagramm is available as a picture.
+          #~ @filename = "#{@key}.png"
+          #~ if ! File.exist?( @filename )
+            #~ @filename = nil
+          #~ end
 
 =begin rdoc
 Return content only for LaTeX
 =end
-  def to_doc( target, options = {})
-  #fixme: Einmalig beim initialisieren
-  #fixme: Varianten erledigen
-  #fixme: Bild falls verf�gbar
-  #fixme: nur TeX (oder Bild)
-  #fixme logs
-    #~ case options[:elementtype]
-      #~ when nil    #ignore diagramm
-      #~ when :minipage
-        #~ return to_element_minipage()
-      #~ when :figure
-        #~ return to_element_figure()
-      #~ when :figure_img
-        #~ return to_element_figure_img()
-      #~ when :latexonly
-        #~ return element(:latexonly,{}, self.to_latex_rail ).cr
-      #~ else
-        #~ option[:log].error("Raildiagramm#to_element: Undefined type #{@@elementtype}") if option[:log].error?
-      #~ end
-    
-    #fixme Bild?
-    Rail_diagramm.new( @name, @source ).to_doc( target, options )
-  end    
-  #Check for picture and return a :img-macro (Only html)
-  def to_img()
-    return element( :img, { :src => @filename }) if @filename
-  end
-  #~ def to_element_figure()
-    #~ figure  = element(:figure).cr
-    #~ figure  << self.to_s
-    #~ figure  << element(:caption,{}, "Rail-Diagramm #{@key}" ).Cr
-    #~ return figure 
-  #~ end
-  #~ def to_element_figure_img()
-    #~ if @filename
-      #~ figure  = element(:figure, { :style => CSS.new(
-                      #~ :text_align => 'center',
-                      #~ :float  => 'right'
-                    #~ )}).cr
-      #~ figure  << self.to_img 
-      #~ figure  << element(:br).cr
-      #~ figure  << element(:caption,{}, "Rail-Diagramm #{@key}" ).Cr
-    #~ else
-      #~ figure = nil
-    #~ end
-    #~ return figure 
-  #~ end
-  #~ #Requires caption.sty
-  #~ #  doc.head  << element(:usepackage,{}, 'caption') 
-  #~ def to_element_minipage()
-    #~ figure  = element(:minipage, {:width => '\textwidth'} ).CR
-    #~ figure  << element(:centering)
-    #~ figure  << self.to_s
-    #~ figure  << element(:captionof,{ :float_type => 'figure' }, "Rail-Diagramm #{@key}" ).Cr
-    #~ return figure 
-  #~ end
-end #Rail_diagramm4Creole
+        def to_doc( target, options = {})
+        #fixme: Einmalig beim initialisieren
+        #fixme: Varianten erledigen
+        #fixme: Bild falls verfügbar
+        #fixme: nur TeX (oder Bild)
+        #fixme logs
+          #~ case options[:elementtype]
+            #~ when nil    #ignore diagramm
+            #~ when :minipage
+              #~ return to_element_minipage()
+            #~ when :figure
+              #~ return to_element_figure()
+            #~ when :figure_img
+              #~ return to_element_figure_img()
+            #~ when :latexonly
+              #~ return element(:latexonly,{}, self.to_latex_rail ).cr
+            #~ else
+              #~ option[:log].error("Raildiagramm#to_element: Undefined type #{@@elementtype}") if option[:log].error?
+            #~ end
+          
+          #fixme Bild?
+          Rail_diagramm.new( @name, @source ).to_doc( target, options )
+        end    
+        #Check for picture and return a :img-macro (Only html)
+        def to_img()
+          return element( :img, { :src => @filename }) if @filename
+        end
+        #~ def to_element_figure()
+          #~ figure  = element(:figure).cr
+          #~ figure  << self.to_s
+          #~ figure  << element(:caption,{}, "Rail-Diagramm #{@key}" ).Cr
+          #~ return figure 
+        #~ end
+        #~ def to_element_figure_img()
+          #~ if @filename
+            #~ figure  = element(:figure, { :style => CSS.new(
+                            #~ :text_align => 'center',
+                            #~ :float  => 'right'
+                          #~ )}).cr
+            #~ figure  << self.to_img 
+            #~ figure  << element(:br).cr
+            #~ figure  << element(:caption,{}, "Rail-Diagramm #{@key}" ).Cr
+          #~ else
+            #~ figure = nil
+          #~ end
+          #~ return figure 
+        #~ end
+        #~ #Requires caption.sty
+        #~ #  doc.head  << element(:usepackage,{}, 'caption') 
+        #~ def to_element_minipage()
+          #~ figure  = element(:minipage, {:width => '\textwidth'} ).CR
+          #~ figure  << element(:centering)
+          #~ figure  << self.to_s
+          #~ figure  << element(:captionof,{ :float_type => 'figure' }, "Rail-Diagramm #{@key}" ).Cr
+          #~ return figure 
+        #~ end
+      end #Rail_diagramm4Creole
 
-#
-#A Rail-diagramm
-#
-class Rail_diagramm
+      #
+      #A Rail-diagramm
+      #
+      class Rail_diagramm
 
-  #Can be used in document header to load rail.sty
-  TEX_PACKAGE_RAIL  = element(:usepackage,{ }, 'rail').cr
-  #Some command to be added in document header.
-  #Allows the usage of some characters as terminals.
-  RAIL_ALIAS  = <<'RAIL_ALIAS'
+        #Can be used in document header to load rail.sty
+        TEX_PACKAGE_RAIL  = element(:usepackage,{ }, 'rail').cr
+        #Some command to be added in document header.
+        #Allows the usage of some characters as terminals.
+        RAIL_ALIAS  = <<'RAIL_ALIAS'
 \railalias{lbrace}{\{}
 \railalias{rbrace}{\}}
 \railalias{dollar}{\$}
@@ -131,29 +131,29 @@ class Rail_diagramm
 \railterm{lbrace,rbrace,dollar,percent,backslash,underscore,at,atat}
 \railterm{lt,le,gt,ge,caret,tildeeq}
 RAIL_ALIAS
-#~ \railalias{ampersand}{\&} -> umgesetht nachh << head>>
+        #~ \railalias{ampersand}{\&} -> umgesetht nachh << head>>
 
-  #Create new Rail diagramm.
-  #Parameter:
-  #-key 
-  #-rail-definition
-  def initialize( key, code = '' )
-    @key  = key
-    @code  = code
-  end
-  #Implement << for Wikicollector
-  def << (code)
-    @code << code
-  end
+        #Create new Rail diagramm.
+        #Parameter:
+        #-key 
+        #-rail-definition
+        def initialize( key, code = '' )
+          @key  = key
+          @code  = code
+        end
+        #Implement << for Wikicollector
+        def << (code)
+          @code << code
+        end
 =begin  
 Return LaTeX-environment rail
 Requires rail.sty and rail.exe to generate the figure.
 
 
 =end 
-  def to_latex(options = {})
-    @code = @code.join if @code.respond_to?(:join) #if Array is given
-    return <<-RAIL
+        def to_latex(options = {})
+          @code = @code.join if @code.respond_to?(:join) #if Array is given
+          return <<-RAIL
 %
 % Define a rail-diagramm #{@key}
 %
@@ -163,20 +163,19 @@ Requires rail.sty and rail.exe to generate the figure.
 ;
 \\end{rail}
 RAIL
-  end #to_latex
-  def to_doc( target, options = {})
-    case target
-      when :latex 
-        self.to_latex( options )
-      else
-        o = set_option_defaults(options)
-        #~ o[:log].debug("enter to_doc(#{target}) for #{self.inspect}, options: #{options.keys.inspect}") if o[:log].debug?
-        o[:log].error("Rail-diagramm not supported for #{target}") if o[:log].error?
-        ''
-    end #case target
-  end #to_doc 
-end
-
-end #module Rail
-end #module Creole
+        end #to_latex
+        def to_doc( target, options = {})
+          case target
+            when :latex 
+              self.to_latex( options )
+            else
+              o = set_option_defaults(options)
+              #~ o[:log].debug("enter to_doc(#{target}) for #{self.inspect}, options: #{options.keys.inspect}") if o[:log].debug?
+              o[:log].error("Rail-diagramm not supported for #{target}") if o[:log].error?
+              ''
+          end #case target
+        end #to_doc 
+      end
+    end #module Rail
+  end #module Creole
 end #module Docgenerator

data/lib/creole/plugins/struktex.rb

@@ -5,7 +5,7 @@ require 'creole/creole2doc'
 require 'docgenerator/packages/struktex.rb'
 
 module Docgenerator
-module Creole
+  module Creole
 
 =begin rdoc
 Define Creole placeholder.
@@ -20,40 +20,40 @@ The placeholder insertion must contain three parameters:
   <<<
 Details see Docgenerator::Structogramm
 =end
-class Creole_structogramm < Placeholder
-  set_placeholder_key('structogramm')
-  
-#~ fixme
-#~ parameters optional als placeholder,
-#~ hier aber ben�tigt. 
-#~ Defaults??
+    class Creole_structogramm < Placeholder
+      set_placeholder_key('structogramm')
+      
+    #~ fixme
+    #~ parameters optional als placeholder,
+    #~ hier aber benötigt. 
+    #~ Defaults??
 
-  def initialize( wiki, parameters = nil)
-    super
-    #~ @wiki = wiki
-    #~ @log  = @wiki.log
-    par = parameters ? parameters.split(/;/) : []
-    case par.size
-      when 0
-        raise ParameterError, "Creole_structogramm: Missing parameters"
-      when 3
-        title = par[0]
-        x = par[1]
-        y = par[2]
-        @source = ''
-        @structogramm = Packages::Struktex::Structogramm.new( title, x, y, @source )
-    else
-      raise ParameterError, "Creole_structogramm: Wrong number of parameters: #{parameters.inspect}"
-    end
-  end
-  #Instance of class Structogramm.
-  attr_reader :structogramm
-  
-  #Return content only for latex
-  def to_doc( target, options = {})
-    target == :latex ? @structogramm.to_doc( target, options ) : ''
-  end  
-end #Creole_latex 
+      def initialize( wiki, parameters = nil)
+        super
+        #~ @wiki = wiki
+        #~ @log  = @wiki.log
+        par = parameters ? parameters.split(/;/) : []
+        case par.size
+          when 0
+            raise ParameterError, "Creole_structogramm: Missing parameters"
+          when 3
+            title = par[0]
+            x = par[1]
+            y = par[2]
+            @source = ''
+            @structogramm = Packages::Struktex::Structogramm.new( title, x, y, @source )
+        else
+          raise ParameterError, "Creole_structogramm: Wrong number of parameters: #{parameters.inspect}"
+        end
+      end
+      #Instance of class Structogramm.
+      attr_reader :structogramm
+      
+      #Return content only for latex
+      def to_doc( target, options = {})
+        target == :latex ? @structogramm.to_doc( target, options ) : ''
+      end  
+    end #Creole_latex 
 
-end #module Creole
+  end #module Creole
 end #module Docgenerator

data/lib/creole/plugins/todonotes.rb

@@ -10,6 +10,12 @@ Classes to provide support for the todonotes-package.
 =end
 module Todo
 
+class Creole_todolist < Creole_inclusion_and_plugin
+  set_plugin_key('listoftodos')  #use <<todo|..>>
+  def to_doc(target, options = {})
+    element(:listoftodos, options).to_doc(target, options)
+  end    
+end
 =begin rdoc
 Define a plugin for the todonotes-package.
 =end
@@ -47,6 +53,7 @@ Usage:
     element(:todo, @options, @description).to_doc(target, options)
   end  
 end #Creole_todo
+
 =begin rdoc
 A variant of Creole_todo with green color.
 =end
@@ -62,7 +69,7 @@ A variant of Creole_todo with inline-layout.
 class Creole_todo_inline < Creole_todo
   set_plugin_key('todo_inline') #use <<todo_inline|..>>
   #define default options for todonotes. may be redefined for children of this class.
-  def default_options; {:layout => 'green'}; end
+  def default_options; {:inline => true}; end
 end
 
 end #module Todo