Sha256: 7c71bf0230bcdac022154eed64d7d167d161c870652739753664aef38fa54a27

Contents?: true

Size: 1.23 KB

Versions: 6

Compression:

Stored size: 1.23 KB

Contents

---
title: BreadcrumbTrail
inMenu: true
template: /plugin.template
plugin: Tag/BreadcrumbTrail
---
h2(#description). Description


The breadcrumb trail tag is used to display the hierarchy for the current page. You can see it in
action above the main content area.

The {param: Tag/BreadcrumbTrail:omitLast} parameter can be used for always omitting the last path
component in the trail (which is normally the page itself).

The {param: Tag/BreadcrumbTrail:omitIndexFile} parameter can be used to omit the last path component
if it is an index file for an directory (see {plugin: File/DirectoryHandler} for more information
about index files). This behaviour can be overridden for individual index files by setting the meta
information @omitIndexFileInBreadcrumbTrail@.


h2(#examples). Examples


<table class="examples">
<tr>
  <th>Usage</th><th>Output</th>
</tr>
<tr>
  <td>\{breadcrumbTrail:}</td>
  <td>{breadcrumbTrail:}</td>
</tr>
<tr>
  <td><notextile>\{breadcrumbTrail: {separator: " HELLO "}}</notextile></td>
  <td><notextile>{breadcrumbTrail: {separator: " HELLO "}}</notextile></td>
</tr>
<tr>
  <td><notextile>\{breadcrumbTrail: {omitLast: true}}</notextile></td>
  <td><notextile>{breadcrumbTrail: {omitLast: true}}</notextile></td>
</tr>
</table>

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
webgen-0.4.2 doc/src/documentation/plugins/tag/breadcrumbtrail.page
webgen-0.4.3 doc/src/documentation/plugins/tag/breadcrumbtrail.page
webgen-0.4.4 doc/src/documentation/plugins/tag/breadcrumbtrail.page
webgen-0.4.5 doc/src/documentation/plugins/tag/breadcrumbtrail.page
webgen-0.4.6 doc/src/documentation/plugins/tag/breadcrumbtrail.page
webgen-0.4.7 doc/src/documentation/plugins/tag/breadcrumbtrail.page