TextBook

From Textbook

Revision as of 19:49, 6 March 2010

<txp:breadcrumb />

The breadcrumb tag is a single tag which is used to create breadcrumb navigation. It provides either hyperlinked navigation, or plain text positional display, any time you are not on the Home page.

Attributes

Tag will accept the following attributes (case-sensitive):

label="value"

This string will be prepended to the output.

Default: Site name.

sep="value"

Character to be used as the breadcrumb separator. N.B.: This attribute will be renamed separator from the next release.

Default:  » .

title="boolean"

Whether to display the title or not.

Values: 1 (yes) or 0 (no, display name).

Default: 0.

link="value"

Whether to hyperlink breadcrumbs.

Values: 1 (yes) or 0 (no).

Default: 1.

linkclass="class name"

(X)HTML class attribute applied to the breadcrumb links.

Default: noline.

class="class name"

(X)HTML class attribute applied to the wraptag.

Default: unset.

wraptag="tag text"

(X)HTML tag (without brackets) to wrap around the output.

Default: p.

Examples

Example 1: Display a hyperlinked breadcrumb trail

<txp:breadcrumb label="Navigation" sep="::" link="y" wraptag="p" />

Provides hyperlinks to sections or categories in a breadcrumb style, linking back to your home page.

Example 2: Display a text only breadcrumb trail

<txp:breadcrumb label="Navigation" sep=":" link="n"  wraptag="p" />

Provides a breadcrumb guide that reflects where a user is within the site's navigation.