Changes between Version 9 and Version 10 of ShowPathPlugin


Ignore:
Timestamp:
Feb 12, 2017, 8:20:41 PM (7 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • ShowPathPlugin

    v9 v10  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = !ShowPath Plugin
     3= Show hierarchy of current page
    44
    55== Description
     6
     7This plugin replaces the global "Start Page" link with a path of links for hierarchical pages, for example
     8
     9`http://mytrac.com/wiki/ParentPage/ChildPage/GrandchildPage`
     10
     11would create a !ShowPath of:
     12
     13`Start Page / ParentPage / ChildPage / GrandchildPage`
     14
     15where all are links except for the current, GrandchildPage.
    616
    717A 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.
    … …  
    1828}}}
    1929
    20 Documentation from the source:
    21 
    22 {{{
    23 0.11dev rewrite of original ShowPath functionality.  Replaces
    24 the global "Start Page" link with a path of links for
    25 hierarchical pages.
    26 e.g., http://mytrac.com/wiki/ParentPage/ChildPage/GrandchildPage
    27 ..would create a ShowPath of
    28 Start Page / ParentPage / ChildPage / GrandchildPage
    29 ..where all are links except for the current, GrandchildPage.
    30 
    31  * http://trac-hacks.org/wiki/ShowPathPlugin
    32 
    33 Just drop in your trac/<projectname>/plugins dir. If you are using
    34 an inherited plugins_dir in Trac, that will also work to place this
    35 file there.
    36 
    37 Supports one optional trac.ini setting, sep_character, which
    38 specifies the character to use in the path display:
    39     [showpath]
    40     sep_character = »
    41 The default is a forward slash (/); note that no matter what character
    42 is specified, it will always be rendered with a single space on
    43 either side.  If you specify a string of more than one character,
    44 only the first non-whitespace character will be used.
    45 
    46 2007 Morris - gt4329b@pobox.com
    47 rfmorris on irc://freenode/trac
    48 
    49 2008 Modification by Jason Winnebeck
    50 }}}
     30See also: BreadCrumbsNavPlugin
    5131
    5232== Bugs/Feature Requests
    … …  
    5838[/newticket?component=ShowPathPlugin new ticket].
    5939
    60 === TODO
     40[[TicketQuery(component=ShowPathPlugin&group=type,format=progress)]]
    6141
    6242I need help on how to figure out where/how to put the documentation such that the web admin console can see descriptions on it.
    63 
    64 [[TicketQuery(component=ShowPathPlugin&group=type,format=progress)]]
    6543
    6644== Download
    … …  
    7755
    7856General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     57
     58== Configuration
     59
     60This plugin supports one optional `trac.ini` setting, sep_character, which specifies the character to use in the path display:
     61{{{#!ini
     62[showpath]
     63sep_character = »
     64}}}
     65
     66The 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.
    7967
    8068== Example
    … …  
    9482[[ChangeLog(showpathplugin, 3)]]
    9583
    96 == Author/Contributors ==
     84== Author/Contributors
    9785
    9886'''Author:''' [wiki:JasonWinnebeck] [[BR]]