Class: Docgenerator::Creole::Creole_structogramm

Inherits:
Placeholder
  • Object
show all
Defined in:
lib/docgenerator/creole/plugins/struktex.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Placeholder

#<<, #close, set_placeholder_key

Constructor Details

#initialize(wiki, parameters = nil) ⇒ Creole_structogramm

~ fixme ~ parameters optional als placeholder, ~ hier aber benötigt. ~ Defaults??



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/docgenerator/creole/plugins/struktex.rb', line 32

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 Attribute Details

#structogramm ⇒ Object (readonly)

Instance of class Structogramm.



51
52
53
 
# File 'lib/docgenerator/creole/plugins/struktex.rb', line 51

def structogramm
  @structogramm
end

Instance Method Details

#to_doc(target, options = {}) ⇒ Object

Return content only for latex



54
55
56
 
# File 'lib/docgenerator/creole/plugins/struktex.rb', line 54

def to_doc( target, options = {})
  target == :latex ? @structogramm.to_doc( target, options ) : ''
end