docgenerator 2.1.1 → 3.0.0

data/lib/creole/plugins/rail.rb

@@ -1,181 +0,0 @@
-#encoding: utf-8
-=begin rdoc
-Support for the rail package.
-
-This is support for LaTeX-style rail.
-Don't be confused with ruby on rails - there is no intersection of the two packages.
-=end
-
-require 'creole/creole2doc'
-
-module Docgenerator
-  module Creole
-=begin rdoc
-Support for the rail package.
-
-This is support for LaTeX-style rail.
-
-* http://www.ctan.org/tex-archive/support/rail/
-=end
-    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
-
-=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
-
-      #
-      #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'
-\railalias{lbrace}{\{}
-\railalias{rbrace}{\}}
-\railalias{dollar}{\$}
-\railalias{underscore}{\_}
-\railalias{percent}{\%}
-\railalias{at}{@}
-\railalias{atat}{@@}
-% \railalias{backslash}{\char"5C}
-\railalias{backslash}{\ensuremath{\backslash}}
-\railalias{lt}{\ensuremath{<}}
-\railalias{le}{\ensuremath{<=}}
-\railalias{gt}{\ensuremath{>}}
-\railalias{ge}{\ensuremath{>=}}
-\railalias{caret}{\ensuremath{\hat{}}}
-\railalias{tildeeq}{\ensuremath{\sim=}}
-\railalias{quote}{'}
-\railalias{dquote}{"}%german: \dq
-\railterm{quote,dquote}
-\railterm{lbrace,rbrace,dollar,percent,backslash,underscore,at,atat}
-\railterm{lt,le,gt,ge,caret,tildeeq}
-RAIL_ALIAS
-        #~ \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
-=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
-%
-% Define a rail-diagramm #{@key}
-%
-\\begin{rail}
-#{@key} :
-#{@code.chomp}
-;
-\\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 #module Docgenerator

data/lib/creole/plugins/rubycode4creole.rb

@@ -1,136 +0,0 @@
-=begin rdoc
-Little helper to make documention on ruby scripts,
-Ruby fragments are defined in the creole-source,
-You can get the code and the results.
-
-The source code is enriched with the results and can be shown.
-=end
-
-#Only for quick tests
-$:.unshift("../../") if $0 == __FILE__ 
-
-#~ fixme: use listings instead verbatim
-#~ check usage??
-
-require 'creole/creole2doc'
-require 'docgenerator/packages/rubycode4doc'
-
-module Docgenerator
-module Creole
-
-=begin rdoc
-Write rubycode inside creole-text
-=end
-module Rubycode
-
-=begin rdoc
-Print ruby source code as is
-=end
-class Code < Placeholder
-  set_placeholder_key 'rubycode'
-  #Return content in a verbatim environment
-  def to_doc( target, options = {})
-    codetest = Docgenerator::Rubycode::CodeTest.new(nil, @source.join )
-    #~ element(:verbatim,{},@source ).cr.to_doc( target, options )
-    element(:verbatim, {
-        :style => 'rubycode',
-      }, codetest.sourcecode ).cr.to_doc( target, options )
-  end  
-end #Code
-
-#
-#Print ruby source code and put the result of each line as a comment.
-#
-#Example:
-# 1 + 1
-#becomes 
-# 1 + 1   #2
-class Code_evaluated < Placeholder
-  set_placeholder_key 'rubycode_evaluated'
-  #Return content in a verbatim environment
-  def to_doc( target, options = {})
-    codetest = Docgenerator::Rubycode::CodeTest.new(nil, @source.join )
-    #~ element(:verbatim,{},@source ).cr.to_doc( target, options )
-    element(:verbatim, {
-        :style => 'rubycode_evaluated',
-      }, codetest.code_evaluation ).cr.to_doc( target, options )
-  end  
-end #Code_evaluated
-
-#
-#Print ruby source code and put the result of each line as a comment.
-#
-#Same as Code_evaluated, but export is done for in TeX-Package listings.
-class Code_evaluated_listings < Placeholder
-  set_placeholder_key 'rubycode_evaluated_listings'
-  #Return content in a verbatim environment
-  def to_doc( target, options = {})
-    codetest = Docgenerator::Rubycode::CodeTest.new(nil, @source.join )
-    #~ element(:verbatim, {
-        #~ :style => 'rubycode_evaluated',
-      #~ }, codetest.code_evaluation ).cr.to_doc( target, options )
-   codetest.code_evaluation_lstlisting.to_doc( target, options )
-      
-  end  
-end #Code_evaluated_listing
-
-#
-#Take only the output of the rubycode
-#
-class Code_output < Placeholder
-  set_placeholder_key 'rubycode_output'
-  #Return content in a verbatim environment
-  def to_doc( target, options = {})
-    codetest = Docgenerator::Rubycode::CodeTest.new(nil, @source.join )
-    #~ element(:verbatim,{},@source ).cr.to_doc( target, options )
-    element(:verbatim, {
-        :style => 'rubycode_output',
-      }, codetest.output ).cr.to_doc( target, options )
-  end  
-end #Code_output
-
-#
-#Build a table.
-#Each row corresponds with a source code line.
-#You get source code, result and output of the code line.
-#
-#
-class Code_in_tab < Placeholder
-  set_placeholder_key 'rubycode_in_tab'
-  #Return content in a verbatim environment
-  def to_doc( target, options = {})
-    codetest = Docgenerator::Rubycode::CodeTest.new(nil, @source.join )
-    codetest.code_in_tab.to_doc( target, options )
-  end  
-end #Code_in_tab
-end #module Rubycode
-end #module Creole
-end #module Docgenerator
-
-if $0 == __FILE__
-    wiki = Docgenerator::Creole::Creole.new()
-    wiki << <<wiki
-rubycode
-<<<rubycode
-1 + 1
->>>
-----
-rubycode_output
-<<<rubycode_output
-puts 1 + 1
->>>
-----
-rubycode_evaluated
-<<<rubycode_evaluated
-1 + 1
->>>
-----
-rubycode_in_tab
-<<<rubycode_in_tab
-1 + 1
->>>
-wiki
-puts wiki.to_html
-end
-
-__END__

data/lib/creole/plugins/struktex.rb

@@ -1,59 +0,0 @@
-=begin rdoc
-Add support of Struktex::Structogramm for Creole.
-=end
-require 'creole/creole2doc'
-require 'docgenerator/packages/struktex.rb'
-
-module Docgenerator
-  module Creole
-
-=begin rdoc
-Define Creole placeholder.
-
-The placeholder insertion must contain three parameters:
-
-  >>>structogramm{Declarations/Interfaces;120;25}
-        Statement
-        ->	field1	description
-        <-	field2	description
-        <->	field3	description
-  <<<
-Details see Docgenerator::Structogramm
-=end
-    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 
-
-  end #module Creole
-end #module Docgenerator

data/lib/creole/plugins/todonotes.rb

@@ -1,77 +0,0 @@
-require 'docgenerator/packages/todonotes.rb'
-
-module Docgenerator
-  module Creole
-
-=begin rdoc
-Classes to provide support for the todonotes-package.
-
-* http://ctan.org/tex-archive/macros/latex/contrib/todonotes/
-=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
-      class Creole_todo < Creole_inclusion_and_plugin
-        
-        set_plugin_key('todo')  #use <<todo|..>>
-        
-        #define default options for todonotes. may be redefined for children of this class.
-        def default_options; {}; end
-
-=begin rdoc
-Usage:
-  <<todo|what to do|color=red>>
-=end
-        def initialize( inclusionname, description, options, wiki )
-          #~ @inclusionname = inclusionname #fix 'todo'
-          @description = description
-          @options = default_options.dup
-          options.each{|opt|
-            case opt
-              when /color\s*=\s*/
-                @options[:color] = $~.post_match
-              when /inline/
-                @options[:inline] = true
-              else
-                wiki.log.warn("Todo #{@description} with undefined option #{opt}")
-              end
-            }
-          @wiki = wiki
-          
-          raise "Inclusion received no wiki but #{wiki.inspect}" unless wiki.is_a?(Creole)
-        end
-        
-        def to_doc(target, options = {})
-          element(:todo, @options, @description).to_doc(target, options)
-        end  
-      end #Creole_todo
-
-=begin rdoc
-A variant of Creole_todo with green color.
-=end
-      class Creole_todo_green < Creole_todo
-          set_plugin_key('todo_green') #use <<todo_green|..>>
-        #define default options for todonotes. may be redefined for children of this class.
-        def default_options; {:color => 'green'}; end
-      end
-
-=begin rdoc
-A variant of Creole_todo with inline-layout.
-=end
-      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; {:inline => true}; end
-      end
-
-    end #module Todo
-  end #module Creole
-end #module Docgenerator