Changes between Version 36 and Version 37 of MenusPlugin


Ignore:
Timestamp:
Mar 11, 2015, 12:03:51 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • MenusPlugin

    v36 v37  
    1 = Hierarchical navigation menus =
    21[[PageOutline(2-5,Contents,pullout)]]
    32
    4 == Description ==
    5 With release 0.11, Trac allows existing items to be [http://trac.edgewall.org/wiki/TracNavigation customized] on the main and meta navigation bars.  This plugin extends that functionality to:
    6  * Add items to navigation menus
    7  * Hierachical organization (using [http://users.tpg.com.au/j_birch/plugins/superfish/ Superfish])
    8 
    9 Note: CSS modifications might be needed to fit your Trac theme.
     3= Hierarchical navigation menus
     4
     5== Description
     6
     7With release of Trac 0.11, existing items can be [http://trac.edgewall.org/wiki/TracNavigation customized] on the main and meta navigation bars. This plugin extends that functionality to:
     8 * Add items to navigation menus.
     9 * Hierachical organization, for example using [http://users.tpg.com.au/j_birch/plugins/superfish/ Superfish].
     10
     11'''Note''': CSS modifications might be needed to fit your Trac theme.
    1012
    1113See also: NavAddPlugin, TracTabPlugin.
    1214
    13 == Demo ==
     15== Demo
     16
    1417See it in action: http://code.optaros.com/trac/oforge/
    1518
    16 == Bugs/Feature Requests ==
     19== Bugs/Feature Requests
    1720
    1821Existing open bugs and feature requests for MenusPlugin are [query:status!=closed&component=MenusPlugin&order=priority here].  All bugs and feature requests (open and closed) for MenusPlugin are [query:component=MenusPlugin&order=priority here].
    … …  
    2023If you have any issues, create a [/newticket?component=MenusPlugin&owner=cbalan new ticket].
    2124
    22 == Download, Source ==
     25[[TicketQuery(component=MenusPlugin&group=type,format=progress)]]
     26
     27== Download, Source
    2328
    2429Download the [download:menusplugin zipped source], check out MenusPlugin [/svn/menusplugin from here using Subversion], or [source:menusplugin browse the source] with Trac.
    2530
    26 == Installation ==
    27 
     31== Installation
     32
     33To install this plugin, folow these steps:
    2834 1. Install the plugin following the steps in the [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin Trac Documentation].
    29  1. Add '''tracmenus.* = enabled''' to the `[components]` section of ''trac.ini'' or enable via !WebAdmin.
     35 1. Add '''tracmenus.* = enabled''' to the `[components]` section of `trac.ini` or enable via !WebAdmin.
    3036 1. Restart the Trac server.
    3137 1. Proceed to the [#Configuration Configuration] section.
    3238
    33 == Configuration ==
     39== Configuration
     40
    3441As usual, configuration takes place in the `trac.ini` file. Most interesting things first - they are to be found in the `[mainnav]` section: Here you set up your menu items. Syntax is: `<item_name>.<property> = <value>` - where `<item_name>` is either the already existing handler (e.g. "wiki" for the wiki item, "tickets" for the tickets, "newticket" for the "New Ticket" item, a.s.o.) - or a term which ''must not exist'' for a brand new item to be introduced (as e.g. the "Team Tools" in the [#Example Examples] section). A special case is e.g. `top` to make a new item appearing on top level.
    3542
    36 === Defining your menus in the `[mainnav]` and `[metanav]` sections ===
    37 So here come the available properties and their possible values:
     43=== Defining your menus in the `[mainnav]` and `[metanav]` sections
     44
     45The available properties and their possible values are:
     46
    3847||'''Property'''||'''Description'''||'''Example value'''||
    3948||enabled||Must be set to `1` for self defined items to be shown. Can be set to `0` to (temporarily) disable an item.||1||
    … …  
    4655||perm||For items like reports, `hide_if_disabled` does not work, since this is no component. Though, it should not be displayed if it is not available. So you can handle this by defining the required permission.||REPORT_VIEW||
    4756
    48 === Menu options ===
     57=== Menu options
     58
    4959 - '''inherit''': Useful when a menu should receive items from another menu
    5060{{{
    … …  
    5565}}}
    5666
    57 === Defining the behaviour in the `[menu-custom]` section ===
     67=== Defining the behaviour in the `[menu-custom]` section
     68
    5869Here you can (re-)define (i.e. customize) the behavior of MenusPlugin. Usually, you won't need that - since the defaults are fine. But in case you need a toy to play with - here we go:
    5970
    … …  
    6576The `serve_ui_files` option you will only need to override if you want to apply your own styles and need to suppress the original ones for this. Rare case - but who knows?
    6677
    67 == Example ==
     78== Example
    6879
    6980[http://code.optaros.com/trac/oforge/ Demo] config:
    … …  
    185196}}}
    186197
    187 == Screenshots ==
     198== Screenshots
     199
     200The menu item '''Tickets''' on the Navigation bar has been extended with drop-down functionality:
     201
    188202[[Image(menusplugin.png, width=500)]]
    189203
    190 == Recent Changes ==
     204== Recent Changes
    191205
    192206[[ChangeLog(menusplugin, 3)]]
    193207
    194 == Author/Contributors ==
     208== Author/Contributors
    195209
    196210'''Author:''' [wiki:cbalan] [[BR]]
    197 '''Maintainer:''' [wiki:cbalan] [[BR]]
     211'''Maintainer:''' [[Maintainer]] [[BR]]
    198212'''Contributors:''' [wiki:izzy], [wiki:rjollos]