Changes between Version 2 and Version 3 of TracNavigation

Timestamp:

Jul 17, 2018, 2:10:44 PM (6 years ago)

Author:

trac

Comment:

--

TracNavigation

@@ -1 @@
-= Trac Navigation =
+= Trac Navigation
 
-Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.
-
-The 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.  The `mainnav` and `metanav` options in the `[trac]` configuration section can also be used to change the order.
+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.
 
 === `[mainnav]` #mainnav-bar
@@ -11 +9 @@
 ** [=#Example Example] ** 
 
-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.
-
-Relevant excerpt from the TracIni:
-{{{
+In the following example we rename the link to WikiStart //Home//, and make the //View Tickets// entry link to a specific report.
+{{{#!ini
 [mainnav]
 wiki.label = Home
@@ -21 +17 @@
 
 === `[metanav]` #metanav-bar
-`[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.
+`[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.
 
-There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button. 
+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.
 [[comment(see also #Trac3808)]]
 
 ** Example ** 
 
-{{{
+{{{#!ini
 [metanav]
 help = disabled
@@ -35 +31 @@
 
 
-=== Notes
-Possible URL formats (for `.href` or `.redirect`):
+=== URL Formats
+Possible URL formats for `.href` or `.redirect`:
 || '''config''' || '''redirect to''' ||
 || `wiki/Logout` || `/projects/env/wiki/Logout` ||
@@ -43 +39 @@
 
 
-=== `[trac]` #nav-order
-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.
+=== Ordering #nav-order
+The `order` attribute specifies the order in which the navigation items are displayed. This can be particularly useful for plugins that add navigation items.
 
-** Example ** 
+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.
 
-In the following example, we change the order to prioritise the ticket related items further left.
+The default values are:
+{{{#!ini
+[mainnav]
+browser.order = 4
+newticket.order = 6
+roadmap.order = 3
+search.order = 7
+tickets.order = 5
+timeline.order = 2
+wiki.order = 1
 
-Relevant excerpt from the TracIni:
-{{{
-[trac]
-mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
+[metanav]
+about.order = 5
+help.order = 4
+login.order = 1
+logout.order = 2
+prefs.order = 3
 }}}
-
-The default order and item names can be found in the source, which at the time of writing [source:trunk/trac/web/chrome.py@10883:397,402-403#L396 is here]
 
 === Context Navigation #ctxtnav-bar
 
-Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
-
+Note that it is still not possible to customize the '''contextual navigation bar''', ie the one usually placed below the main navigation bar.
 
 ----