Module: Webgen::Tag::BreadcrumbTrail

Defined in:
lib/webgen/tag/breadcrumb_trail.rb

Overview

Generates a breadcrumb trail for the page. Such a breadcrumb trail is especially useful when pages are in deep hierarchies of directories.

Class Method Summary collapse

Class Method Details

.call(tag, body, context) ⇒ Object

Create the breadcrumb trail.



13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/webgen/tag/breadcrumb_trail.rb', line 13

def self.call(tag, body, context)
  options = {
    :alcn => context.content_node.alcn,
    :start_level => context[:config]['tag.breadcrumb_trail.start_level'],
    :end_level => context[:config]['tag.breadcrumb_trail.end_level'],
    :omit_dir_index => context[:config]['tag.breadcrumb_trail.omit_dir_index']
  }
  context.website.ext.item_tracker.add(context.dest_node, :nodes,
                                       ['Webgen::Tag::BreadcrumbTrail', 'nodes'], options, :meta_info)

  context[:nodes] = nodes(context.website, options)
  Webgen::Tag.render_tag_template(context, 'breadcrumb_trail')
end

.nodes(website, options) ⇒ Object

Return the list of nodes that make up the breadcrumb trail of a node while respecting the parameters.

The options hash needs to include the following keys:

:alcn

The alcn of the node for which the breadcrumb trail should be generated.

:start_level

The start level (an index into an array).

:end_level

The end level (an index into an array).

:omit_dir_index

If set, omits the last path component if it is a directory index.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/webgen/tag/breadcrumb_trail.rb', line 44

def self.nodes(website, options)
  node = website.tree[options[:alcn]]
  nodes = []
  omit_dir_index = if node.meta_info.has_key?('omit_dir_index')
                     node['omit_dir_index']
                   else
                     options[:omit_dir_index]
                   end

  node = node.parent if omit_dir_index && node.parent.proxy_node(node.lang) == node

  until node == website.tree.dummy_root
    nodes.unshift(node)
    node = node.parent
  end
  nodes[options[:start_level]..options[:end_level]].to_a
end