Changes between Version 1 and Version 2 of TracNavigation


Ignore:
Timestamp:
Apr 24, 2017, 10:36:27 AM (5 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNavigation

    v1 v2  
    1 = Trac Navigation =
     1= 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
    66
    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.
     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 that are accessible for the current user.
     8
     9** [=#Example Example] **
     10
     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.
     12
     13Relevant excerpt from the TracIni:
     14{{{#!ini
     15[mainnav]
     16wiki.label = Home
     17tickets.href = /report/24
     18}}}
     19
     20=== `[metanav]` #metanav-bar
    821
    922`[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.
    1023
    1124There 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` ||
    1825[[comment(see also #Trac3808)]]
    1926
    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.
     27** Example **
    2128
    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.
    26 
    27 Relevant excerpt from the TracIni:
    28 {{{
    29 [mainnav]
    30 wiki.label = Home
    31 tickets.href = /report/24
    32 
     29{{{#!ini
    3330[metanav]
    3431help = disabled
     
    3633}}}
    3734
     35=== Notes
     36
     37Possible URL formats for `.href` or `.redirect`:
     38|| '''config''' || '''redirect to''' ||
     39|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
     40|| `http://hostname/` || `http://hostname/` ||
     41|| `/projects` || `/projects` ||
     42
     43=== `[trac]` #nav-order
     44
     45The `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.
     46
     47** Example **
     48
     49In the following example, we change the order to prioritise the ticket related items further left.
     50
     51Relevant excerpt from the TracIni:
     52{{{#!ini
     53[trac]
     54mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
     55}}}
     56
     57The default order and item names can be viewed in the [TracIni#trac-section trac section of TracIni].
     58
     59=== Context Navigation #ctxtnav-bar
     60
     61Note that it is still not possible to customize the '''contextual navigation bar''', ie the one usually placed below the main navigation bar.
     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)