Contents

---
title: Webgen::Tag::BreadcrumbTrail
used_options:
  - tag.breadcrumbtrail.separator
  - tag.breadcrumbtrail.omit_index_path
  - tag.breadcrumbtrail.start_level
  - tag.breadcrumbtrail.end_level
---
## Description

The breadcrumb trail tag is used for displaying the hierarchy of the current page. The behavior of
the `tag.breadcrumbtrail.omit_index_path` option can be overridden for individual index paths by
setting the meta information `omit_index_path` accordingly.

The amount of levels shown can be customized by using the options `tag.breadcrumbtrail.start_level`
and `tag.breadcrumbtrail.end_level`, see the examples below.

## Examples

<table class="examples">
<tr>
  <th>Usage</th><th>Output</th>
</tr>
<tr>
  <td>\{breadcrumb_trail:}</td>
  <td>{breadcrumb_trail:}</td>
</tr>
<tr>
  <td>\{breadcrumb_trail: {separator: " HELLO "}}</td>
  <td>{breadcrumb_trail: {separator: " HELLO "}}</td>
</tr>
<tr>
  <td>\{breadcrumb_trail: {end_level: -2}}</td>
  <td>{breadcrumb_trail: {end_level: -2}}</td>
</tr>
<tr>
  <td>\{breadcrumb_trail: {start_level: 1}}</td>
  <td>{breadcrumb_trail: {start_level: 1}}</td>
</tr>
</table>

Version data entries

24 entries across 24 versions & 3 rubygems

Version	Path
webgen-0.5.5	doc/tag/breadcrumbtrail.page
webgen-0.5.6	doc/tag/breadcrumbtrail.page
webgen-0.5.7	doc/tag/breadcrumbtrail.page
webgen-0.5.8	doc/tag/breadcrumbtrail.page