Changes between Version 1 and Version 2 of TracNavigation


Ignore:
Timestamp:
Jan 13, 2020, 11:20:40 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNavigation

    v1 v2  
    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 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
     6`[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.
    67
    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.
    88
    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:
     11In the following example we rename the link to WikiStart //Home//, and make the //View Tickets// entry link to a specific report.
    1412{{{#!ini
    1513[mainnav]
    … …  
    1917
    2018=== `[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.
    2120
    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 
    24 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.
    2522[[comment(see also #Trac3808)]]
    2623
    … …  
    3330}}}
    3431
    35 === Notes
    3632
     33=== URL Formats
    3734Possible URL formats for `.href` or `.redirect`:
    3835|| '''config''' || '''redirect to''' ||
    … …  
    4138|| `/projects` || `/projects` ||
    4239
    43 === `[trac]` #nav-order
    4440
    45 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.
    4643
    47 ** 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.
    4845
    49 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
    5056
    51 Relevant excerpt from the TracIni:
    52 {{{#!ini
    53 [trac]
    54 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
    5563}}}
    56 
    57 The default order and item names can be viewed in the [TracIni#trac-section trac section of TracIni].
    5864
    5965=== Context Navigation #ctxtnav-bar