[[PageOutline(2-5,Contents,pullout)]]

= Recently visited pages as navigational bread crumbs

== Description

This plugin will display a list of recently visited pages just above the main navigational bar, as [wikipedia:Breadcrumb_(navigation) 'bread crumbs']:

[[Image(breadcrumbsnav.png, width=500, border=2)]]

The amount of breadcrumbs to display is configurable.

See also: ShowPathPlugin

== Bugs/Feature Requests

Existing bugs and feature requests for BreadCrumbsNavPlugin are 
[report:9?COMPONENT=BreadCrumbsNavPlugin here].

If you have any issues, create a 
[/newticket?component=BreadCrumbsNavPlugin new ticket].

[[TicketQuery(component=BreadCrumbsNavPlugin&group=type,format=progress)]]

== Download and Source

While the branch name suggests the corresponding Trac version, `0.11` should work equally well for Trac 0.11, 0.12 and Trac 1.0 (current stable).

|| '''Stable Version''' ||`easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/0.11` ||[export:breadcrumbsnavplugin/0.11 download] ||[/svn/breadcrumbsnavplugin/0.11 subversion] ||
|| Under Development || `easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/trunk` ||[export:breadcrumbsnavplugin/trunk download] ||[/svn/breadcrumbsnavplugin/trunk subversion] ||

For Subversion checkout use {{{svn co <url>}}} with URL depending on your Trac version and target release (see links above).

Alternatives:
 * Download the zipped source of all branches from [export:breadcrumbsnavplugin here].
 * You can [source:breadcrumbsnavplugin browse the source] with Trac.

== Installation

This plugin requires Trac >= 0.11 and Genshi >= 0.5 .

The easiest way to install this plugin is to point easy_install at the t-h.o SVN repository:
{{{#!sh
easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/0.11
}}}

Alternatively, you may download the source, go into the directory containing `setup.py` and run:
{{{#!sh
python setup.py install
}}}

or prepare a packaged version and move that into the `plugin` directory inside your Trac environment:
{{{#!sh
python setup.py bdist_egg
cp ./dist/BreadCrumbsNav-<version> <path-to-trac-env>/plugins/
}}}

If you are using `tracd` standalone server or another webserver, you will probably need to restart it to detect the plugin.

Depending on your configuration you may still need to enable the plugin explicitly. You can do so in the Administration panel of Trac, or in the `trac.ini` file by adding:
{{{#!ini
[components]
breadcrumbsnav.* = enabled
}}}

== Configuration

There are 4 options that can be set in your `trac.ini` file for this plugin:

{{{#!ini
[breadcrumbs]
ignore_pattern =
label =
max_crumbs = 6
paths = /wiki/,/ticket/,/milestone/
}}}

Explanation:
 ignore_pattern::
 A regular expression pattern that can be applied to the name of the resource; if it matches the resource, it will not be added to the user's breadcrumbs. Defaults to nothing.
 label::
 A custom label to replace the implicit "Breadcrumbs:" default value. Beware that this will interfere with i18n, maybe even deprecated by it.
 max_crumbs::
 The maximum number of crumbs that should be kept per-user. Defaults to 6.
 paths::
 A comma-separated list of regular expressions, one of which should match the beginning of the url to include the resource in the path. Defaults to the path `/wiki*,/ticket*,/milestone*`.
 Note that these paths are interpreted as regular expressions, even though the default values look like shell globs. It seems these default values also match `/wiki/foo` or `/ticketbar`, which might not be the author's intent.

== Recent Changes

[[ChangeLog(breadcrumbsnavplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:ixokai] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''