<--

   PLEASE DO NOT EDIT THIS TOPIC

   It is automatically generated from the subversion repository, and any changes
   you make will simply be overwritten the next time a release is generated.

   Instead, you could check your fix in, raise a bug in the Bugs web, or mail the author.
-->

BreadCrumbsPlugin

Description

Configuration

Enabling Path breadcrumbs

Displaying TopicTitles

Syntax

• <web>.<topic>: the location to which breadcrumbs should be generated (type="location" only, ignored if type="path") defaults to the current topic
• type: "location" (the default) or "path"
• header: format string prepended to the output result
• format: format string to render one item on the breadcrumbs path (defaults to '[[$webtopic][$name]]')
• topicformat: format string for any topic items on the path; for example, parent topics. Defaults to the same as format.
• footer: format string appended to the output result
• separator: format string to be put between items (defaults to one space char)
• include: regular expression that items must match to be part of the path
• exclude: regular expression that items must not match to be part of the path
• recurse: (type="location" only) can be one or more of the following values (comma separated) to decide which parts of the breadcrumbs path should be included (defaults to 'on'):
  • on: include all parent webs and all parent topics
  • off: include only the current web and the current topic
  • weboff: don't recurse on webs, include only the current web
  • topicoff: don't recurse on topics
  • webonce: include the next parent web but not the parent web's parent web
  • topiconce: include the next parent topic but not the parent topic's parent topic
  • once: short formf of webonce, topiconce
• spaceout: space out WikiWords inserting a separator (defaults to 'off')
• spaceoutsep: separator to be used when spacing out WikiWords
• maxlength: maximum length of a breadcrumbs before inserting an ellipsis in the middle, 0 meaning disable this feature (defaults to 0)
• ellipsis: character sequence to be inserted when reducing the maxlength of the breadcrumbs (defaults to ' ... ')

• $name: the name of the breadcrumb, this is the topic name or the web name having its parent web part being stripped off (that is Bar instead of Sandbox/Foo/Bar)
• $webtopic: the full web.topic of the breadcrumb (wiki syntax)
• $web: the web part of the current breadcrumb
• $topic: the topic part of the current breadcrumb
• $target: the full web/topic of the breadcrumb (url syntax)
• $name: name of the breadcrumbs item this is the TopicTitle, spaced out or normal topic name topic
• $n: replaced with a newline char (\n)
• $percnt: replaced with a percent char (%)
• $dollar: replaced with a dollar char ($)
• $nop: removed from the format string before expanding common variables

Examples

default

%BREADCRUMBS%

path

%BREADCRUMBS{type="path"}%

breadcrumbs to a non-existent location

%BREADCRUMBS{
  "Web1/Web2/Web3.Topic"
  format="$name"
  separator=" » "}%

recurse="off"

%BREADCRUMBS{
  "Web1/Web2/Web3.Topic"
  format="$name"
  separator=" » "
  recurse="off"}%

recurse="once"

%BREADCRUMBS{"Web1/Web2/Web3.Topic"
  format="$name"
  separator=" » "
  recurse="once"}%

include

%BREADCRUMBS{"Web1/Web2/Web3.Topic"
  format="$name"
  separator=" » "
  include="Web(1|3).*"}%

exclude

%BREADCRUMBS{"Web1/Web2/Web3.Topic"
  format="$name"
  separator=" » "
  exclude="Web2"}%

Plugin Installation Instructions

Plugin Info

<-- provided for compatibility only 

 Set SHORTDESCRIPTION = A flexible way to display breadcrumbs navigation
 
-->