genshi/mirror: doc/xml-templates.txt comparison

comparison doc/xml-templates.txt @ 237:670f543fd8c2 trunk

Flatten outline of XML templating documentation.

author	cmlenz
date	Tue, 12 Sep 2006 15:59:10 +0000
parents	41107d1ba1c8
children	4d81439bc097

comparison

equal deleted inserted replaced

-:7fb269e7da81
+:670f543fd8c2
 naturally to elements in the template. In such cases, the ``py:strip``
 directive can be used to strip off the unwanted element, or the directive can
 simply be used as an element.
-Available Directives
+Conditional Sections
 ====================
-Conditional Sections
---------------------
 .. _`py:if`:
 ``py:if``
-`````````
+---------
 The element is only rendered if the expression evaluates to a truth value::
 <div>
 <b py:if="foo">${bar}</b>
 .. _`py:choose`:
 .. _`py:when`:
 .. _`py:otherwise`:
-``py:choose`` / ``py:when`` / ``py:otherwise``
+``py:choose``
-``````````````````````````````````````````````
+-------------
-This set of directives provides advanced contional processing for rendering one
+The ``py:choose`` directive, in combination with the directives ``py:when``
+and ``py:otherwise`` provides advanced contional processing for rendering one
 of several alternatives. The first matching ``py:when`` branch is rendered, or,
 if no ``py:when`` branch matches, the ``py:otherwise`` branch is be rendered.
 If the ``py:choose`` directive is empty the nested ``py:when`` directives will
 be tested for truth::
 <span>1</span>
 </div>
 Looping
--------
+=======
 .. _`py:for`:
 ``py:for``
-``````````
+----------
 The element is repeated for every item in an iterable::
 <ul>
 <li py:for="item in items">${item}</li>
 </py:for>
 </ul>
 Snippet Reuse
--------------
+=============
 .. _`py:def`:
 .. _`macros`:
 ``py:def``
-``````````
+----------
 The ``py:def`` directive can be used to create macros, i.e. snippets of
 template code that have a name and optionally some parameters, and that can be
 inserted in other places::
 .. _Match Templates:
 .. _`py:match`:
 ``py:match``
-````````````
+------------
 This directive defines a *match template*: given an XPath expression, it
 replaces any element in the template that matches the expression with its own
 content.
 <greeting name="Dude" />
 </div>
 Variable Binding
-----------------
+================
 .. _`with`:
 ``py:with``
-```````````
+-----------
 The ``py:with`` directive lets you assign expressions to variables, which can
 be used to make expressions inside the directive less verbose and more
 efficient. For example, if you need use the expression ``author.posts`` more
 than once, and that actually results in a database query, assigning the results
 will have the same value it had prior to the ``py:with`` assignment.
 Effectively, this means that variables are immutable in Genshi.
 Structure Manipulation
-----------------------
+======================
 .. _`py:attrs`:
 ``py:attrs``
-````````````
+------------
 This directive adds, modifies or removes attributes from the element::
 <ul>
 <li py:attrs="foo">Bar</li>
 .. _`py:content`:
 ``py:content``
-``````````````
+--------------
 This directive replaces any nested content with the result of evaluating the
 expression::
 <ul>
 .. _`py:replace`:
 ``py:replace``
-``````````````
+--------------
 This directive replaces the element itself with the result of evaluating the
 expression::
 <div>
 .. _`py:strip`:
 ``py:strip``
-````````````
+------------
 This directive conditionally strips the top-level element from the output. When
 the value of the ``py:strip`` attribute evaluates to ``True``, the element is
 stripped from the output::

Mercurial > genshi > mirror

comparison doc/xml-templates.txt @ 237:670f543fd8c2 trunk