index.html 11 KB

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