<--

   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

For now this plugin generates so called "location" breadcrumbs. Compare this to "path" breadcrumbs indicating the path a user has taken to arrive at a page which is a kind of page history without navigation circles. But this is not yet supported by the BreadCrumbsPlugin.

In a way location breadcrumbs have always been supported by TWiki using the META{"parent"} variable to display the list of partent topics. Since version 4.x TWiki also supports hierarchical subwebs but the breadcrumbs support of TWiki does not allow to display the parent webs as part of of the location breadcrumbs. Besides that this plugin adds more flexibility in deciding which parts of the breadcrumbs path should be rendered and how each individual breadcrumb is displayed

Syntax

Parameters:

• <web>.<topic>: the location to which breadcrumbs should be generated; defaults to the current topic
• header: format string prepended to the output result
• format: format string to render one item on the breadcrumbs path (defaults to '[[$webtopic][$name]]')
• footer: format string appended to the output result
• separator: format string to be put between items (defaults to one space char)
• include: regular expression items must match to be part of the path
• exclude: regular expression items must not match to be part of the path
• recurse: can be one or more of the following values (comma separated) to deside 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, include only the current topic
  • 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

Pseudo-variables:
Each of the above format strings (format, header, footer, separator) may contain special variables:

• $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 (twiki syntax)
• $target: the full web/topic of the breadcrumb (url syntax)
• $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 TWiki variables

Examples

default

%BREADCRUMBS%

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

• Download the ZIP file from the Plugin web (see below)
• Unzip BreadCrumbsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/BreadCrumbsPlugin.txt
  lib/TWiki/Plugins/BreadCrumbsPlugin.pm

• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

<-- provided for compatibility only 

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

-- TWiki:Main/MichaelDaum - 18 Dec 2006