<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Routes Documentation — Routes v1.12 documentation</title> <link rel="stylesheet" href="_static/default.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '#', VERSION: '1.12', COLLAPSE_MODINDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Routes v1.12 documentation" href="_static/opensearch.xml"/> <link rel="top" title="Routes v1.12 documentation" href="index.html" /> <link rel="next" title="Introduction" href="introduction.html" /> </head> <body> <div style="color: #D1361B; font-size: 70px; font-weight: bold; padding: 10px 0 0 10px;">Routes</div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li> <li class="right" > <a href="introduction.html" title="Introduction" accesskey="N">next</a> |</li> <li><a href="index.html">Routes home</a> | </li> <li><a href="#">Documentation</a>»</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="routes-documentation"> <h1>Routes Documentation<a class="headerlink" href="#routes-documentation" title="Permalink to this headline">¶</a></h1> <ul> <li class="toctree-l1"><a class="reference external" href="introduction.html">Introduction</a></li> <li class="toctree-l1"><a class="reference external" href="setting_up.html">Setting up routes</a><ul> <li class="toctree-l2"><a class="reference external" href="setting_up.html#requirements">Requirements</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#magic-path-info">Magic path_info</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#conditions">Conditions</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#wildcard-routes">Wildcard routes</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#format-extensions">Format extensions</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#submappers">Submappers</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#submapper-helpers">Submapper helpers</a></li> <li class="toctree-l2"><a class="reference external" href="setting_up.html#adding-routes-from-a-nested-application">Adding routes from a nested application</a></li> </ul> </li> <li class="toctree-l1"><a class="reference external" href="generating.html">Generation</a><ul> <li class="toctree-l2"><a class="reference external" href="generating.html#generating-routes-based-on-the-current-url">Generating routes based on the current URL</a></li> <li class="toctree-l2"><a class="reference external" href="generating.html#generation-only-routes-aka-static-routes">Generation-only routes (aka. static routes)</a></li> <li class="toctree-l2"><a class="reference external" href="generating.html#filter-functions">Filter functions</a></li> <li class="toctree-l2"><a class="reference external" href="generating.html#generating-urls-with-subdomains">Generating URLs with subdomains</a></li> </ul> </li> <li class="toctree-l1"><a class="reference external" href="restful.html">RESTful services</a><ul> <li class="toctree-l2"><a class="reference external" href="restful.html#resource-options">Resource options</a></li> </ul> </li> <li class="toctree-l1"><a class="reference external" href="uni_redirect_rest.html">Unicode, Redirects, and More</a><ul> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#unicode">Unicode</a></li> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#redirect-routes">Redirect Routes</a></li> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#printing">Printing</a></li> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#introspection">Introspection</a></li> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#other">Other</a></li> <li class="toctree-l2"><a class="reference external" href="uni_redirect_rest.html#backward-compatibility">Backward compatibility</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference external" href="glossary.html">Glossary</a></li> <li class="toctree-l1"><a class="reference external" href="porting.html">Porting Routes to a WSGI Web Framework</a></li> </ul> </div> <div class="section" id="indices-and-tables"> <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1> <ul class="simple"> <li><a class="reference external" href="genindex.html"><em>Index</em></a></li> <li><a class="reference external" href="modindex.html"><em>Module Index</em></a></li> <li><a class="reference external" href="search.html"><em>Search Page</em></a></li> <li><a class="reference external" href="glossary.html#glossary"><em>Glossary</em></a></li> </ul> <div class="section" id="module-listing"> <h2>Module Listing<a class="headerlink" href="#module-listing" title="Permalink to this headline">¶</a></h2> <ul> <li class="toctree-l1"><a class="reference external" href="modules/index.html">Routes Modules</a><ul> <li class="toctree-l2"><a class="reference external" href="modules/routes.html"><tt class="docutils literal"><span class="pre">routes</span></tt> – Routes Common Classes and Functions</a></li> <li class="toctree-l2"><a class="reference external" href="modules/mapper.html"><tt class="docutils literal"><span class="pre">routes.mapper</span></tt> – Mapper and Sub-Mapper</a></li> <li class="toctree-l2"><a class="reference external" href="modules/route.html"><tt class="docutils literal"><span class="pre">routes.route</span></tt> – Route</a></li> <li class="toctree-l2"><a class="reference external" href="modules/middleware.html"><tt class="docutils literal"><span class="pre">routes.middleware</span></tt> – Routes WSGI Middleware</a></li> <li class="toctree-l2"><a class="reference external" href="modules/lru.html"><tt class="docutils literal"><span class="pre">routes.lru</span></tt> – LRU caching class and decorator</a></li> <li class="toctree-l2"><a class="reference external" href="modules/util.html"><tt class="docutils literal"><span class="pre">routes.util</span></tt> – URL Generator and utility functions</a></li> </ul> </li> </ul> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h3><a href="#">Table Of Contents</a></h3> <ul> <li><a class="reference external" href="#">Routes Documentation</a><ul> </ul> </li> <li><a class="reference external" href="#indices-and-tables">Indices and tables</a><ul> <li><a class="reference external" href="#module-listing">Module Listing</a><ul> </ul> </li> </ul> </li> </ul> <h4>Next topic</h4> <p class="topless"><a href="introduction.html" title="next chapter">Introduction</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="_sources/contents.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="search.html" method="get"> <input type="text" name="q" size="18" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="modindex.html" title="Global Module Index" >modules</a> |</li> <li class="right" > <a href="introduction.html" title="Introduction" >next</a> |</li> <li><a href="index.html">Routes home</a> | </li> <li><a href="#">Documentation</a>»</li> </ul> </div> <div class="footer"> © Copyright 2010, Ben Bangert, Mike Orr. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.4. </div> </body> </html>