|
2
|
1 <!DOCTYPE html>
|
|
|
2 <html>
|
|
|
3 <head>
|
|
|
4 <meta http-equiv="content-type" content="text/html; charset=UTF-8">
|
|
|
5 <title>.pspx Template Files</title>
|
|
|
6 <style type="text/css">
|
|
|
7 .kbd { font-family: monospace; }
|
|
|
8 </style>
|
|
|
9 </head>
|
|
|
10 <body>
|
|
|
11 <h1>.pspx Template Files</h1>
|
|
|
12 <h2>Introduction</h2>
|
|
|
13 Files ending in a <span class="kbd">.pspx</span> extension define both
|
|
|
14 routes and templates. The files have two parts: a header and a body.<br>
|
|
|
15 <h2>The Header</h2>
|
|
|
16 <p>The header is optional and consists of lines starting with an octothorpe
|
|
|
17 (#) character. With the exception of the <code>#rem </code>header, all
|
|
|
18 header lines may appear only once in a given file.</p>
|
|
|
19 <dl>
|
|
|
20 <dt><code>#errors</code></dt>
|
|
3
|
21 <dd>Ignore other headers and make this is an error page which handles
|
|
|
22 the specified HTTP error codes. See the subsection on error pages below.
|
|
|
23 </dd>
|
|
2
|
24 <dt><code>#forward</code></dt>
|
|
|
25 <dd>Ignore everything else in this template (and any code-behind
|
|
|
26 associated with it), using the specified route to serve it instead. The
|
|
|
27 route specified with <code>#forward</code> may itself contain a <code>#forward</code>,
|
|
|
28 but attempts to create a <code>#forward</code> loop are not allowed and
|
|
|
29 will cause a <span class="kbd">TinCanError</span> to be raised. Note
|
|
|
30 that unlike calls to <code>app.forward()</code>, the <code>#forward</code>
|
|
|
31 header is resolved at route-creation time; no extra processing will
|
|
|
32 happen at request time.</dd>
|
|
|
33 <dt><code>#hidden</code></dt>
|
|
|
34 <dd>This is a hidden page; do not create a route for it. The page can only
|
|
|
35 be displayed by a forward.</dd>
|
|
|
36 <dt><code>#methods</code></dt>
|
|
|
37 <dd>A list of HTTP request methods, separated by whitespace, follows. The route will
|
|
|
38 allow all specified methods. Not specifying this line is equivalent to
|
|
|
39 specifying <code>#methods GET</code>.</dd>
|
|
|
40 <dt><code>#python</code></dt>
|
|
|
41 <dd>What follows is the name of the Python file containing the code-behind
|
|
|
42 for this route. If not specified, the code-behind will be in a file with
|
|
|
43 the same name but an extension of <span class="kbd">.py</span>.</dd>
|
|
|
44 <dt><code>#rem</code></dt>
|
|
|
45 <dd>The rest of the line is treated as a remark (comment) and is ignored.</dd>
|
|
|
46 <dt><code>#template</code></dt>
|
|
|
47 <dd>Ignore the body of this file and instead use the template in the body
|
|
3
|
48 of the specified file, which must end in <span class="kbd">.pspx</span>.
|
|
|
49 Any headers in the referred template file are ignored.</dd>
|
|
2
|
50 </dl>
|
|
|
51 <p>It is possible to include whitespace and special characters in arguments
|
|
|
52 to the <code>#forward</code>, <code>#python</code>, and <code>#template</code>
|
|
|
53 headers by using standard Python string quoting and escaping methods. For
|
|
|
54 example, <code>#python "space case.py"</code>.</p>
|
|
|
55 <h3>Error Pages</h3>
|
|
|
56 <p>Error pages supersede the standard Bottle error handling, and are created
|
|
3
|
57 by using the <code>#errors</code> page header. <em>Error pages have no
|
|
2
|
58 associated code-behind;</em> they consist of templates only. Error page
|
|
|
59 templates are provided with two variables when rendering:</p>
|
|
|
60 <dl>
|
|
|
61 <dt><code>e</code></dt>
|
|
|
62 <dd>The <code>bottle.HTTPError</code> object associated with this error.</dd>
|
|
|
63 <dt><code>request</code></dt>
|
|
|
64 <dd>The <code>bottle.Request</code> object associated with this error.</dd>
|
|
|
65 </dl>
|
|
3
|
66 <p>The <code>#errors</code> directive takes a list of numeric error codes
|
|
|
67 (values from 400 to 599 are allowed); the page is created to handle the
|
|
|
68 specified errors. If no error codes are specified, the page will handle all
|
|
|
69 errors. The behavior of specifying multiple error pages for the same error code
|
|
2
|
70 is undefined; doing so is best avoided.</p>
|
|
|
71 <h2>The Body</h2>
|
|
|
72 <p>The body begins with the first line that <em>does not</em> start with <code>#</code>
|
|
|
73 and has the exact same syntax that the templates are in for this webapp.
|
|
|
74 By default, Chameleon templates are used. Cheetah, Jinja2, Mako, and
|
|
|
75 Bottle SimpleTemplate templates are also supported, provided the webapp
|
|
|
76 was launched to use them. (Only one template style per webapp is
|
|
|
77 supported.)</p>
|
|
|
78 <p>In order to make line numbers match file line numbers for reported
|
|
|
79 errors, the template engine will be passed a blank line for each header
|
|
|
80 line encountered. TinCan will strip out all leading blank lines when
|
|
|
81 rendering its responses.</p>
|
|
|
82 </body>
|
|
|
83 </html>
|
