Changes between Version 2 and Version 3 of TracNavigation


Ignore:
Timestamp:
Apr 20, 2015 8:51:57 PM (4 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNavigation

    v2 v3  
    11= Trac Navigation =
    22
    3 Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.
     3The main and meta navigation entries can be customized in some basic ways. The `[mainnav]` and `[metanav]` configuration sections can be used to customize the text and link used for the navigation items, or even to disable them.  The `mainnav` and `metanav` options in the `[trac]` configuration section can be used to change the order.
    44
    5 The new `[mainnav]` and `[metanav]` configuration sections can now be used to customize the text and link used for the navigation items, or even to disable them.
     5=== `[mainnav]` #mainnav-bar
     6`[mainnav]` corresponds to the '''main navigation bar''', the one containing entries such as ''Wiki'', ''Timeline'', ''Roadmap'', ''Browse Source'' and so on. This navigation bar is meant to access the default page of the main modules enabled in Trac that are accessible for the current user.
    67
    7 `[mainnav]` corresponds to the '''main navigation bar''', the one containing entries such as ''Wiki'', ''Timeline'', ''Roadmap'', ''Browse Source'' and so on. This navigation bar is meant to access the default page of the main modules enabled in Trac and accessible for the current user.
    88
    9 `[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Log in'', ''Logout'', ''!Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.
     9** [=#Example Example] **
    1010
    11 There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
    12 
    13 Possible URL formats:
    14 || '''config''' || '''redirect to''' ||
    15 || `wiki/Logout` || `/projects/env/wiki/Logout` ||
    16 || `http://hostname/` || `http://hostname/` ||
    17 || `/projects` || `/projects` ||
    18 [[comment(see also #Trac3808)]]
    19 
    20 Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
    21 
    22 === Example ===
    23 
    24 In the following example, we rename the link to the Wiki start "Home", and hide the "!Help/Guide" link.
    25 We also make the "View Tickets" entry link to a specific report.
     11In the following example, we rename the link to the Wiki start "Home", and make the "View Tickets" entry link to a specific report.  The second example (below) also hides the "!Help/Guide" link.
    2612
    2713Relevant excerpt from the TracIni:
     
    3016wiki.label = Home
    3117tickets.href = /report/24
     18}}}
    3219
     20=== `[metanav]` #metanav-bar
     21`[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Log in'', ''Logout'', ''!Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.
     22
     23There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
     24[[comment(see also #Trac3808)]]
     25
     26** Example **
     27
     28{{{
    3329[metanav]
    3430help = disabled
     
    3632}}}
    3733
     34
     35=== Notes
     36Possible URL formats (for `.href` or `.redirect`):
     37|| '''config''' || '''redirect to''' ||
     38|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
     39|| `http://hostname/` || `http://hostname/` ||
     40|| `/projects` || `/projects` ||
     41
     42
     43=== `[trac]` #nav-order
     44The `mainnav` and `metanav` options in the `[trac]` configuration section control the order in which the navigation items are displayed (left to right).  This can be useful with plugins that add navigation items.
     45
     46** Example **
     47
     48In the following example, we change the order to prioritise the ticket related items further left.
     49
     50Relevant excerpt from the TracIni:
     51{{{
     52[trac]
     53mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
     54}}}
     55
     56The default order and item names can be viewed in the [TracIni#trac-section trac section of TracIni].
     57
     58=== Context Navigation #ctxtnav-bar
     59
     60Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
     61
     62
    3863----
    3964See also: TracInterfaceCustomization, and the [http://trac-hacks.org/wiki/NavAddPlugin TracHacks:NavAddPlugin] or [http://trac-hacks.org/wiki/MenusPlugin TracHacks:MenusPlugin] (still needed for adding entries)