Changes between Version 5 and Version 6 of EggCookingTutorial/AdvancedEggCooking2

Timestamp:

Sep 5, 2005, 2:37:44 AM (19 years ago)

Author:

Shun-ichi Goto

Comment:

updated to adapt to new ITemplateProvider and added the whole of final code.

EggCookingTutorial/AdvancedEggCooking2

@@ -57 +57 @@
 Trac doesn't know where our fine stylesheet and image is located. So you have to tell it to Trac.
 
-Add static data path to end of our plugin in file ''helloworld.py'':
+Add the following code at the tail in file ''helloworld.py'' which
+implements {{{get_htdocs_dir()}}} to tell the static data path information for this plugin 
+with identical prefix 'helloworld'.
 {{{
 #!python
-    def get_htdocs_dir(self):
+    def get_htdocs_dirs(self):
         """
-        Return the absolute path of a directory containing additional
-        static resources (such as images, style sheets, etc).
+        Return a list of directories with static resources (such as style
+        sheets, images, etc.)
+
+        Each item in the list must be a `(prefix, abspath)` tuple. The
+        `prefix` part defines the path in the URL that requests to these
+        resources are prefixed with.
+        
+        The `abspath` is the absolute path to the directory containing the
+        resources on the local file system.
         """
         from pkg_resources import resource_filename
-        return resource_filename(__name__, 'htdocs')    
+        return [('helloworld', resource_filename(__name__, 'htdocs'))]
 }}}
 
@@ -75 +84 @@
 #!python
     def process_request(self, req):
+        add_stylesheet(req, 'helloworld/css/helloworld.css')
+        return 'helloworld.cs', None
+}}}
+Note that prefix path 'helloworld/' specified by {{{get_htdocs_dirs()}}} should be used.
+
+And also import {{{add_stylesheet()}}} at the beginning of ''helloworld.py''.
+{{{
+#!python
+from trac.web.chrome import INavigationContributor, ITemplateProvider, add_stylesheet
+}}}
+
+== Complete version of code ==
+The whole of final code is here:
+{{{
+#!python
+# Helloworld plugin
+
+from trac.core import *
+from trac.web.chrome import INavigationContributor, ITemplateProvider, add_stylesheet
+from trac.web.main import IRequestHandler
+from trac.util import escape
+
+class UserbaseModule(Component):
+    implements(INavigationContributor, IRequestHandler, ITemplateProvider)
+        
+    # INavigationContributor methods
+    def get_active_navigation_item(self, req):
+        return 'helloworld'
+                
+    def get_navigation_items(self, req):
+        yield 'mainnav', 'helloworld', '<a href="%s">Hello</a>' \
+                                       % escape(self.env.href.helloworld())
+        
+    # IRequestHandler methods
+    def match_request(self, req):
+        return req.path_info == '/helloworld'
+                                        
+    def process_request(self, req):
         add_stylesheet(req, 'css/helloworld.css')
         return 'helloworld.cs', None
+                
+    # ITemplateProvider methods
+    def get_templates_dirs(self):
+        """
+        Return the absolute path of the directory containing the provided
+        ClearSilver templates.
+        """
+        from pkg_resources import resource_filename
+        return [resource_filename(__name__, 'templates')]
+    
+    def get_htdocs_dirs(self):
+        """
+        Return a list of directories with static resources (such as style
+        sheets, images, etc.)
+
+        Each item in the list must be a `(prefix, abspath)` tuple. The
+        `prefix` part defines the path in the URL that requests to these
+        resources are prefixed with.
+        
+        The `abspath` is the absolute path to the directory containing the
+        resources on the local file system.
+        """
+        from pkg_resources import resource_filename
+        return [('helloworld', resource_filename(__name__, 'htdocs'))]
 }}}