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

= Recently visited pages as navigational bread crumbs

== Description

This plugin will inject a list of recently visited pages just above the main navigational bar, as [http://en.wikipedia.org/wiki/Breadcrumb_(navigation) 'bread crumbs'] that you can follow home.

== 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)]]

== Release Status, Downloads and Source

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

|| '''Stable Version''' ||easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/0.11 ||[export:breadcrumbsnavplugin/0.11 download] ||[http://trac-hacks.org/svn/breadcrumbsnavplugin/0.11 subversion] ||
|| Under Development ||easy_install https://trac-hacks.org/svn/breadcrumbsnavplugin/trunk ||[export:breadcrumbsnavplugin/trunk download] ||[http://trac-hacks.org/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 http://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 most 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
}}}

In Trac applications, where you disabled `breadcrumbs-0.1` or required explicit activation, a different line starting with `breadcrumbsnavplugin.` is already present that is now obsolete and can be safely deleted.

== Configuration

There are four options you may set in `trac.ini`:

 ignore_pattern::
 A regular expression pattern that can be applied to the name of the resource; if it matches the resource will not be added to the user's breadcrumbs. Defaults to nothing.
 label::
 A custom label to replace the implicite "Breadcrumbs:" default value. Beware that this will interfere with i18n, maybe even depreciated by it.
 max_crumbs::
 The maximum total 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 /wiki*,/ticket*,/milestone*
 Note that these really are interpreted as regular expressions, even though the default values look more like shell globs. It seems these default values also match /wik/foo or /tickebar, which might not be the authors intention.

The config entry would look something like the following:

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

== Recent Changes

[[ChangeLog(breadcrumbsnavplugin, 3)]]

== Author/Contributors

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