Attributes

separator="text"
Sets the breadcrumb separator text. The default separator is ' » '.
link="y"
Enables hyperlinked breadcrumb values. Disabled by default.
order="element list"
Specifies the order in which elements appear in the generated title. This should be a comma-separated list containing any or all of the following element names:
  • category - The current category or category tree (Category1 on article pages).
  • category2 - The current Category2 or Category2 tree (only meaningful for article pages).
  • keywords - The current chh_keywords keyword query.
  • label - Text/link specified by the label attribute.
  • page - Page number.
  • search - The current search query.
  • section - The current section.
  • site - The site name as set in Admin > Preferences.
  • title - The title of the current article.
The default is order="site,label,section,search,category,title,page".
addcategory="when"
addlabel="when"
addsection="when"
addsite="when"
Specifies on which pages the label, site, section, and category elements will appear in the breadcrumb list. When should be one of always, article, list, or never.
  • always - On every page.
  • article - Only on individual article pages.
  • list - Only on article list pages.
  • never - This element will never be displayed.
The defaults are addlabel="always", addsite="never", addsection="always", addcategory="list".
label="text"
Sets user-defined text to be included in the generated title. Appears where specified by the order attribute.
labellink="url"
The URL for label when link="y".
usetitle="section,category"
Specifies which elements (section and/or category) should be displayed by full title instead of just name. Valid values are section, category, all, or none. The default is usetitle="none".
catpath="y"
Enables full category path expansion, so that entire category trees are listed. By default, only the current category is displayed.
class="foo"
Sets the CSS class for links (<a class="foo"... ).