Changes between Version 26 and Version 27 of NavAddPlugin


Ignore:
Timestamp:
Mar 11, 2015, 3:02:13 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • NavAddPlugin

    v26 v27  
    11[[PageOutline(2-4)]]
    22
    3 = Add custom items to main and meta navigation bar =
     3= Add custom items to main and meta navigation bar
    44
    55{{{#!div class="system-message"
    … …  
    77}}}
    88
    9 == Description ==
     9== Description
    1010
    1111Starting 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.
    … …  
    1717'''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
    19 == Configuration ==
     19== Bugs/Feature Requests
     20
     21Existing bugs and feature requests for NavAddPlugin are
     22[report:9?COMPONENT=NavAddPlugin here].
     23
     24If you have any issues, create a
     25[http://trac-hacks.org/newticket?component=NavAddPlugin&owner=otaku42 new ticket].
     26
     27[[TicketQuery(component=NavAddPlugin&group=type,format=progress)]]
     28
     29== Download
     30
     31Download the zipped source from [download:navaddplugin here].
     32
     33== Source
     34
     35You can check out NavAddPlugin from [http://trac-hacks.org/svn/navaddplugin here] using Subversion, or [source:navaddplugin browse the source] with Trac.
     36
     37== Configuration
    2038
    2139Enable with:
    … …  
    2442navadd.* = enabled
    2543}}}
    26 All configuration settings are to be kept in a section called `[navadd]` in TracIni. The basic syntax is:
     44
     45All configuration settings are to be kept in a section called `[navadd]` in `trac.ini`. The basic syntax is:
    2746
    2847 `add_items = <item>,<item>,...`:: comma-separated list of items that will be added; only items that are listed here will be processed.
    2948
    30 Note: all items need to be in lowercase. If you use any uppercase character it will not work.
     49'''Note''': All items need to be in lowercase. If you use any uppercase character it will not work.
    3150
    3251And then for each item:
    … …  
    3655 `<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
    3756
    38 === Example ===
     57=== Example
    3958
    40 This 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.
     59This 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:
    4160
    4261{{{#!ini
    … …  
    5574The formats for the `url` parameter are the same as for the `href` parameter described at TracNavigation#Notes.
    5675
    57 == Ordering of buttons ==
     76== Ordering of buttons
    5877
    59 It might be worth to note that buttons which are added with this plugin can be ordered in the usual way, i.e. by specifying the actual order in section `[trac]`, keywords `mainnav` and `metanav` in TracIni.
     78Buttons 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.
    6079
    61 === Example ===
     80=== Example
    6281
    6382Let'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:
    … …  
    6887}}}
    6988
    70 == Bugs/Feature Requests ==
    71 
    72 Existing bugs and feature requests for NavAddPlugin are
    73 [report:9?COMPONENT=NavAddPlugin here].
    74 
    75 If you have any issues, create a
    76 [http://trac-hacks.org/newticket?component=NavAddPlugin&owner=otaku42 new ticket].
    77 
    78 == Download ==
    79 
    80 Download the zipped source from [download:navaddplugin here].
    81 
    82 == Source ==
    83 
    84 You can check out NavAddPlugin from [http://trac-hacks.org/svn/navaddplugin here] using Subversion, or [source:navaddplugin browse the source] with Trac.
    85 
    86 == Recent Changes ==
     89== Recent Changes
    8790
    8891[[ChangeLog(navaddplugin, 3)]]
    8992
    90 == Author/Contributors ==
     93== Author/Contributors
    9194
    9295'''Author:''' [wiki:otaku42] [[BR]]
    93 '''Maintainer:''' rjollos [[BR]]
     96'''Maintainer:''' [[Maintainer]] [[BR]]
    9497'''Contributors:'''