source: wiki/pages/TracNavigation @ 40777

Last change on this file since 40777 was 40558, checked in by obi, 2 years ago

reset wiki

File size: 2.7 KB
Line 
1= Trac Navigation
2
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.
4
5=== `[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.
7
8
9** [=#Example Example] **
10
11In the following example we rename the link to WikiStart //Home//, and make the //View Tickets// entry link to a specific report.
12{{{#!ini
13[mainnav]
14wiki.label = Home
15tickets.href = /report/24
16}}}
17
18=== `[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.
20
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.
22[[comment(see also #Trac3808)]]
23
24** Example **
25
26{{{#!ini
27[metanav]
28help = disabled
29logout.redirect = wiki/Logout
30}}}
31
32
33=== URL Formats
34Possible URL formats for `.href` or `.redirect`:
35|| '''config''' || '''redirect to''' ||
36|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
37|| `http://hostname/` || `http://hostname/` ||
38|| `/projects` || `/projects` ||
39
40
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.
43
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.
45
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
56
57[metanav]
58about.order = 5
59help.order = 4
60login.order = 1
61logout.order = 2
62prefs.order = 3
63}}}
64
65=== Context Navigation #ctxtnav-bar
66
67Note that it is still not possible to customize the '''contextual navigation bar''', ie the one usually placed below the main navigation bar.
68
69----
70See 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)
Note: See TracBrowser for help on using the repository browser.