Changes between Version 37 and Version 38 of MenusPlugin


Ignore:
Timestamp:
Jun 8, 2015, 1:32:37 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • MenusPlugin

    v37 v38  
    99 * Hierachical organization, for example using [http://users.tpg.com.au/j_birch/plugins/superfish/ Superfish].
    1010
     11See it in action: http://code.optaros.com/trac/oforge/
     12
    1113'''Note''': CSS modifications might be needed to fit your Trac theme.
    1214
    1315See also: NavAddPlugin, TracTabPlugin.
    1416
    15 == Demo
    16 
    17 See it in action: http://code.optaros.com/trac/oforge/
    18 
    1917== Bugs/Feature Requests
    2018
    2119Existing 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].
    2220
    23 If you have any issues, create a [/newticket?component=MenusPlugin&owner=cbalan new ticket].
     21If you have any issues, create a [/newticket?component=MenusPlugin new ticket].
    2422
    2523[[TicketQuery(component=MenusPlugin&group=type,format=progress)]]
    … …  
    3129== Installation
    3230
    33 To install this plugin, folow these steps:
     31To install this plugin, follow these steps:
    3432 1. Install the plugin following the steps in the [http://trac.edgewall.org/wiki/TracPlugins#InstallingaTracPlugin Trac Documentation].
    3533 1. Add '''tracmenus.* = enabled''' to the `[components]` section of `trac.ini` or enable via !WebAdmin.
    … …  
    3937== Configuration
    4038
    41 As 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.
    42 
    43 === Defining your menus in the `[mainnav]` and `[metanav]` sections
     39As 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 and so on) - or a term which ''must not exist'' for a brand new item to be introduced (as the "Team Tools" in the [#Example Examples] section). A special case is `top` to make a new item appearing on top level.
     40
     41=== Defining menus in the `[mainnav]` and `[metanav]` sections
    4442
    4543The available properties and their possible values are:
    … …  
    6058{{{
    6159#!ini
    62  # dummy example - add mainnav items to context menu.
    63  [ctxtnav]
    64  inherit= mainnav
     60# dummy example - add mainnav items to context menu.
     61[ctxtnav]
     62inherit= mainnav
    6563}}}
    6664
    67 === Defining the behaviour in the `[menu-custom]` section
    68 
    69 Here 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:
    70 
    71 Syntax is quite easy, it's just `<option> = <value>`. Available options are:
     65=== Defining behaviour in the `[menu-custom]` section
     66
     67Although the defaults are fine, you can customize the behavior of MenusPlugin. The syntax for the options is similar to a key-value pair: `<option> = <value>`. Available options are:
     68
    7269||'''Option'''||'''Description'''||'''Default'''||
    7370||managed_menus||Which menus should be maintained by the plugin.||mainnav,metanav||
    74 ||serve_ui_files||Whether the required UI files (i.e. `*.js` and `*.css` files) should be linked into the page. Boolean value.||1||
    75 
    76 The `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?
     71||serve_ui_files||Whether the required UI files, ie `*.js` and `*.css` files, should be linked into the page. Boolean value.||1||
     72
     73The `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.
    7774
    7875== Example
    7976
    8077[http://code.optaros.com/trac/oforge/ Demo] config:
    81 {{{
    82 #!ini
     78{{{#!ini
    8379[mainnav]
    8480tags = disabled