Changes between Initial Version and Version 1 of TracNavigation


Ignore:
Timestamp:
Apr 13, 2011, 7:02:28 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracNavigation

    v1 v1  
     1= Trac Navigation =
     2
     3Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.
     4
     5The 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.
     6
     7=== `[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.
     9
     10
     11** [=#Example Example] **
     12
     13In the following example, we rename the link to the Wiki start "Home", and hide the "!Help/Guide" link.
     14We also make the "View Tickets" entry link to a specific report.
     15
     16Relevant excerpt from the TracIni:
     17{{{
     18[mainnav]
     19wiki.label = Home
     20tickets.href = /report/24
     21}}}
     22
     23=== `[metanav]` #metanav-bar
     24`[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.
     25
     26There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.
     27[[comment(see also #Trac3808)]]
     28
     29** Example **
     30
     31{{{
     32[metanav]
     33help = disabled
     34logout.redirect = wiki/Logout
     35}}}
     36
     37
     38=== Notes
     39Possible URL formats (for `.href` or `.redirect`):
     40|| '''config''' || '''redirect to''' ||
     41|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
     42|| `http://hostname/` || `http://hostname/` ||
     43|| `/projects` || `/projects` ||
     44
     45
     46Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
     47
     48
     49----
     50See 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)