Changes between Version 2 and Version 3 of TracNavigation


Ignore:
Timestamp:
2019-05-02T09:45:05-03:00 (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNavigation

    v2 v3  
    11= Trac Navigation
    22
    3 The main and meta navigation entries can be customized in some basic ways. The `[mainnav]` and `[metanav]` configuration sections can be used to customize the navigation item text and link, change the ordering of the navigation items, or even 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.
    44
    55=== `[mainnav]` #mainnav-bar
     6
    67`[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 
    88
    99** [=#Example Example] **
    1010
    11 In the following example we rename the link to WikiStart //Home//, and 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.
     12
     13Relevant excerpt from the TracIni:
    1214{{{#!ini
    1315[mainnav]
    … …  
    1719
    1820=== `[metanav]` #metanav-bar
    19 `[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Login'', ''Logout'', ''!Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.
    2021
    21 There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.  The ''!Help/Guide'' link is also hidden in the following example.
     22`[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.
     23
     24There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
    2225[[comment(see also #Trac3808)]]
    2326
    … …  
    3033}}}
    3134
     35=== Notes
    3236
    33 === URL Formats
    3437Possible URL formats for `.href` or `.redirect`:
    3538|| '''config''' || '''redirect to''' ||
    … …  
    3841|| `/projects` || `/projects` ||
    3942
     43=== `[trac]` #nav-order
    4044
    41 === Ordering #nav-order
    42 The `order` attribute specifies the order in which the navigation items are displayed. This can be particularly useful for plugins that add navigation items.
     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.
    4346
    44 Non-negative floating point values may be used for the `order` attribute. The navigation items will be arranged from left to right in increasing order. Navigation items without an `order` attribute are sorted alphabetically by name.
     47** Example **
    4548
    46 The default values are:
     49In the following example, we change the order to prioritise the ticket related items further left.
     50
     51Relevant excerpt from the TracIni:
    4752{{{#!ini
    48 [mainnav]
    49 browser.order = 4
    50 newticket.order = 6
    51 roadmap.order = 3
    52 search.order = 7
    53 tickets.order = 5
    54 timeline.order = 2
    55 wiki.order = 1
     53[trac]
     54mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
     55}}}
    5656
    57 [metanav]
    58 about.order = 5
    59 help.order = 4
    60 login.order = 1
    61 logout.order = 2
    62 prefs.order = 3
    63 }}}
     57The default order and item names can be viewed in the [TracIni#trac-section trac section of TracIni].
    6458
    6559=== Context Navigation #ctxtnav-bar