index.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. <html xmlns="http://www.w3.org/1999/xhtml">
  2. <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  3. <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
  4. <head>
  5. <title>
  6. Mako 1.0.7 Documentation
  7. </title>
  8. <!-- begin iterate through sphinx environment css_files -->
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <link rel="stylesheet" href="_static/docs.css" type="text/css" />
  11. <link rel="stylesheet" href="_static/site.css" type="text/css" />
  12. <link rel="stylesheet" href="_static/changelog.css" type="text/css" />
  13. <link rel="stylesheet" href="_static/sphinx_paramlinks.css" type="text/css" />
  14. <!-- end iterate through sphinx environment css_files -->
  15. <script type="text/javascript">
  16. var DOCUMENTATION_OPTIONS = {
  17. URL_ROOT: './',
  18. VERSION: '1.0.7',
  19. COLLAPSE_MODINDEX: false,
  20. FILE_SUFFIX: '.html'
  21. };
  22. </script>
  23. <script type="text/javascript" src="_static/jquery.js"></script>
  24. <script type="text/javascript" src="_static/underscore.js"></script>
  25. <script type="text/javascript" src="_static/doctools.js"></script>
  26. <link rel="index" title="Index" href="genindex.html" />
  27. <link rel="search" title="Search" href="search.html" />
  28. <link rel="top" title="Mako 1.0.7 Documentation" href="#" />
  29. <link rel="next" title="Usage" href="usage.html" />
  30. </head>
  31. <body>
  32. <div id="wrap">
  33. <div class="rightbar">
  34. <div class="slogan">
  35. Hyperfast and lightweight templating for the Python platform.
  36. </div>
  37. </div>
  38. <a href="http://www.makotemplates.org/"><img src="_static/makoLogo.png" /></a>
  39. <hr/>
  40. <div id="docs-container">
  41. <div id="docs-header">
  42. <h1>Mako 1.0.7 Documentation</h1>
  43. <div id="docs-search">
  44. Search:
  45. <form class="search" action="search.html" method="get">
  46. <input type="text" name="q" size="18" /> <input type="submit" value="Search" />
  47. <input type="hidden" name="check_keywords" value="yes" />
  48. <input type="hidden" name="area" value="default" />
  49. </form>
  50. </div>
  51. <div id="docs-version-header">
  52. Release: <span class="version-num">1.0.7</span>
  53. </div>
  54. </div>
  55. <div id="docs-top-navigation">
  56. <div id="docs-top-page-control" class="docs-navigation-links">
  57. <ul>
  58. <li>Next:
  59. <a href="usage.html" title="next chapter">Usage</a>
  60. </li>
  61. <li>
  62. <a href="#">Table of Contents</a> |
  63. <a href="genindex.html">Index</a>
  64. | <a href="_sources/index.rst.txt">view source
  65. </li>
  66. </ul>
  67. </div>
  68. <div id="docs-navigation-banner">
  69. <a href="#">Mako 1.0.7 Documentation</a>
  70. <h2>
  71. Table of Contents
  72. </h2>
  73. </div>
  74. </div>
  75. <div id="docs-body-container">
  76. <div id="docs-body" class="" >
  77. <div class="section" id="table-of-contents">
  78. <h1>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline">¶</a></h1>
  79. <div class="toctree-wrapper compound">
  80. <ul>
  81. <li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
  82. <li class="toctree-l2"><a class="reference internal" href="usage.html#basic-usage">Basic Usage</a></li>
  83. <li class="toctree-l2"><a class="reference internal" href="usage.html#using-file-based-templates">Using File-Based Templates</a></li>
  84. <li class="toctree-l2"><a class="reference internal" href="usage.html#using-templatelookup">Using <code class="docutils literal"><span class="pre">TemplateLookup</span></code></a></li>
  85. <li class="toctree-l2"><a class="reference internal" href="usage.html#using-unicode-and-encoding">Using Unicode and Encoding</a></li>
  86. <li class="toctree-l2"><a class="reference internal" href="usage.html#handling-exceptions">Handling Exceptions</a></li>
  87. <li class="toctree-l2"><a class="reference internal" href="usage.html#common-framework-integrations">Common Framework Integrations</a></li>
  88. <li class="toctree-l2"><a class="reference internal" href="usage.html#api-reference">API Reference</a></li>
  89. </ul>
  90. </li>
  91. <li class="toctree-l1"><a class="reference internal" href="syntax.html">Syntax</a><ul>
  92. <li class="toctree-l2"><a class="reference internal" href="syntax.html#expression-substitution">Expression Substitution</a></li>
  93. <li class="toctree-l2"><a class="reference internal" href="syntax.html#expression-escaping">Expression Escaping</a></li>
  94. <li class="toctree-l2"><a class="reference internal" href="syntax.html#control-structures">Control Structures</a></li>
  95. <li class="toctree-l2"><a class="reference internal" href="syntax.html#comments">Comments</a></li>
  96. <li class="toctree-l2"><a class="reference internal" href="syntax.html#newline-filters">Newline Filters</a></li>
  97. <li class="toctree-l2"><a class="reference internal" href="syntax.html#python-blocks">Python Blocks</a></li>
  98. <li class="toctree-l2"><a class="reference internal" href="syntax.html#module-level-blocks">Module-level Blocks</a></li>
  99. <li class="toctree-l2"><a class="reference internal" href="syntax.html#tags">Tags</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="syntax.html#exiting-early-from-a-template">Exiting Early from a Template</a></li>
  101. </ul>
  102. </li>
  103. <li class="toctree-l1"><a class="reference internal" href="defs.html">Defs and Blocks</a><ul>
  104. <li class="toctree-l2"><a class="reference internal" href="defs.html#using-defs">Using Defs</a></li>
  105. <li class="toctree-l2"><a class="reference internal" href="defs.html#using-blocks">Using Blocks</a></li>
  106. </ul>
  107. </li>
  108. <li class="toctree-l1"><a class="reference internal" href="runtime.html">The Mako Runtime Environment</a><ul>
  109. <li class="toctree-l2"><a class="reference internal" href="runtime.html#context">Context</a></li>
  110. <li class="toctree-l2"><a class="reference internal" href="runtime.html#the-loop-context">The Loop Context</a></li>
  111. <li class="toctree-l2"><a class="reference internal" href="runtime.html#all-the-built-in-names">All the Built-in Names</a></li>
  112. <li class="toctree-l2"><a class="reference internal" href="runtime.html#api-reference">API Reference</a></li>
  113. </ul>
  114. </li>
  115. <li class="toctree-l1"><a class="reference internal" href="namespaces.html">Namespaces</a><ul>
  116. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#ways-to-call-namespaces">Ways to Call Namespaces</a></li>
  117. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#namespaces-from-regular-python-modules">Namespaces from Regular Python Modules</a></li>
  118. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#declaring-defs-in-namespaces">Declaring Defs in Namespaces</a></li>
  119. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#the-body-method">The <code class="docutils literal"><span class="pre">body()</span></code> Method</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#built-in-namespaces">Built-in Namespaces</a></li>
  121. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#inheritable-namespaces">Inheritable Namespaces</a></li>
  122. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#namespace-api-usage-example-static-dependencies">Namespace API Usage Example - Static Dependencies</a></li>
  123. <li class="toctree-l2"><a class="reference internal" href="namespaces.html#api-reference">API Reference</a></li>
  124. </ul>
  125. </li>
  126. <li class="toctree-l1"><a class="reference internal" href="inheritance.html">Inheritance</a><ul>
  127. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#nesting-blocks">Nesting Blocks</a></li>
  128. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#rendering-a-named-block-multiple-times">Rendering a Named Block Multiple Times</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#but-what-about-defs">But what about Defs?</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#using-the-next-namespace-to-produce-content-wrapping">Using the <code class="docutils literal"><span class="pre">next</span></code> Namespace to Produce Content Wrapping</a></li>
  131. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#using-the-parent-namespace-to-augment-defs">Using the <code class="docutils literal"><span class="pre">parent</span></code> Namespace to Augment Defs</a></li>
  132. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#using-include-with-template-inheritance">Using <code class="docutils literal"><span class="pre">&lt;%include&gt;</span></code> with Template Inheritance</a></li>
  133. <li class="toctree-l2"><a class="reference internal" href="inheritance.html#inheritable-attributes">Inheritable Attributes</a></li>
  134. </ul>
  135. </li>
  136. <li class="toctree-l1"><a class="reference internal" href="filtering.html">Filtering and Buffering</a><ul>
  137. <li class="toctree-l2"><a class="reference internal" href="filtering.html#expression-filtering">Expression Filtering</a></li>
  138. <li class="toctree-l2"><a class="reference internal" href="filtering.html#filtering-defs-and-blocks">Filtering Defs and Blocks</a></li>
  139. <li class="toctree-l2"><a class="reference internal" href="filtering.html#buffering">Buffering</a></li>
  140. <li class="toctree-l2"><a class="reference internal" href="filtering.html#decorating">Decorating</a></li>
  141. </ul>
  142. </li>
  143. <li class="toctree-l1"><a class="reference internal" href="unicode.html">The Unicode Chapter</a><ul>
  144. <li class="toctree-l2"><a class="reference internal" href="unicode.html#specifying-the-encoding-of-a-template-file">Specifying the Encoding of a Template File</a></li>
  145. <li class="toctree-l2"><a class="reference internal" href="unicode.html#handling-expressions">Handling Expressions</a></li>
  146. <li class="toctree-l2"><a class="reference internal" href="unicode.html#defining-output-encoding">Defining Output Encoding</a></li>
  147. <li class="toctree-l2"><a class="reference internal" href="unicode.html#saying-to-heck-with-it-disabling-the-usage-of-unicode-entirely">Saying to Heck with It: Disabling the Usage of Unicode Entirely</a></li>
  148. </ul>
  149. </li>
  150. <li class="toctree-l1"><a class="reference internal" href="caching.html">Caching</a><ul>
  151. <li class="toctree-l2"><a class="reference internal" href="caching.html#cache-arguments">Cache Arguments</a></li>
  152. <li class="toctree-l2"><a class="reference internal" href="caching.html#programmatic-cache-access">Programmatic Cache Access</a></li>
  153. <li class="toctree-l2"><a class="reference internal" href="caching.html#cache-plugins">Cache Plugins</a></li>
  154. <li class="toctree-l2"><a class="reference internal" href="caching.html#api-reference">API Reference</a></li>
  155. </ul>
  156. </li>
  157. <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
  158. <li class="toctree-l2"><a class="reference internal" href="changelog.html#id1">1.0</a></li>
  159. <li class="toctree-l2"><a class="reference internal" href="changelog.html#id2">0.9</a></li>
  160. <li class="toctree-l2"><a class="reference internal" href="changelog.html#id3">0.8</a></li>
  161. <li class="toctree-l2"><a class="reference internal" href="changelog.html#id4">0.7</a></li>
  162. <li class="toctree-l2"><a class="reference internal" href="changelog.html#older-versions">Older Versions</a></li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </div>
  167. <div class="section" id="indices-and-tables">
  168. <h2>Indices and Tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
  169. <ul class="simple">
  170. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
  171. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
  172. </ul>
  173. </div>
  174. </div>
  175. </div>
  176. </div>
  177. <div id="docs-bottom-navigation" class="docs-navigation-links">
  178. Next:
  179. <a href="usage.html" title="next chapter">Usage</a>
  180. <div id="docs-copyright">
  181. &copy; Copyright the Mako authors and contributors.
  182. Documentation generated using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.5.3
  183. with Mako templates.
  184. </div>
  185. </div>
  186. </div>
  187. <div class="clearfix">
  188. <hr/>
  189. <div class="copyright">Website content copyright &copy; by Michael Bayer.
  190. All rights reserved. Mako and its documentation are licensed
  191. under the MIT license. mike(&)zzzcomputing.com</div>
  192. </div>
  193. </div>
  194. </body>
  195. </html>