Changes between Version 7 and Version 8 of RequestHandlers

Timestamp:

Jul 9, 2008, 10:06:25 AM (16 years ago)

Author:

cmlenz

Comment:

Add basic explanation of template rendering

RequestHandlers

@@ -35 +35 @@
 == Rendering Genshi Templates ==
 
-TODO
+The `diva.templating` module provides convenience functions for rendering Genshi templates.
 
-== Default Template Data ==
+First, there's the `@output` decorator, which you use to specify the name of the template file, the serialization method, the response MIME type and encoding, and other serialization options such as the `DOCTYPE` to use and so on.
 
-Diva makes a number of objects available for use in Genshi by default:
+Note that all of these are optional. For example, you can omit the template file name for a response that doesn't involve template rendering, and just use the `mimetype` and `encoding` options:
+
+{{{
+#!python
+@caching(max_age=timedelta(days=7))
+@output(mimetype='text/css', encoding='utf-8')
+def style(request, response, font_size=1):
+    return 'html { font-size: %sem; }' % font_size
+}}}
+
+If you do want to render a template, use the `render()` function to return a Genshi stream from the request handler. You pass any template data into the `render()` function as keyword arguments, and it will generate an output stream from the template based on the template data. The `render()` function also lets you override the template filename specified using the `@output` decorator: simple pass the template name as the first (and only) positional argument into `render()`.
+
+=== Default Template Data ===
+
+Diva makes a number of objects available for use in Genshi templates by default:
 
  `app`:: The [ApplicationObject Application] object
@@ -58 +72 @@
 == Builtin Request Handlers ==
 
-Diva comes with a couple of generic request handlers that can be used as-is with some parameterization.
+Diva comes with a couple of generic request handlers that can be used as-is with some parameterization in UrlRouting.
 
  `diva.routing:delegate`:: Delegate request processing to a different WSGI application.