= !ShowPath Plugin =

== Description ==

A Trac 0.11 version of the TracShowPathPatch as a single-file plugin, since in Trac 0.11 this can be done without source code modification, thanks to the ITemplateStreamFilter interface in Trac. This is a modification of Morris's work at t:wiki:MacroBazaar#ShowPath. His code works, but only if the trac instance is at the root of the web server (like trac-hacks.org). My modifications use the Trac environment href API to form the proper URLs.

=== Requirements ===

Trac 0.11 and Genshi 0.5. Current version released is 0.4, so Genshi trunk will be needed. I tested with r851 of Genshi trunk. Genshi 0.5 is needed for the Transformer API to replace the "Start Page" link on the context navigation bar.

=== Documentation ===

From the source:

{{{
0.11dev rewrite of original ShowPath functionality.  Replaces
the global "Start Page" link with a path of links for
hierarchical pages.
e.g., http://mytrac.com/wiki/ParentPage/ChildPage/GrandchildPage
..would create a ShowPath of
Start Page / ParentPage / ChildPage / GrandchildPage
..where all are links except for the current, GrandchildPage.

 * http://trac-hacks.org/wiki/ShowPathPlugin

Just drop in your trac/<projectname>/plugins dir. If you are using
an inherited plugins_dir in Trac, that will also work to place this
file there.

Supports one optional trac.ini setting, sep_character, which
specifies the character to use in the path display:
    [showpath]
    sep_character = »
The default is a forward slash (/); note that no matter what character
is specified, it will always be rendered with a single space on
either side.  If you specify a string of more than one character,
only the first non-whitespace character will be used.

2007 Morris - gt4329b@pobox.com
rfmorris on irc://freenode/trac

2008 Modification by Jason Winnebeck
}}}

== Bugs/Feature Requests == 

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

If you have any issues, create a 
[http://trac-hacks.org/newticket?component=ShowPathPlugin&owner=JasonWinnebeck new ticket].

=== Future Work ===

 * Minor issue: I need help on how to figure out where/how to put the documentation such that the web admin console can see descriptions on it.

== Download ==

Download the zipped source from [download:showpathplugin here].

== Source ==

You can check out ShowPathPlugin from [http://trac-hacks.org/svn/showpathplugin here] using Subversion, or [source:showpathplugin browse the source] with Trac.

== Example ==

Replaces the "Start Page" link in the Trac bar. If you are on this page, you would see[[BR]][wiki:WikiStart Start Page] / ShowPathPlugin[[BR]]instead. If you were in a a subpage like "!ShowPathPlugin/SubPage" you would see[[BR]][wiki:WikiStart Start Page] / [wiki:ShowPathPlugin ShowPathPlugin] / !SubPage.

== Recent Changes ==

[[ChangeLog(showpathplugin, 3)]]

== Author/Contributors ==

'''Author:''' [wiki:JasonWinnebeck] [[BR]]
'''Contributors:'''