Webgen::Context

The persistent options. Once initialized, all cloned objects refer to the same hash.

Processing options.

Create a new Context object. You can use the options hash to set needed options.

The following options are set by default and can be overridden via the options hash:

:content

Is set to an empty string.

:processors

Is set to a new AccessHash.

    # File lib/webgen/context.rb, line 46
46:     def initialize(options = {}, persistent = {})
47:       @options = {
48:         :content => '',
49:         :processors => Webgen::ContentProcessor::AccessHash.new
50:       }.merge(options)
51:       @persistent = persistent
52:     end

Return the value of the option name.

    # File lib/webgen/context.rb, line 61
61:     def [](name)
62:       @options[name]
63:     end

Set the option name to the given +value.

    # File lib/webgen/context.rb, line 66
66:     def []=(name, value)
67:       @options[name] = value
68:     end

Create a copy of the current object. You can use the options parameter to override options of the current Context object in the newly created Context object.

    # File lib/webgen/context.rb, line 56
56:     def clone(options = {})
57:       self.class.new(@options.merge(options), @persistent)
58:     end

Return the :content option.

    # File lib/webgen/context.rb, line 71
71:     def content
72:       @options[:content]
73:     end

Set the :content option to the given value.

    # File lib/webgen/context.rb, line 76
76:     def content=(value)
77:       @options[:content] = value
78:     end

Return the node that is ultimately rendered.

This node should be used, for example, for retrieving meta information.

    # File lib/webgen/context/nodes.rb, line 29
29:     def content_node
30:       @options[:chain] && @options[:chain].last
31:     end

Return the node which represents the file into which everything gets rendered. This is normally the same node as # but can differ in special cases. For example, when rendering the content of node called my.page into the output of the node this.page, this.page would be the dest_node and my.page would be the content_node.

The dest_node is not included in the chain but can be set via the option :dest_node!

The returned node should be used as source node for calculating relative paths to other nodes.

    # File lib/webgen/context/nodes.rb, line 14
14:     def dest_node
15:       @options[:dest_node] || self.content_node
16:     end

Return the reference node, ie. the node which provided the original content for this context object.

The returned node should be used, for example, for resolving relative paths.

    # File lib/webgen/context/nodes.rb, line 22
22:     def ref_node
23:       @options[:chain] && @options[:chain].first
24:     end

Render the named block and return the result.

This method uses the functionality of the content processor blocks for doing the actual work, so you may also want to look at Webgen::ContentProcessor::Blocks#render_block. You can call this method in two ways:

#

Renders the block named block_name of the next node in the current node chain. This is the version that most want to use since it is equivalent to the use of <webgen:block name="block_name" />. It is equivalent to #(:name => block_name).

#

This version allows the same level of control over the output as the blocks content processor. For a list of valid options have a look at the documentation of the Webgen::ContentProcessor::Blocks#render_block method!

    # File lib/webgen/context/render.rb, line 25
25:     def render_block(name_or_hash)
26:       name_or_hash = {:name => name_or_hash} if name_or_hash.kind_of?(String)
27:       website.cache.instance('Webgen::ContentProcessor::Blocks').render_block(self, name_or_hash)
28:     end

Returns the result of evaluating the webgen tag name with the tag parameters params and the body in the current context.

Have a look at Webgen::Tag::Base for more information about webgen tags!

This method is useful when you want to have the functionality of webgen tags available but you don’t want to use the content processor for them. Or, for example, if the used markup language uses a similar markup as webgen tags do and therefore you can’t use the normal webgen tags content processor.

    # File lib/webgen/context/tags.rb, line 14
14:     def tag(name, params = {}, body = '')
15:       website.cache.instance('Webgen::ContentProcessor::Tags').process_tag(name, params, body, self)
16:     end