1.1 --- a/docs/deploying-applications.html Sun Jan 15 23:20:51 2006 +0000
1.2 +++ b/docs/deploying-applications.html Sun Jan 15 23:21:19 2006 +0000
1.3 @@ -1,12 +1,9 @@
1.4 -<?xml version="1.0" encoding="iso-8859-1"?>
1.5 -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
1.6 - "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.7 -<html xmlns="http://www.w3.org/1999/xhtml">
1.8 -<head>
1.9 - <title>Deploying an Application</title>
1.10 - <meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
1.11 - <link href="styles.css" rel="stylesheet" type="text/css" />
1.12 -</head>
1.13 +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.14 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
1.15 +
1.16 + <title>Deploying an Application</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
1.17 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
1.18 +
1.19
1.20 <body>
1.21 <h1>Deploying an Application</h1>
1.22 @@ -14,7 +11,7 @@
1.23 <p>Here is a table which summarises the steps required to actually deploy
1.24 your application in the different server environments or frameworks:</p>
1.25
1.26 -<table border="1" cellspacing="0" cellpadding="5">
1.27 +<table border="1" cellpadding="5" cellspacing="0">
1.28 <tbody>
1.29 <tr>
1.30 <th>Framework</th>
1.31 @@ -30,7 +27,7 @@
1.32 Deploy application code in the specified script directory<br />
1.33 Restart the Web server</td>
1.34 </tr>
1.35 - <tr>
1.36 + <tr><td align="undefined" valign="undefined">Django</td><td align="undefined" valign="undefined">Set up an instance and application in the Django environment<br />Deploy application code in the specified application directory</td></tr><tr>
1.37 <td>Java Servlet</td>
1.38 <td>Use the supplied script in <code>tools/JavaServlet</code> and
1.39 follow your servlet container's instructions</td>
1.40 @@ -73,9 +70,8 @@
1.41 <p>Notes on each server environment can be found in subdirectories within the
1.42 <code>docs</code> directory:</p>
1.43 <ul>
1.44 - <li><a
1.45 - href="BaseHTTPRequestHandler/NOTES.txt">BaseHTTPRequestHandler</a></li>
1.46 - <li><a href="CGI/NOTES.txt">CGI</a></li>
1.47 + <li><a href="BaseHTTPRequestHandler/NOTES.txt">BaseHTTPRequestHandler</a></li>
1.48 + <li><a href="CGI/NOTES.txt">CGI</a></li><li><a href="Django/NOTES.txt">Django</a></li>
1.49 <li><a href="JavaServlet/NOTES.txt">Java Servlet</a></li>
1.50 <li><a href="ModPython/NOTES.txt">mod_python</a></li>
1.51 <li><a href="Twisted/NOTES.txt">Twisted</a></li>
1.52 @@ -83,5 +79,4 @@
1.53 <li><a href="WSGI/NOTES.txt">WSGI</a></li>
1.54 <li><a href="Zope/NOTES.txt">Zope</a></li>
1.55 </ul>
1.56 -</body>
1.57 -</html>
1.58 +</body></html>
1.59 \ No newline at end of file
2.1 --- a/docs/developing.html Sun Jan 15 23:20:51 2006 +0000
2.2 +++ b/docs/developing.html Sun Jan 15 23:21:19 2006 +0000
2.3 @@ -77,7 +77,7 @@
2.4 </ul><p>The following topic is referenced in many locations and should
2.5 be reviewed when encountering problems with input and output text:</p>
2.6 <ul><li><a href="encodings.html">Character Encodings</a></li></ul>
2.7 -<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.8 +<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="Django/NOTES.txt">Django</a> (see <code>examples/Django</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.9 Features in Server Environments</a></li></ul><h2>Useful Additions</h2><p>WebStack
2.10 provides a number of potentially useful modules either providing
2.11 resource classes for direct use in applications, or providing other
3.1 --- a/docs/features.html Sun Jan 15 23:20:51 2006 +0000
3.2 +++ b/docs/features.html Sun Jan 15 23:21:19 2006 +0000
3.3 @@ -1,26 +1,23 @@
3.4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3.5 -<html xmlns="http://www.w3.org/1999/xhtml">
3.6 -<head>
3.7 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
3.8 <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
3.9 - <title>Support for WebStack Features in Server Environments</title>
3.10 - <meta name="generator"
3.11 - content="amaya 8.1a, see http://www.w3.org/Amaya/" />
3.12 - <link href="styles.css" rel="stylesheet" type="text/css" />
3.13 -</head>
3.14 +
3.15 + <title>Support for WebStack Features in Server Environments</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
3.16 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
3.17 +
3.18 <body>
3.19 <h1>Support for WebStack Features in Server Environments</h1>
3.20 <p>Some basic features of Web applications are not supported by all
3.21 server environments or frameworks. The table below summarises the
3.22 implementation details of such features when applications are deployed
3.23 in each server environment.</p>
3.24 -<table align="center" border="1" cellpadding="5" cellspacing="0"
3.25 - width="80%">
3.26 +<table align="center" border="1" cellpadding="5" cellspacing="0" width="80%">
3.27 <tbody>
3.28 <tr>
3.29 <td></td>
3.30 <th>BaseHTTPRequestHandler</th>
3.31 <th>CGI</th>
3.32 - <th>mod_python</th>
3.33 + <th>Django</th><th>mod_python</th>
3.34 <th>Java Servlet API</th>
3.35 <th>Twisted</th>
3.36 <th>Webware</th>
3.37 @@ -31,7 +28,7 @@
3.38 <th>Unicode response writing</th>
3.39 <td>WebStack</td>
3.40 <td>WebStack</td>
3.41 - <td>WebStack</td>
3.42 + <td align="undefined" valign="undefined">WebStack</td><td>WebStack</td>
3.43 <td>Framework</td>
3.44 <td>WebStack</td>
3.45 <td>WebStack</td>
3.46 @@ -42,7 +39,7 @@
3.47 <th>Cookies</th>
3.48 <td>WebStack [1]</td>
3.49 <td>WebStack [1]</td>
3.50 - <td>Framework [2]</td>
3.51 + <td align="undefined" valign="undefined">Framework [3]</td><td>Framework [2]</td>
3.52 <td>Framework [3]</td>
3.53 <td>Framework [3]</td>
3.54 <td>Framework [3]</td>
3.55 @@ -53,7 +50,7 @@
3.56 <th>Sessions</th>
3.57 <td>WebStack</td>
3.58 <td>WebStack</td>
3.59 - <td>Framework [4]</td>
3.60 + <td align="undefined" valign="undefined">Framework</td><td>Framework [4]</td>
3.61 <td>Framework</td>
3.62 <td>WebStack</td>
3.63 <td>Framework</td>
3.64 @@ -71,5 +68,4 @@
3.65 on certain frameworks.</li>
3.66 <li>Some mod_python releases do not provide session support directly.</li>
3.67 </ol>
3.68 -</body>
3.69 -</html>
3.70 +</body></html>
3.71 \ No newline at end of file
4.1 --- a/docs/writing-adapters.html Sun Jan 15 23:20:51 2006 +0000
4.2 +++ b/docs/writing-adapters.html Sun Jan 15 23:21:19 2006 +0000
4.3 @@ -1,11 +1,8 @@
4.4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4.5 -<html xmlns="http://www.w3.org/1999/xhtml">
4.6 -<head>
4.7 - <title>Writing Adapters</title>
4.8 - <meta name="generator"
4.9 - content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.10 - <link href="styles.css" rel="stylesheet" type="text/css" />
4.11 -</head>
4.12 +<html xmlns="http://www.w3.org/1999/xhtml"><head>
4.13 +
4.14 + <title>Writing Adapters</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.15 + <link href="styles.css" rel="stylesheet" type="text/css" /></head>
4.16 <body>
4.17 <h1>Writing Adapters</h1>
4.18 <p>Depending on how "simple" the
4.19 @@ -22,37 +19,37 @@
4.20 <p>When deploying an application,
4.21 it is possible to use a one-shot
4.22 deployment
4.23 -function for BaseHTTPRequestServer, CGI, Twisted and WSGI. The
4.24 +function for BaseHTTPRequestServer, CGI, Django, Java Servlet, mod_python, Twisted and WSGI configurations. The
4.25 <code>deploy</code>
4.26 function is called as follows:</p>
4.27 <pre>deploy(resource)<br />deploy(resource, authenticator) # where authenticators are used</pre>
4.28 <p>For some frameworks, an address
4.29 may be specified:</p>
4.30 <pre>deploy(resource, address=(host_string, port_integer))<br />deploy(resource, authenticator, address=(host_string, port_integer))</pre>
4.31 -<p>Here is a summary of which
4.32 -frameworks require address information:</p>
4.33 +<p>And for some frameworks, the return value of the function is important:</p><pre>something = deploy(resource)<br />something, something_else = deploy(resource, authenticator)</pre><p>Here is a summary of which
4.34 +frameworks require address information and which produce important return values from the <code>deploy</code> function:</p>
4.35 <table border="1" cellpadding="5" cellspacing="0">
4.36 <tbody>
4.37 <tr>
4.38 <th>Framework</th>
4.39 - <th>Address Information</th>
4.40 + <th>Address Information</th><th>Return Values</th>
4.41 </tr>
4.42 <tr>
4.43 <td>BaseHTTPRequestHandler</td>
4.44 - <td>Supported</td>
4.45 + <td>Supported</td><td align="undefined" valign="undefined"></td>
4.46 </tr>
4.47 <tr>
4.48 <td>CGI</td>
4.49 - <td>Ignored</td>
4.50 + <td>Ignored</td><td align="undefined" valign="undefined"></td>
4.51 </tr>
4.52 - <tr>
4.53 + <tr><td align="undefined" valign="undefined">Django</td><td align="undefined" valign="undefined">Ignored</td><td align="undefined" valign="undefined">Handler function</td></tr><tr><td align="undefined" valign="undefined">Java Servlet</td><td align="undefined" valign="undefined">Ignored</td><td align="undefined" valign="undefined">Servlet class</td></tr><tr><td align="undefined" valign="undefined">mod_python</td><td align="undefined" valign="undefined">Ignored</td><td align="undefined" valign="undefined">Handler function and authenticator function (a 2-tuple)</td></tr><tr>
4.54 <td>Twisted</td>
4.55 <td>Supported (<code>host_string</code>
4.56 -is ignored)</td>
4.57 +is ignored)</td><td align="undefined" valign="undefined"></td>
4.58 </tr>
4.59 - <tr>
4.60 + <tr><td align="undefined" valign="undefined">Webware (> 0.8.1)</td><td align="undefined" valign="undefined">Ignored</td><td align="undefined" valign="undefined">URL context object</td></tr><tr>
4.61 <td>WSGI</td>
4.62 - <td>Ignored</td>
4.63 + <td>Ignored</td><td align="undefined" valign="undefined"></td>
4.64 </tr>
4.65 </tbody>
4.66 </table>
4.67 @@ -103,19 +100,15 @@
4.68 <td>Web server runs the
4.69 adapter code</td>
4.70 </tr>
4.71 - <tr>
4.72 + <tr><td align="undefined" valign="undefined">Django</td><td align="undefined" valign="undefined">Simple - see above</td><td align="undefined" valign="undefined">The adapter prepares the handler function</td></tr><tr>
4.73 <td>Java Servlet</td>
4.74 - <td>Must subclass <code>HttpServlet</code></td>
4.75 - <td>Application must be
4.76 -deployed using supplied tools</td>
4.77 + <td><span style="font-family: monospace;"></span><code></code>Simple - see above</td>
4.78 + <td>The adapter prepares the servlet class</td>
4.79 </tr>
4.80 <tr>
4.81 <td>mod_python</td>
4.82 - <td>Must implement <code>handler</code>
4.83 -function</td>
4.84 - <td>Web server runs the
4.85 -adapter code (which must be declared
4.86 -within Apache)</td>
4.87 + <td><span style="font-family: monospace;"></span><code></code>Simple - see above</td>
4.88 + <td>The adapter prepares the handler function</td>
4.89 </tr>
4.90 <tr>
4.91 <td>Twisted</td>
4.92 @@ -128,8 +121,7 @@
4.93 <td><= 0.8.1: Must
4.94 implement <code>InstallInWebKit</code>
4.95 function<br />
4.96 -> 0.8.1: Simple, but must provide a <code>urlParser</code>
4.97 -object</td>
4.98 +> 0.8.1: Simple - see above</td>
4.99 <td>Application must be
4.100 deployed within WebKit</td>
4.101 </tr>
4.102 @@ -151,5 +143,4 @@
4.103 <p>See <a href="deploying-applications.html">"Deploying an
4.104 Application"</a>
4.105 for more details of the deployment process for each environment.</p>
4.106 -</body>
4.107 -</html>
4.108 +</body></html>
4.109 \ No newline at end of file