SupportArea

BoltWire is a FREE content management system written in PHP.

Its innovative architecture combined with best-in-class forms processing makes it ideal for creating complex, interactive, web applications fast...


Documentation

Markups
Variables
Conditions
Functions
Forms
Commands
Cheatsheet

Documentation

Handbook > Functions > Breadcrumb

A useful function for creating a display of links to the various parts in your page name. If your page groups are well structured, this can significantly help with navigation. You will see a "breadcrumb" just under the title at the top of this page. Here's how you create it:

[(breadcrumb)]

The function looks for a page parameter (or position one), and if not found, defaults to the current page. The default search template consists of this single line:

<(breadcrumb {+p} name=link)>

It creates a breadcrumb for each page generated by the search algorithm, except the last page part is a link, rather than plain text as at the top of this page.

Optional Parameters

There are several optional parameters available to this parameter. These include:

Name
Set name=link, none, or text (the default) depending on how you want the last part of the page name to display.

Missing
You can control what happens when a page is linked to that does not exist by setting missing=link, none, or text (the default).

Separator
You can change the separator between each page name from '>' to anything else you want.

Offset
If you want to suppress the first page page, set offset=1. To suppress the first two page parts, set offset=2.

RTL
You can reverse the breadcrumb so it goes from right to left (helpful for some languages) by setting rtl=true. The separator switches from '>' to '<'.

Limit
Set this to some number if you want to limit the number of parent pages shown in your breadcrumb. Useful for long page names.

Final
Configure what is used to represent any suppressed parent pages. Uses the traditional ... by default. Set to false or '' to hide any suppressed pages completely.