Changes between Version 1 and Version 2 of NavAddPlugin

Timestamp:

Jul 14, 2006, 5:40:13 AM (18 years ago)

Author:

Michael Renzmann

Comment:

Improved documentation.

NavAddPlugin

@@ -3 +3 @@
 == Description ==
 
-This plugin allows you to add custom items ("buttons") to both the main and the meta navigation bar.
+This 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.
 
-''to be continued''
+The 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".
 
+== Configuration ==
+
+All configuration settings are to be kept in a section called `[navadd]` in TracIni. The basic syntax is:
+
+ `add_items = <item>,<item>,...`:: comma-separated list of items that will be added; only items that are listed here will be processed.
+
+And then for each item:
+ `<item>.title = <title>`:: the name (title) of the button
+ `<item>.url = <url>`:: the URL the button should link to; please note that TracLinks syntax is not supported here yet
+ `<item>.perm = <permission>`:: an optional permission that a user needs to have in order to see the button
+ `<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
 
 == Bugs/Feature Requests ==