Context Navigation

0.11

Timestamp:: Sep 13, 2006, 3:44:01 PM (18 years ago)
Author:: Christian Boos
Comment:: Added set/py:with and def sections, as well as a new, more complex, example

Legend:

: Unmodified
: Added
: Removed
: Modified

TracDev/ApiChanges/0.11

-              v4
+              v5
    }}}
+Let's take a full-contained example from the Trac source, the simple index.cs / index.html templates.
+[source:trunk/templates/index.cs@3725 index.cs]:
+{{{
+==== define a macro ====
+ - Clearsilver
+   {{{
+#!xml
+<?cs def:entry(key, val)?>
+ <dt><?cs var:key ?></dt><dd><?cs var:val ?></dd>
+<?cs /def ?>
+   }}}
+ - Genshi
+   {{{
+#!xml
+<py:def function="entry(key, val='--')">
+ <dt>$key</dt><dd>$val</dd>
+</py:def>
+   }}}
+   As you can see, with Genshi it's also easy to specify default values for the macro arguments.
+==== set a variable ====
+ - Clearsilver
+   {{{
+#!xml
+<?cs set:count = len(collection) ?>
+We have <?cs if:count > 10 ?>too much<?cs else ?><?cs var:count ?><?cs /if ?> elements.
+   }}}
+ - Genshi
+   {{{
+#!xml
+<py:with vars="count = len(collection)">
+We have ${count &gt; 10 and 'too much' or count} elements.
+</py:with>
+   }}}
+   Note that we had to use `&gt;` in Genshi, instead of directly `>` as in Clearsilver.
+==== Examples ====
+Let's first take a simple full-contained example from the Trac source, the simple index.cs / index.html templates.
+ - Clearsilver [source:trunk/templates/index.cs@3725 index.cs]:
+   {{{
 #!xml
 <!DOCTYPE html
 …
  /each ?></ul></body>
 </html>
+}}}
+[source:sandbox/genshi/templates/index.html@3728 index.html]:
+{{{
+   }}}
+ - Genshi [source:sandbox/genshi/templates/index.html@3728 index.html]:
+   {{{
 #!xml
 <!DOCTYPE html
 …
   </body>
 </html>
 }}}
+   }}}
 Some remarks:
 …
 Of course, the great benefit of this constraint is that you'll end up quite naturally with well-formed content, which was far from being a trivial achievement using Clearsilver templates. Granted, you could still insert directly some non well-formed `Markup` data in your template, but again, if you use the [http://genshi.edgewall.org/wiki/Documentation/builder.html genshi.builder] ''tag'' facility for this, that's hardly a risk.
+Another example from Trac, a bit more complex.
+This illustrates how to use `<py:def>` and `<py:with>`, to convert a Clearsilver macro using `<?cs def: ?>` and `<?cs set: ?>`.
+ - Clearsilver
+   {{{
+#!xml
+def:browser_path_links(path, file) ?><?cs
+<?cs set:first = #1 ?><?cs
+  each:part = path ?><?cs
+   set:last = name(part) == len(path) - #1 ?><a<?cs
+   if:first ?> class="first" title="Go to root directory"<?cs
+    set:first = #0 ?><?cs
+   else ?> title="View <?cs var:part.name ?>"<?cs
+   /if ?> href="<?cs var:part.href ?>"><?cs var:part.name ?></a><?cs
+   if:!last ?><span class="sep">/</span><?cs /if ?><?cs
+ /each ?><?cs
+/def ?><?cs
+   }}}
+ - Genshi
+   {{{
+#!xml
+  <py:def function="browser_path_links(path_links)">
+    <py:for each="idx, part in enumerate(path_links)">
+      <py:with vars="first = (idx == 0); last = (idx == len(path_links) - 1)">
+        <a class="${first and 'first' or None}"
+          title="${first and 'Go to root directory' or 'View ' + part.name}"
+          href="$part.href">$part.name</a>
+        <py:if test="not last"><span class="sep">/</span></py:if>
+      </py:with>
+    </py:for>
+  </py:def>
+   }}}
 === Changes in the controllers ===