twisted.web.woven.template.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.web.woven.template</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.web.html">Package web</a> ::
<a href="twisted.web.woven.html">Package woven</a> ::
Module template
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.web.woven.template.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.web.woven.template</h2>
<p>DOMTemplate</p>
<p>Most templating systems provide commands that you embed in the HTML to
repeat elements, include fragments from other files, etc. This works
fairly well for simple constructs and people tend to get a false sense of
simplicity from this. However, in my experience, as soon as the
programmer wants to make the logic even slightly more complicated, the
templating system must be bent and abused in ways it was never meant to
be used.</p>
<p>The theory behind DOMTemplate is that Python code instead of template
syntax in the HTML should be used to manipulate the structure of the
HTML. DOMTemplate uses the DOM, a w3c standard tree-based representation
of an HTML document that provides an API that allows you to traverse
nodes in the tree, examine their attributes, move, add, and delete them.
It is a fairly low level API, meaning it takes quite a bit of code to get
a bit done, but it is standard -- learn the DOM once, you can use it from
ActionScript, JavaScript, Java, C++, whatever.</p>
<p>A DOMTemplate subclass must do two things: indicate which template it
wants to use, and indicate which elements it is interested in.</p>
A short example:
<pre class="literalblock">
| class Test(DOMTemplate):
| template = '''
| <html><head><title>Foo</title></head><body>
|
| <div view="Test">
| This test node will be replaced
| </div>
|
| </body></html>
| '''
|
| def factory_test(self, request, node):
| '''
| The test method will be called with the request and the
| DOM node that the test method was associated with.
| '''
| # self.d has been bound to the main DOM "document" object
| newNode = self.d.createTextNode("Testing, 1,2,3")
|
| # Replace the test node with our single new text node
| return newNode
</pre>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.DOMController.html"><code>DOMController</code></a></b></td>
<td>A simple controller that automatically passes responsibility on to the
view class registered for the model.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.DOMTemplate.html"><code>DOMTemplate</code></a></b></td>
<td>A resource that renders pages using DOM.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.DOMTemplate.html"><code>DOMView</code></a></b></td>
<td>A resource that renders pages using DOM.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.INodeMutator.html"><code>INodeMutator</code></a></b></td>
<td>A component that implements NodeMutator knows how to mutate DOM based
on the instructions in the object it wraps.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.NodeMutator.html"><code>NodeMutator</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.NodeNodeMutator.html"><code>NodeNodeMutator</code></a></b></td>
<td>A NodeNodeMutator replaces the node that is passed in to generate with
the node it adapts.</td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.NoneNodeMutator.html"><code>NoneNodeMutator</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.web.woven.template.StringNodeMutator.html"><code>StringNodeMutator</code></a></b></td>
<td>A StringNodeMutator replaces the node that is passed in to generate
with the string it adapts.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.woven.template.html#RESTART_RENDERING"><code>RESTART_RENDERING</code></a></b> = <span title="2">2 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.web.woven.template.html#STOP_RENDERING"><code>STOP_RENDERING</code></a></b> = <span title="1">1 </span></td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="RESTART_RENDERING"></a>
<h3>RESTART_RENDERING</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="2"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
2 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="STOP_RENDERING"></a>
<h3>STOP_RENDERING</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:32 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>