1.1 --- a/docs/design.html Thu Oct 20 15:43:51 2005 +0000
1.2 +++ b/docs/design.html Thu Oct 20 16:00:01 2005 +0000
1.3 @@ -4,7 +4,6 @@
1.4
1.5 <title>Application Design Considerations</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
1.6 <link href="styles.css" rel="stylesheet" type="text/css" /></head>
1.7 -
1.8 <body>
1.9 <h1>Application Design Considerations</h1>
1.10 <p>When writing an application, we
1.11 @@ -15,8 +14,8 @@
1.12 <li>Perform some kind of action with the information supplied.</li>
1.13 <li>Produce some kind of response which tells the user what happened.</li>
1.14 </ol>
1.15 -<p>We briefly covered the third activity in the <code>MyApplication</code>
1.16 -example, but for a real, properly-behaved application, we need to visit
1.17 +<p>We briefly covered the third activity in the <a href="resources.html"><code>MyApplication</code>
1.18 +example</a>, but for a real, properly-behaved application, we need to visit
1.19 each activity in detail.</p>
1.20 <h2>Examine the Transaction</h2>
1.21 <p>In WebStack, the transaction is an object which is passed into a
2.1 --- a/docs/developing.html Thu Oct 20 15:43:51 2005 +0000
2.2 +++ b/docs/developing.html Thu Oct 20 16:00:01 2005 +0000
2.3 @@ -73,12 +73,9 @@
2.4
2.5 </ul>
2.6
2.7 - </ul>
2.8 -</ul>
2.9 -<p>The following topic is referenced in many locations and should
2.10 + </ul><li><a href="securing.html">Securing a WebStack Application</a></li><ul><li><a href="authenticators.html">Application-Wide Authenticators</a></li><li><a href="login-redirect.html">LoginRedirect and Login Modules</a> (<code>SimpleWithLogin</code> example, <code>Login</code> example)</li></ul><li><a href="integrating.html">Integrating with Other Systems</a></li>
2.11 +</ul><p>The following topic is referenced in many locations and should
2.12 be reviewed when encountering problems with input and output text:</p>
2.13 -<ul>
2.14 -<li><a href="encodings.html">Character Encodings</a></li>
2.15 -</ul>
2.16 -<p></p>
2.17 -</body></html>
2.18 \ No newline at end of file
2.19 +<ul><li><a href="encodings.html">Character Encodings</a></li></ul>
2.20 +<h2>Deployment</h2><p>The following topics (illustrated by the programs found in the other subdirectories of the <code>examples</code> directory) describe how WebStack applications may be deployed in server environments:</p><ul><li><a href="deploying.html">Deploying a WebStack Application</a></li><ul><li><a href="writing-adapters.html">Writing Adapters</a></li><li><a href="pythonpath.html">Getting PYTHONPATH Right</a></li><li><a href="deploying-applications.html">Deploying an Application</a></li><ul><li><a href="BaseHTTPRequestHandler/NOTES.txt">BaseHTTPRequestHandler</a> (see <code>examples/BaseHTTPRequestHandler</code>)</li><li><a href="CGI/NOTES.txt">CGI</a> (see <code>examples/CGI</code>)</li><li><a href="JavaServlet/NOTES.txt">Java Servlet</a> (see <code>examples/JavaServlet</code>)</li><li><a href="ModPython/NOTES.txt">mod_python</a> (see <code>examples/ModPython</code>)</li><li><a href="Twisted/NOTES.txt">Twisted</a> (see <code>examples/Twisted</code>)</li><li><a href="Webware/NOTES.txt">Webware</a> (see <code>examples/Webware</code>)</li><li><a href="WSGI/NOTES.txt">WSGI</a> (see <code>examples/WSGI</code>)</li><li><a href="Zope/NOTES.txt">Zope</a> (see <code>examples/Zope</code>)</li></ul></ul><li>Technical note: <a href="features.html">Support for WebStack
2.21 +Features in Server Environments</a></li></ul></body></html>
2.22 \ No newline at end of file
3.1 --- a/docs/index.html Thu Oct 20 15:43:51 2005 +0000
3.2 +++ b/docs/index.html Thu Oct 20 16:00:01 2005 +0000
3.3 @@ -33,12 +33,5 @@
3.4 and using Python's built-in <code>help</code> function.</p>
3.5 <h2>About WebStack Applications</h2>
3.6 <ul>
3.7 - <li><a href="anatomy.html">Anatomy of a WebStack Application</a></li><li><a href="developing.html">Developing a WebStack Application</a></li>
3.8 -
3.9 - <li><a href="securing.html">Securing a WebStack Application</a></li>
3.10 - <li><a href="deploying.html">Deploying a WebStack Application</a></li>
3.11 - <li><a href="integrating.html">Integrating with Other Systems</a></li>
3.12 - <li>Technical note: <a href="features.html">Support for WebStack
3.13 -Features in Server Environments</a></li>
3.14 -</ul>
3.15 + <li><a href="anatomy.html">Anatomy of a WebStack Application</a></li><li><a href="developing.html">Developing a WebStack Application</a></li></ul>
3.16 </body></html>
3.17 \ No newline at end of file
4.1 --- a/docs/methods.html Thu Oct 20 15:43:51 2005 +0000
4.2 +++ b/docs/methods.html Thu Oct 20 16:00:01 2005 +0000
4.3 @@ -1,12 +1,9 @@
4.4 -<?xml version="1.0" encoding="iso-8859-1"?>
4.5 -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4.6 - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4.7 -<html xmlns="http://www.w3.org/1999/xhtml">
4.8 -<head>
4.9 - <title>Request Methods</title>
4.10 - <meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.11 - <link href="styles.css" rel="stylesheet" type="text/css" />
4.12 -</head>
4.13 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4.14 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
4.15 +
4.16 + <title>Request Methods</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.17 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
4.18 +
4.19
4.20 <body>
4.21 <h1>Request Methods</h1>
4.22 @@ -20,9 +17,9 @@
4.23 <h2>Common Request Methods</h2>
4.24
4.25 <p>The following table summarises the most common methods defined for Web
4.26 -applications in the HTTP and WebDAV specifications:</p>
4.27 +applications in the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html">HTTP</a> and <a href="http://www.faqs.org/rfcs/rfc2518.html">WebDAV</a> specifications:</p>
4.28
4.29 -<table border="1" cellspacing="0" cellpadding="5">
4.30 +<table border="1" cellpadding="5" cellspacing="0">
4.31 <tbody>
4.32 <tr>
4.33 <th>Method</th>
4.34 @@ -87,5 +84,4 @@
4.35 <code>trans</code> as follows:</p>
4.36 <pre>trans.set_response_code(405)</pre>
4.37 </div>
4.38 -</body>
4.39 -</html>
4.40 +</body></html>
4.41 \ No newline at end of file
5.1 --- a/docs/parameters-body.html Thu Oct 20 15:43:51 2005 +0000
5.2 +++ b/docs/parameters-body.html Thu Oct 20 16:00:01 2005 +0000
5.3 @@ -3,15 +3,13 @@
5.4
5.5 <title>Request Body Parameters</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
5.6 <link href="styles.css" rel="stylesheet" type="text/css" /></head>
5.7 -
5.8 -
5.9 <body>
5.10 <h1>Request Body Parameters</h1>
5.11
5.12 <p>Request parameters are typically added to the request body when forms are
5.13 submitted by a browser which is instructed to use the <code>POST</code> <a href="methods.html">request method</a>. A Web form (in HTML) can be used to
5.14 achieve this; for example:</p>
5.15 -<pre><form method="POST" action="http://www.boddie.org.uk/application"><br /> <input name="param1" type="text" /><br /> <input name="param2" type="text" /><br /></form></pre>
5.16 +<pre><form method="post" action="http://www.boddie.org.uk/application"><br /> <input name="param1" type="text" value="value1" /><br /> <input name="param2" type="text" value="value2" /><br /></form></pre>
5.17
5.18 <p>As a consequence of this form being submitted, the following parameters
5.19 will become available in the application:</p>
6.1 --- a/docs/parameters-headers.html Thu Oct 20 15:43:51 2005 +0000
6.2 +++ b/docs/parameters-headers.html Thu Oct 20 16:00:01 2005 +0000
6.3 @@ -25,7 +25,7 @@
6.4 used to remember things as users navigate their way around an application.
6.5 Alternatively, a Web form (in HTML) written to use the <code>GET</code> <a href="methods.html">request method</a> may be used to achieve the same
6.6 effect:</p>
6.7 -<pre><form method="GET" action="http://www.boddie.org.uk/application"><br /> <input name="param1" type="text" /><br /> <input name="param2" type="text" /><br /></form></pre>
6.8 +<pre><form method="get" action="http://www.boddie.org.uk/application"><br /> <input name="param1" type="text" value="value1" /><br /> <input name="param2" type="text" value="value2" /><br /></form></pre>
6.9
6.10 <div class="WebStack">
6.11 <h3>WebStack API - Accessing Header Parameters</h3>
7.1 --- a/docs/parameters.html Thu Oct 20 15:43:51 2005 +0000
7.2 +++ b/docs/parameters.html Thu Oct 20 16:00:01 2005 +0000
7.3 @@ -3,7 +3,6 @@
7.4
7.5 <title>Request Parameters and Uploads</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
7.6 <link href="styles.css" rel="stylesheet" type="text/css" /></head>
7.7 -
7.8 <body>
7.9 <h1>Request Parameters and Uploads</h1>
7.10 <p>Even though it is possible to expose different parts of an
7.11 @@ -107,6 +106,6 @@
7.12 which describes the request body's contents.</dd>
7.13 </dl>
7.14 </div>
7.15 -<p>The purpose and behaviour of <code>PUT</code> <a href="methods.html">request methods</a> is described in the HTTP
7.16 -specification.</p>
7.17 +<p>The purpose and behaviour of <code>PUT</code> <a href="methods.html">request methods</a> is described in the <a href="http://www.w3.org/Protocols/rfc2616/rfc2616.html">HTTP
7.18 +specification</a>.</p>
7.19 </body></html>
7.20 \ No newline at end of file
8.1 --- a/docs/path-info.html Thu Oct 20 15:43:51 2005 +0000
8.2 +++ b/docs/path-info.html Thu Oct 20 16:00:01 2005 +0000
8.3 @@ -7,12 +7,11 @@
8.4 <body>
8.5 <h1>Paths To and
8.6 Within Applications</h1>
8.7 -<p>One thing to be aware of in the
8.8 -code of an application is which part
8.9 +<p>One thing to be aware of, in the
8.10 +code of an application, is which part
8.11 of
8.12 a
8.13 -path refers to the location of the application in a server environment
8.14 -and
8.15 +path refers to the location of the application in a server environment, and
8.16 which refers to some resource within the application itself. Consider
8.17 this
8.18 path:</p>
8.19 @@ -28,7 +27,7 @@
8.20 say that the path to the application is this:
8.21 </p>
8.22 <pre>/folder/application</pre>
8.23 -<p>Meanwhile, the path within the
8.24 +<p>Meanwhile, the path <span style="font-style: italic;">within</span> the
8.25 application is just this:
8.26 </p>
8.27 <pre>/resource</pre>
9.1 --- a/docs/paths-filesystem.html Thu Oct 20 15:43:51 2005 +0000
9.2 +++ b/docs/paths-filesystem.html Thu Oct 20 16:00:01 2005 +0000
9.3 @@ -1,11 +1,9 @@
9.4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
9.5 -<html xmlns="http://www.w3.org/1999/xhtml">
9.6 -<head>
9.7 - <title>Treating the Path Like a Filesystem</title>
9.8 - <meta name="generator"
9.9 - content="amaya 8.1a, see http://www.w3.org/Amaya/" />
9.10 - <link href="styles.css" rel="stylesheet" type="text/css" />
9.11 -</head>
9.12 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
9.13 +
9.14 + <title>Treating the Path Like a Filesystem</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
9.15 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
9.16 +
9.17 <body>
9.18 <h1>Treating the Path Like a
9.19 Filesystem</h1>
9.20 @@ -111,7 +109,5 @@
9.21 objects is not the only way to support such
9.22 hierarchies. We could inspect paths and act dynamically on the supplied
9.23 information, either choosing to create resources or choosing to handle
9.24 -such paths in the same resource. See <a href="path-info.html">"Paths
9.25 -To and Within Applications"</a> for some other strategies.</p>
9.26 -</body>
9.27 -</html>
9.28 +such paths in the same resource.</p>
9.29 +</body></html>
9.30 \ No newline at end of file
10.1 --- a/docs/sessions-servers.html Thu Oct 20 15:43:51 2005 +0000
10.2 +++ b/docs/sessions-servers.html Thu Oct 20 16:00:01 2005 +0000
10.3 @@ -1,26 +1,23 @@
10.4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
10.5 -<html xmlns="http://www.w3.org/1999/xhtml">
10.6 -<head>
10.7 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
10.8 <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
10.9 - <title>Server Environment Support for Sessions</title>
10.10 - <meta name="generator"
10.11 - content="amaya 8.1a, see http://www.w3.org/Amaya/" />
10.12 - <link href="styles.css" rel="stylesheet" type="text/css" />
10.13 -</head>
10.14 +
10.15 + <title>Server Environment Support for Sessions</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
10.16 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
10.17 +
10.18 <body>
10.19 <h1>Server Environment Support for Sessions</h1>
10.20 <p>Various server environments or frameworks do not support sessions
10.21 directly. In order to provide primitive support for sessions within
10.22 WebStack upon such frameworks, the <code>WebStack.Helpers.Session</code>
10.23 module is used to provide a simple file-based session store. Before
10.24 -deploying an application on one of these frameworks, it is necessary to
10.25 +deploying an application on one of these frameworks, it may be necessary to
10.26 create a directory called <code>WebStack-sessions</code> in a
10.27 particular location so that the storage of session information will
10.28 -work.</p>
10.29 +work, although WebStack will attempt to create such a directory if it does not already exist.</p>
10.30 <p>The location of the <code>WebStack-sessions</code> directory
10.31 depends on the framework as summarised below:</p>
10.32 -<table style="text-align: left; width: 80%;" align="center" border="1"
10.33 - cellpadding="5" cellspacing="0" width="80%">
10.34 +<table style="text-align: left; width: 80%;" align="center" border="1" cellpadding="5" cellspacing="0" width="80%">
10.35 <tbody>
10.36 <tr>
10.37 <th style="text-align: center;">Server Environment</th>
10.38 @@ -60,5 +57,4 @@
10.39 CVS snapshot used for testing) do not support session detection or
10.40 expiry correctly.</li>
10.41 </ul>
10.42 -</body>
10.43 -</html>
10.44 +</body></html>
10.45 \ No newline at end of file