<link href="css/default.css" media="screen, projection" rel="stylesheet" type="text/css" /><link href="css/SyntaxHighlighter.css" media="screen, projection" rel="stylesheet" type="text/css" /><script src="js/shCore.js" type="text/javascript"> </script><script src="js/shBrushCSharp.js" type="text/javascript"> </script><script src="js/shBrushPhp.js" type="text/javascript"> </script><script src="js/shBrushJScript.js" type="text/javascript"> </script><script src="js/shBrushVb.js" type="text/javascript"> </script><script src="js/shBrushSql.js" type="text/javascript"> </script><script src="js/shBrushXml.js" type="text/javascript"> </script><script src="js/shBrushDelphi.js" type="text/javascript"> </script><script src="js/shBrushPython.js" type="text/javascript"> </script></head><body>TurboHtmlPy >>> | <a href="index.html">Overview</a> | <a href="quickstart.rst.html">Quickstart</a> | <a href="howto.rst.html">How To</a> | <a href="cookbook.rst.html">Tips</a> | <a href="samples.rst.html">Samples/Gallery</a> | <hr /><div class="document"> <div class="contents topic"> <p class="topic-title first"><a id="table-of-contents" name="table-of-contents">Table of Contents</a></p> <ul class="simple"> <li><a class="reference" href="#overview" id="id1" name="id1">Overview</a></li> <li><a class="reference" href="#main-features" id="id2" name="id2">Main Features</a></li> <li><a class="reference" href="#download-installation" id="id3" name="id3">Download & Installation</a></li> <li><a class="reference" href="#history" id="id4" name="id4">History</a><ul> <li><a class="reference" href="#changes" id="id5" name="id5">Changes</a></li> <li><a class="reference" href="#roadmap" id="id6" name="id6">Roadmap</a></li> </ul> </li> </ul> </div> <div class="section"> <h1><a class="toc-backref" href="#id1" id="overview" name="overview">Overview</a></h1> <p>TurboHtmlPy is a lightweight template engine using a Python like syntax to produce xml/xhtml data. It provides plug-in implementation for <a class="reference" href="http://www.turbogears.org/">TurboGears</a> and <a class="reference" href="http://projects.dowski.com/projects/buffet">Buffet</a>, and can be easily called from any python application or interactive shell.</p> <div class="code"> <textarea class="python" cols="60" name="code-block" rows="10"> html( body( h1('Hello World'), p(""" blah ble balen ,;, uunllsd jklmibnjnnjsdb blbcfl """ ), ) ) </textarea> </div><div class="important"> <p class="first admonition-title">Important</p> <p class="last">TurboHtmlPy is a on going project, still in its infancy, so all feedbacks, comments, suggestions... are welcome</p> </div> </div> <div class="section"> <h1><a class="toc-backref" href="#id2" id="main-features" name="main-features">Main Features</a></h1> <ul class="simple"> <li>WORK</li> <li>Use Python Object to produce xml/xhtml. You can create your files with a Python editor which gives you the benefit of syntax checking with color support.</li> <li>Easy installation and integration with <a class="reference" href="http://www.turbogears.org/">TurboGears</a> and Buffet_(see installation)</li> <li>Possibility to derive a template (also called "extends" in Kid, or inheritance)</li> <li>"Readable" and usefull exception</li> <li>Unicode support</li> <li>Dynamic reloading</li> <li>Good performance</li> </ul> </div> <div class="section"> <h1><a class="toc-backref" href="#id3" id="download-installation" name="download-installation">Download & Installation</a></h1> <p>The easiest way it to use easy_install. To install this tool please refer to <a class="reference" href="http://peak.telecommunity.com/DevCenter/EasyInstall#installing-easy-install">Installing Easy_Install</a></p> <p>Then enter the following commands at shell/dos:</p> <pre class="literal-block"> $>easy_install TurboHtmlPy </pre> <p>Or to install form source:</p> <pre class="literal-block"> $>easy_install http://cheeseshop.python.org/packages/source/T/TurboHtmlPy/TurboHtmlPy-<version>.tar.gz </pre> <p>Distributions (source and binary/egg) are available at <a class="reference" href="http://cheeseshop.python.org/pypi/TurboHtmlPy">CheeseShop</a></p> <p>easy_install will register automatically TurboHtmlPy as a <a class="reference" href="http://www.turbogears.org/">TurboGears</a> / <a class="reference" href="http://projects.dowski.com/projects/buffet">Buffet</a> Template Plugin. The prefix/name of this template engine is 'htmlpy'.</p> </div> <div class="section"> <h1><a class="toc-backref" href="#id4" id="history" name="history">History</a></h1> <div class="section"> <h2><a class="toc-backref" href="#id5" id="changes" name="changes">Changes</a></h2> <dl class="docutils"> <dt>0.4 (2005-02-18)</dt> <dd><ul class="first last simple"> <li>add hpy__raw helper to insert raw data (no xml encoding/parsing), using hpy__raw could generate 'bad-formed' XML</li> <li>add hpy__cdata helper to insert <![CDATA[...]]> node (no xml encoding/parsing), using hpy__cdata could generate 'bad-formed' XML</li> <li>use pkg_resources to find template (like TurboKid)</li> <li>fix a bug for accessing 'std' context, in 0.3a need 'std.std.', now 'std.' is enough</li> <li>extra function are accessible through 'xtra' Context</li> <li>vars, std and xtra Context could be use like dict or like structure (eg : vars['xyz'] ~ vars.xyz)</li> <li>remove hpy__cnv helper, useless since TG 0.9</li> <li>replace 'isPath' parameter by 'isLocation'</li> <li>append DOCTYPE in render if fragment is False and format is xhtml</li> <li>append xml header in render if fragment is False and format is xml, xhtml</li> </ul> </dd> <dt>0.3a (2005-01-25)</dt> <dd><ul class="first last simple"> <li>remove special hpy__kid tag</li> <li>add hpy__xml to pass xml as string (alias for elementtree.ElementTree.XML, so string is parsed)</li> <li>add hpy__pi to create processing instruction (alias for elementtree.ElementTree.ProcessingInstruction)</li> <li>add hpy__comment to create xml comment (shortcut comment already exists) (alias for elementtree.ElementTree.Comment)</li> <li>when exception are raised, the name of the template is appended into the message</li> <li>support for "_" function, implemented as default if not in "__builtins__"</li> <li>add shortcut to call TG's Widget</li> </ul> </dd> <dt>0.2a</dt> <dd><ul class="first last simple"> <li>rewrite of the inheritance and slot => new syntax</li> <li>use "hpy:" prefix for htmlpy special tag</li> </ul> </dd> <dt>0.1</dt> <dd><ul class="first last simple"> <li>port <a class="reference" href="http://www.develix.com/software/">TurboStan</a> 0.8 to use FormEncode.htmlgen instead of Stan</li> </ul> </dd> </dl> </div> <div class="section"> <h2><a class="toc-backref" href="#id6" id="roadmap" name="roadmap">Roadmap</a></h2> <dl class="docutils"> <dt>0.5</dt> <dd><ul class="first last simple"> <li>clean doc and code</li> <li>better error reporting (suggestions welcome)</li> <li>better documentation, more samples and tests (suggestion welcome)</li> <li>documentation, test and sample ...> doctest (take alook at <a class="reference" href="http://www.kieranholland.com/prose/meet-stan/">http://www.kieranholland.com/prose/meet-stan/</a>)</li> <li>support various encoding (other than us-ascii and utf-8)</li> <li>add hpy:slotid attribute to differentiate several slot with same tag</li> <li>add prettyprint option (Maybe use of mxTidy.html for pretty print xml ou <a class="reference" href="http://utidylib.berlios.de/">http://utidylib.berlios.de/</a>, cf <a class="reference" href="http://www.xml.com/pub/a/2004/09/08/pyxml.html">http://www.xml.com/pub/a/2004/09/08/pyxml.html</a>)</li> <li>add cli interface, to run/test TurboHtmlPy out of a TG context</li> <li>add the hpy__strip or hpy__invisible tag (like stan)</li> <li>better doctype management</li> </ul> </dd> <dt>0.6</dt> <dd><ul class="first last simple"> <li>better error reporting (suggestion welcome)</li> <li>better documentation, more samples and tests (suggestion welcome)</li> <li>a tool to convert xml text -> elementTree -> htmlpy</li> <li>support for a search path to find template files (request from Peter Hunt, Ian Bicking,...)</li> <li>duplicate and enhance the elementTree.write method to support indentation and string as <![CDATA[... ]]></li> <li>new web site, with forum, issue tracker... maybe hosted by sourceforge or python-hosting</li> <li>measure performance (CPU and Memory) and compare to Kid</li> <li>implements a cache if needed</li> <li>support javascript text with char '<' and '>' as text node (no translation)</li> <li>support to read slot from a xml/xhtml string, usefull to decorate an existing page</li> <li>suggest a patch to htmlgen to support several etree implementations : # import main module under an alias import elementtree.ElementTree as ET import cElementTree as ET import lxml.etree as ET import xml.etree.ElementTree as ET # python 2.5 # see <a class="reference" href="http://effbot.org/zone/element-index.htm">http://effbot.org/zone/element-index.htm</a></li> </ul> </dd> </dl> <table class="docutils field-list" frame="void" rules="none"> <col class="field-name" /> <col class="field-body" /> <tbody valign="top"> <tr class="field"><th class="field-name">Author:</th><td class="field-body">David Bernard</td> </tr> <tr class="field"><th class="field-name">Contact:</th><td class="field-body"><a class="reference" href="mailto:dwayne@java-fan.com">dwayne@java-fan.com</a></td> </tr> <tr class="field"><th class="field-name">Date:</th><td class="field-body">2005-02-18</td> </tr> </tbody> </table> </div> </div> </div> <script type="text/javascript">dp.SyntaxHighlighter.HighlightAll('code-block')</script></body></html>