Changes between Version 2 and Version 3 of TracDev/PluginDevelopment/ExtensionPoints/trac.web.chrome.INavigationContributor

Timestamp:

Aug 21, 2011, 10:18:23 PM (13 years ago)

Author:

Peter Suter

Comment:

Replace minimal example with more meaningful ComponentModuleExamples

TracDev/PluginDevelopment/ExtensionPoints/trac.web.chrome.INavigationContributor

@@ -31 +31 @@
 == Examples ==
 
-The following example adds an item to the main navigation bar, named 'sample'. It is rendered as a hyperlink ''Sample'' referencing a resource ''./sample/''. (Assume some other component implements a request handler for this resource and requests the permission 'SAMPLE_VIEW'.)
+A INavigationContributor in isolation is not very useful and usually accompanied by implementations of other interfaces. Hence the following example is best understood in context of the ComponentModuleExamples. 
 
+In Trac, there is no navigation bar item for [TicketComponent components]. The following example implementation adds such an item to the main navigation bar:
 {{{#!python
 from trac.core import implements, Component
 from trac.web.chrome import INavigationContributor
 
-class SampleNavigationContributor(Component):
+class ComponentModule(Component):
 
     implements(INavigationContributor)
@@ -44 +45 @@
 
     def get_active_navigation_item(self, req):
-        return 'sample'
+        return 'component'
 
     def get_navigation_items(self, req):
-        if 'SAMPLE_VIEW' in req.perm:
-            yield ('mainnav', 'sample', 
-                   tag.a(_("Sample"), href=req.href.sample()))
+        if 'COMPONENT_LIST' in req.perm:
+            yield ('mainnav', 'component', 
+                   tag.a(_("Components"), href=req.href.component()))
 }}}
+''(Missing here are at least implementations of [../trac.web.api.IRequestHandler IRequestHandler] for the linked URL `./component` that activates this item and [../trac.perm.IPermissionRequestor IPermissionRequestor] for the required permission `COMPONENT_LIST`.)''
 
 == Available Implementations ==