Changes between Version 2 and Version 3 of TracNavigation


Ignore:
Timestamp:
Jun 6, 2017, 5:30:40 PM (23 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNavigation

    v2 v3  
    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.
    4 
    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.
     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.
    64
    75=== `[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 and accessible for the current user.
    96
     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.
    108
    119** [=#Example Example] **
    1210
    13 In the following example, we rename the link to the Wiki start "Home", and hide the "!Help/Guide" link.
    14 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.
    1512
    1613Relevant excerpt from the TracIni:
    17 {{{
     14{{{#!ini
    1815[mainnav]
    1916wiki.label = Home
     
    2219
    2320=== `[metanav]` #metanav-bar
     21
    2422`[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.
    2523
     
    2927** Example **
    3028
    31 {{{
     29{{{#!ini
    3230[metanav]
    3331help = disabled
     
    3533}}}
    3634
     35=== Notes
    3736
    38 === Notes
    39 Possible URL formats (for `.href` or `.redirect`):
     37Possible URL formats for `.href` or `.redirect`:
    4038|| '''config''' || '''redirect to''' ||
    4139|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
     
    4341|| `/projects` || `/projects` ||
    4442
     43=== `[trac]` #nav-order
    4544
    46 Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
     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.
    4746
     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.
    4862
    4963----