Summary | Creates a breadcrumb trail (i.e. shows the directory hierarchy) for the content page |
---|---|
Tag names | breadcrumb_trail |
Configuration prefix | tag.breadcrumb_trail |
Used options |
tag.breadcrumb_trail.separator tag.breadcrumb_trail.omit_dir_index tag.breadcrumb_trail.start_level tag.breadcrumb_trail.end_level tag.breadcrumb_trail.template |
Provided by bundle | built-in |
API doc | Webgen::Tag::BreadcrumbTrail |
Description
The tag breadcrumb_trail is used for showing the breadcrumb trail for a page, i.e. it shows the hierarchy of a page.
Usage
The behavior of this tag can be configured via the available configuration options, see above.
If you want to generate different HTML, you will need to create a custom template and use the tag.breadcrumb_trail.template option (see the general tags documentation for more information).
Furthermore, the behavior of the tag.breadcrumb_trail.omit_dir_index configuration option can be overridden for individual directory index nodes by setting the omit_dir_index meta information accordingly.
Examples
{breadcrumb_trail:}
- Home / Documentation / Reference / Extensions / tag / tag.breadcrumb_trail
{breadcrumb_trail: {separator: " HELLO "}}
- Home HELLO Documentation HELLO Reference HELLO Extensions HELLO tag HELLO tag.breadcrumb_trail
{breadcrumb_trail: {end_level: -2}}
- Home / Documentation / Reference / Extensions / tag
{breadcrumb_trail: {start_level: 1}}
- Documentation / Reference / Extensions / tag / tag.breadcrumb_trail