wiki:BreadCrumbsNavPlugin

Recently visited pages as navigational bread crumbs

Notice: This plugin is unmaintained and available for adoption.

Description

This plugin will display a list of recently visited pages just above the main navigational bar, as bread crumbs:

Breadcrumbsnav example

The amount of breadcrumbs to display is configurable.

See also: ShowPathPlugin

Bugs/Feature Requests

Existing bugs and feature requests for BreadCrumbsNavPlugin are here.

If you have any issues, create a new ticket.

defect

13 / 13

enhancement

4 / 6

task

2 / 2

Download

Download the zipped source from here.

Source

You can check out BreadCrumbsNavPlugin from here using Subversion, or browse the source with Trac.

Installation

The easiest way to install this plugin is:

$ pip install svn+https://trac-hacks.org/svn/breadcrumbsnavplugin/trunk

Alternatively, you may download the source, go into the directory containing setup.py and run:

$ python setup.py install

or prepare a packaged version and move that into the plugin directory inside your Trac environment:

$ 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 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:

[components]
breadcrumbsnav.* = enabled

Configuration

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

[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

18167 by Cinc-th on 2021-04-08 14:23:16
BreadCrumbsNavPlugin: added classifiers to setup.py.
18166 by Cinc-th on 2021-04-08 14:15:56
BreadCrumbsNavPlugin: fixed pickling for Python 3. Save breadcrumbs as base64 encoded ascii string in session to prevent string/bytes problems.
18165 by Cinc-th on 2021-04-08 12:51:06
BreadCrumbsNavPlugin: no longer use ITemplateStreamFilter and Geshi Transformer. Added COPYING file. Bumped version to 0.5.0.
(more)

Author/Contributors

Author: ixokai
Maintainer: none (needsadoption)
Contributors:

Last modified 13 months ago Last modified on Oct 9, 2020, 6:48:17 PM

Attachments (1)

Download all attachments as: .zip