Changes between Version 2 and Version 3 of TracNavigation


Ignore:
Timestamp:
02/01/17 00:38:40 (8 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNavigation

    v2 v3  
    1 = Trac Navigation =
     1= 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 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.
     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 navigation item text and link, change the ordering of the navigation items, or even disable them.
    44
    55=== `[mainnav]` #mainnav-bar
    … …  
    99** [=#Example Example] **
    1010
    11 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.
    12 
    13 Relevant excerpt from the TracIni:
    14 {{{
     11In the following example we rename the link to WikiStart //Home//, and make the //View Tickets// entry link to a specific report.
     12{{{#!ini
    1513[mainnav]
    1614wiki.label = Home
    … …  
    1917
    2018=== `[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.
     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.
    2220
    23 There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
     21There 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.
    2422[[comment(see also #Trac3808)]]
    2523
    2624** Example **
    2725
    28 {{{
     26{{{#!ini
    2927[metanav]
    3028help = disabled
    … …  
    3331
    3432
    35 === Notes
    36 Possible URL formats (for `.href` or `.redirect`):
     33=== URL Formats
     34Possible URL formats for `.href` or `.redirect`:
    3735|| '''config''' || '''redirect to''' ||
    3836|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
    … …  
    4139
    4240
    43 === `[trac]` #nav-order
    44 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.
     41=== Ordering #nav-order
     42The `order` attribute specifies the order in which the navigation items are displayed. This can be particularly useful for plugins that add navigation items.
    4543
    46 ** Example **
     44Non-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.
    4745
    48 In the following example, we change the order to prioritise the ticket related items further left.
     46The default values are:
     47{{{#!ini
     48[mainnav]
     49browser.order = 4
     50newticket.order = 6
     51roadmap.order = 3
     52search.order = 7
     53tickets.order = 5
     54timeline.order = 2
     55wiki.order = 1
    4956
    50 Relevant excerpt from the TracIni:
    51 {{{
    52 [trac]
    53 mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
     57[metanav]
     58about.order = 5
     59help.order = 4
     60login.order = 1
     61logout.order = 2
     62prefs.order = 3
    5463}}}
    55 
    56 The default order and item names can be viewed in the [TracIni#trac-section trac section of TracIni].
    5764
    5865=== Context Navigation #ctxtnav-bar
    5966
    60 Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
    61 
     67Note that it is still not possible to customize the '''contextual navigation bar''', ie the one usually placed below the main navigation bar.
    6268
    6369----