Changeset 3730

Timestamp:

Sep 13, 2006, 6:30:26 PM (17 years ago)

Author:

Christian Boos

Message:

Genshi branch: converted text templates to use the new TextTemplate template format (see ​Genshi:wiki:ApiDocs/genshi.template#genshi.template:TextTemplate).

Location:

sandbox/genshi

Files:

• templates/revisionlog.txt (modified) (2 diffs)
• templates/ticket_notify_email.txt (modified) (1 diff)
• trac/notification.py (modified) (1 diff)
• trac/web/chrome.py (modified) (3 diffs)

sandbox/genshi/templates/revisionlog.txt

@@ -1 @@
-<changelog xmlns:py="http://genshi.edgewall.org/" py:strip="">
 #
 # ChangeLog for $path
@@ -5 +4 @@
 # Generated by Trac $trac.version
 # ${format_datetime}
-#
-  <py:for each="item in items" py:with="change = changes[item.rev]">
-$change.date $change.author [$item.rev]<!--!
-    --><py:for each="idx, file in enumerate(change.files)">
-        * $file (<py:choose test="change.actions[idx]"><!--! FIXME: much simpler solution with #M37 
-        --><py:when test="'edit'">modified</py:when><!--!
-        --><py:when test="'add'">added</py:when><!--!
-        --><py:when test="'delete'">deleted</py:when><!--!
-        --><py:when test="'copy'">copied</py:when><!--!
-        --><py:when test="'move'">moved</py:when><!--!
-        --></py:choose>)</py:for>
+#for item in items
+  #with change = changes[item.rev]
+$change.date $change.author [$item.rev]
+    #for idx, file in enumerate(change.files)
+        * $file (${dict(edit='modified', add='added', delete='deleted',
+                        copy='copied', move='moved')[change.actions[idx]]})
+    #end
 $change.message
-    </py:for>
-</changelog>
+  #end
+#end

sandbox/genshi/templates/ticket_notify_email.txt

@@ -1 @@
-<mail xmlns:py="http://genshi.edgewall.org/" py:strip=""><!--!
-
-  Some notes about how to handle white-spaces in text templates:
-
-  - every structure tag should be followed by a comment start: < ! - - !
-
-  - every tag but the first should be preceeded by a comment end: - - >
-
-  - text data following a new line will be inserted either directly,
-    by first ending the comment then placing the content on the same 
-    line, or inserted after a newline, by first closing the comment, 
-    then placing the data on a line of its own.
-
-  - after text data, a comment start should be started on a newline, 
-    which will effectively insert a newline. 
-    Sometimes though this is not wanted, for example when the data
-    itself ends with a newline... (see $changes_body below)
-
--->
 $ticket_body_hdr
 $ticket_props
-<!--! 
-  --><py:choose test="ticket.new"><!--!
-    --><py:when test="True"><!--!
--->
+#choose ticket.new
+  #when True
 $ticket.description
-<!--!
-    --></py:when><!--!
-    --><py:otherwise><!--!
-      --><py:if test="changes_body"><!--!
--->
+  #end
+  #otherwise
+    #if changes_body
 Changes (by $change.author):
 
-$changes_body<!--!
-      --></py:if><!--!
-      --><py:if test="changes_descr"><!--!
--->
+$changes_body
+    #end
+    #if changes_descr
 $changes_descr
 --
-<!--!
-      --></py:if><!--!
-      --><py:if test="change.comment"><!--!
--->
-Comment<py:if test="not changes_body"> (by $change.author)</py:if>:
+    #end
+    #if change.comment
+
+Comment${not changes_body and '(by %s)' % change.author or ''}:
 
 $change.comment
-<!--!
-      --></py:if><!--!
-    --></py:otherwise><!--!
-  --></py:choose><!--!
--->
+    #end
+  #end
+#end
+
 -- 
-Ticket URL: &lt;$ticket.link&gt;
-$project.name &lt;${abs_href}&gt;
+Ticket URL: <$ticket.link>
+$project.name <${abs_href}>
 $project.descr
-</mail>

sandbox/genshi/trac/notification.py

@@ -97 +97 @@
         self.db = env.get_db_cnx()
 
-        self.template = Chrome(self.env).load_template(self.template_name)
+        self.template = Chrome(self.env).load_template(self.template_name,
+                                                       method='text')
         self.data = {'CRLF': CRLF}
         Chrome(self.env).populate_data(None, self.data)

sandbox/genshi/trac/web/chrome.py

@@ -22 +22 @@
 from genshi.builder import tag
 from genshi.output import DocType
-from genshi.template import TemplateLoader
+from genshi.template import TemplateLoader, MarkupTemplate, TextTemplate
 
 from trac import mimeview
@@ -419 +419 @@
         from pprint import pformat
         data['pprint'] = pformat
-        if req:
-            data['GENSHI_DEBUG'] = req.args.get('genshi_debug')
-
-    def load_template(self, filename, req=None, data=None):
-        """Retrieve a Template and optionally preset the template data"""
+
+    def load_template(self, filename, req=None, data=None, method=None):
+        """Retrieve a Template and optionally preset the template data.
+
+        If `req` and `data` are given, the `data` dictionary will be preset
+        with the "standard" Trac information and helper methods.
+
+        Also, if the optional `method` argument is set to `'text'`, a
+        TextTemplate instance will be created instead of a MarkupTemplate.
+        """
         if req and data:
             self.populate_data(req, data)
@@ -429 +434 @@
             self.templateloader = TemplateLoader(self.get_all_templates_dirs(),
                                                  auto_reload=self.auto_reload)
-        return self.templateloader.load(filename)
+        cls = method == 'text' and TextTemplate or MarkupTemplate
+        return self.templateloader.load(filename, cls=cls)
 
     def render_response(self, req, template_name, content_type, data):
-        self.populate_data(req, data)
-
-        stream = self.load_template(template_name).generate(**data)
-
+        """Render the `template_name` using the `data` for the context.
+
+        The MIME `content_type` argument is used to choose the kind of template
+        used (TextTemplate if `'text/plain'`, MarkupTemplate otherwise), and
+        tweak the rendering process (use of XHTML Strict doctype if
+        `'text/html'` is given).
+        """
         if content_type is None:
             content_type = 'text/html'
+        doctype = {'text/html': DocType.XHTML_STRICT}.get(content_type)
         method = {'text/html': 'xhtml',
                   'text/plain': 'text'}.get(content_type, 'xml')
-        doctype = {'text/html': DocType.XHTML_STRICT}.get(content_type)
+        
+        template = self.load_template(template_name, req, data, method=method)
+        stream = template.generate(**data)
 
         if method == 'text':
             return stream.render('text')
-        return stream.render(method, doctype=doctype)
+        else:
+            return stream.render(method, doctype=doctype)