Changes between Version 1 and Version 2 of NavAddPlugin


Ignore:
Timestamp:
Jul 14, 2006 7:40:13 AM (8 years ago)
Author:
otaku42
Comment:

Improved documentation.

Legend:

Unmodified
Added
Removed
Modified
  • NavAddPlugin

    v1 v2  
    33== Description == 
    44 
    5 This plugin allows you to add custom items ("buttons") to both the main and the meta navigation bar. 
     5This plugin allows you to add custom items ("buttons") to both the main and the meta navigation bar. Item name, title and URL can be specified in trac.ini, as well as an optional permission the user is required to have to see the item. 
    66 
    7 ''to be continued'' 
     7The plugin was inspired by and derived from NavMoverPlugin. In contrast to NavMoverPlugin this plugin does not hide navigation bars, which was my main motivation for creating this "fork". 
    88 
     9== Configuration == 
     10 
     11All configuration settings are to be kept in a section called `[navadd]` in TracIni. The basic syntax is: 
     12 
     13 `add_items = <item>,<item>,...`:: comma-separated list of items that will be added; only items that are listed here will be processed. 
     14 
     15And then for each item: 
     16 `<item>.title = <title>`:: the name (title) of the button 
     17 `<item>.url = <url>`:: the URL the button should link to; please note that TracLinks syntax is not supported here yet 
     18 `<item>.perm = <permission>`:: an optional permission that a user needs to have in order to see the button 
     19 `<item>.target = <navbar_name>':: the name of the navigation bar the button should be added to; only `mainnav` and `metanav` have been tested so far, others names probably work as well 
    920 
    1021== Bugs/Feature Requests ==