Changes between Version 31 and Version 32 of NavAddPlugin


Ignore:
Timestamp:
Feb 2, 2016, 10:57:30 PM (8 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • NavAddPlugin

    v31 v32  
    1 [[PageOutline(2-4)]]
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    33= Add custom items to main and meta navigation bar
     
    99== Description
    1010
    11 Starting with release 0.11, Trac allows existing items in the main and meta navigation bar menu items to be [TracInterfaceCustomization#CustomNavigationEntries customized], however it does not allow custom items to be added.  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.
     11Starting with release 0.11, Trac allows existing items in the main and meta navigation bar menu items to be [TracInterfaceCustomization#CustomNavigationEntries customized], however it does not allow custom items to be added. 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.
    1212
    13 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".
     13The plugin was inspired by and derived from NavMoverPlugin. In contrast to NavMoverPlugin this plugin does not hide navigation bars, which was the main motivation for creating this "fork".
    1414
    1515See also: MenusPlugin, TracTabPlugin.
    1616
    17 '''Fork:''' I have made a small [https://github.com/trac-hacks/trac-navadd fork on GitHub] with some improvements/fixes. Feel free to [https://github.com/trac-hacks/trac-navadd/issues suggest new]. For example, It supports TracLinks syntax for `url`, so if a link works in the wiki page itself, it should also in the menu. Install with `pip install NavAdd`.
     17'''Fork:''' I have made a small [https://github.com/trac-hacks/trac-navadd fork on GitHub] with some improvements/fixes. Feel free to [https://github.com/trac-hacks/trac-navadd/issues suggest new]. For example, it supports TracLinks syntax for `url`, so if a link works in the wiki page itself, it should also in the menu. Install with `pip install NavAdd`.
    1818
    1919== Bugs/Feature Requests
     
    3535You can check out NavAddPlugin from [/svn/navaddplugin here] using Subversion, or [source:navaddplugin browse the source] with Trac.
    3636
     37== Installation
     38
     39General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
     40
    3741== Configuration
    3842
    39 Enable with:
     43Enable in your `trac.ini` file with:
    4044{{{#!ini
    4145[components]
     
    5357 `<item>.url = <url>`:: the URL the button should link to; please note that TracLinks syntax is not supported here yet
    5458 `<item>.perm = <permission>`:: an optional permission that a user needs to have in order to see the button.   If unspecified, then all users will see the button.
    55  `<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
    56 
    57 === Example
     59 `<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, other names probably work as well.
    5860
    5961This is the configuration I use on [http://madwifi-project.org madwifi-project.org] to add a link to the imprint in the meta navigation bar, and a link to our download section on sf.net in the main navigation bar:
     
    7880Buttons which are added with this plugin can be ordered in the usual way, ie by specifying the actual order in section `[trac]`, keywords `mainnav` and `metanav` in TracIni.
    7981
    80 === Example
    81 
    8282Let's assume that you add a button `Download` to your main navigation bar (same as in the configuration example above), and you want it to appear right after the `Wiki` button. The configuration then looks like:
    8383