Changes between Version 5 and Version 6 of TracNavigation


Ignore:
Timestamp:
Dec 14, 2014, 5:16:20 PM (9 years ago)
Author:
trac
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • TracNavigation

    v5 v6  
    33Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.
    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.  The `mainnav` and `metanav` options in the `[trac]` configuration section can also be used to change the order.
     5The 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.
    66
    7 === `[mainnav]` #mainnav-bar
    8 `[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.
     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.
    98
     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.
    1010
    11 ** [=#Example Example] **
     11There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
    1212
    13 In 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.
     13Possible 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
     20Note 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
     24In the following example, we rename the link to the Wiki start "Home", and hide the "!Help/Guide" link.
     25We also make the "View Tickets" entry link to a specific report.
    1426
    1527Relevant excerpt from the TracIni:
    … …  
    1830wiki.label = Home
    1931tickets.href = /report/24
    20 }}}
    2132
    22 === `[metanav]` #metanav-bar
    23 `[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.
    24 
    25 There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
    26 [[comment(see also #Trac3808)]]
    27 
    28 ** Example **
    29 
    30 {{{
    3133[metanav]
    3234help = disabled
    … …  
    3436}}}
    3537
    36 
    37 === Notes
    38 Possible URL formats (for `.href` or `.redirect`):
    39 || '''config''' || '''redirect to''' ||
    40 || `wiki/Logout` || `/projects/env/wiki/Logout` ||
    41 || `http://hostname/` || `http://hostname/` ||
    42 || `/projects` || `/projects` ||
    43 
    44 
    45 === `[trac]` #nav-order
    46 The `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.
    47 
    48 ** Example **
    49 
    50 In the following example, we change the order to prioritise the ticket related items further left.
    51 
    52 Relevant excerpt from the TracIni:
    53 {{{
    54 [trac]
    55 mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
    56 }}}
    57 
    58 The default order and item names can be found in the source, which at the time of writing [source:trunk/trac/web/chrome.py@10883:397,402-403#L396 is here]
    59 
    60 === Context Navigation #ctxtnav-bar
    61 
    62 Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
    63 
    64 
    6538----
    6639See 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)