1.1 --- a/docs/developing.html Sun Nov 20 23:37:12 2005 +0000
1.2 +++ b/docs/developing.html Sun Nov 20 23:37:51 2005 +0000
1.3 @@ -28,7 +28,7 @@
1.4
1.5 <ul>
1.6
1.7 - <li><a href="paths-filesystem.html">Treating the Path Like a Filesystem</a> (<code>DemoApp</code> example, <code>Calendar</code> example)</li>
1.8 + <li><a href="paths-filesystem.html">Treating the Path Like a Filesystem</a> (<code>DemoApp</code> example, <code>Calendar</code> example)</li><ul><li>(<a href="resource-map.html">ResourceMap - Simple Mappings from Names to Resources</a>)</li></ul>
1.9 <li><a href="paths-services.html">Treating the Path Mostly Like a Filesystem</a></li>
1.10 <li><a href="paths-opaque.html">Using the Path as an Opaque Reference into an Application</a></li>
1.11
1.12 @@ -64,7 +64,7 @@
1.13
1.14 <li><a href="sessions-usage.html">Using Sessions</a> (<code>Sessions</code> example)</li>
1.15
1.16 - <li><a href="sessions-servers.html">Server Environment Support for Sessions</a></li>
1.17 + <li><a href="sessions-servers.html">Server Environment Support for Sessions</a></li><li>(<a href="directory-repository.html">DirectoryRepository - Simple Access to Files in a Directory</a>)</li>
1.18
1.19
1.20
2.1 --- a/docs/encodings.html Sun Nov 20 23:37:12 2005 +0000
2.2 +++ b/docs/encodings.html Sun Nov 20 23:37:51 2005 +0000
2.3 @@ -13,7 +13,7 @@
2.4 <li><a href="responses.html">Sending output in a response</a></li>
2.5 <li><a href="parameters.html">Receiving uploaded content</a></li>
2.6 <li><a href="state.html">Accessing cookie information</a></li>
2.7 - <li><a href="sessions.html">Accessing session information</a></li>
2.8 + <li><a href="sessions.html">Accessing session information</a> (see the <a href="sessions-usage.html#Limitations">"Session Limitations and Guidelines"</a>)</li>
2.9 </ul>
2.10 <p>When Web pages (and other types of content) are sent to and from
2.11 users of your application, the text will be in some kind of character
3.1 --- a/docs/path-manipulation.html Sun Nov 20 23:37:12 2005 +0000
3.2 +++ b/docs/path-manipulation.html Sun Nov 20 23:37:51 2005 +0000
3.3 @@ -10,4 +10,4 @@
3.4 processing of a resource has progressed, it is sometimes useful to
3.5 apply some kind of transformation to the path in order to produce a
3.6 reference to another resource or application. Consider the simple case
3.7 -of <a href="redirection.html">redirecting</a> a user to another resource:</p><p>First we must obtain a reference to the current resource:<br /></p><pre>this_resource = trans.get_path_without_query() # eg. "/app/resource/some-data"</pre><p>We may wish to redirect the user to the main application resource; this is done by removing <code>resource</code> from the end of the path:</p><pre>this_app = trans.update_path("..") # produces "/app/resource"</pre><p>A complete description of this method can be found in the API documentation.</p></body></html>
3.8 \ No newline at end of file
3.9 +of <a href="redirection.html">redirecting</a> a user to another resource:</p><p>First we must obtain a reference to the current resource:<br /></p><pre>this_resource = trans.get_path_without_query() # eg. "/app/resource/some-data"</pre><p>We may wish to redirect the user to the main application resource; this is done by removing <code>resource</code> from the end of the path:</p><pre>this_app = trans.update_path("..") # produces "/app/resource"</pre><p>A complete description of this method can be found in the <a href="../apidocs/public/WebStack.Generic.Transaction-class.html#update_path">API documentation</a>.</p></body></html>
3.10 \ No newline at end of file
4.1 --- a/docs/paths-filesystem.html Sun Nov 20 23:37:12 2005 +0000
4.2 +++ b/docs/paths-filesystem.html Sun Nov 20 23:37:51 2005 +0000
4.3 @@ -3,7 +3,6 @@
4.4
4.5 <title>Treating the Path Like a Filesystem</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.6 <link href="styles.css" rel="stylesheet" type="text/css" /></head>
4.7 -
4.8 <body>
4.9 <h1>Treating the Path Like a
4.10 Filesystem</h1>
4.11 @@ -96,11 +95,10 @@
4.12 <div class="WebStack">
4.13 <h3>WebStack API - Predefining
4.14 Resource Hierarchies in Adapter Code</h3>
4.15 -<p>WebStack provides a resource
4.16 -class for convenient mapping of path
4.17 -components (ie. names) to resource objects:
4.18 -<code>WebStack.Resources.ResourceMap.MapResource</code></p>
4.19 -<p>This class can be used in <a href="deploying.html">adapter code</a>
4.20 +
4.21 +<p>WebStack provides the <code>MapResource</code>
4.22 +class (in the <code>WebStack.Resources.ResourceMap</code> module) for convenient mapping of path
4.23 +components to resource objects<code></code>. See the <a href="resource-map.html">"ResourceMap - Simple Mappings from Names to Resources"</a> document for a more detailed description of the <code>MapResource</code> class.</p><p>This class can be used in <a href="deploying.html">adapter code</a>
4.24 to initialise an
4.25 application as follows:</p>
4.26 <pre>from WebStack.Resources.ResourceMap import MapResource<br />from MyApplication import FileResource # import some resource class<br /><br />article_resource = FileResource(...) # make a resource representing the article<br />document_resource = FileResource(...) # make a resource representing the document<br />year_2004_resource = MapResource({"document.html" : document_resource})<br />year_2005_resource = MapResource({"article.html" : article_resource})<br />news_resource = MapResource({"2005" : year_2005_resource, "2004" : year_2004_resource})<br />documents_resource = MapResource({"news" : news_resource})<br />top_resource = MapResource({"documents" : documents_resource})</pre>
5.1 --- a/docs/redirection.html Sun Nov 20 23:37:12 2005 +0000
5.2 +++ b/docs/redirection.html Sun Nov 20 23:37:51 2005 +0000
5.3 @@ -4,7 +4,6 @@
5.4
5.5 <title>Redirection</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 <body>
5.9 <h1>Redirection</h1><p>Instead of presenting information to a user when
5.10 that user visits a particular URL, we may instead choose to redirect
5.11 @@ -12,7 +11,7 @@
5.12 viewed. To redirect a user of an application, we can use the following
5.13 transaction method:</p><div class="WebStack">
5.14 <h3>WebStack API - Redirection</h3>
5.15 -<p>WebStack provides the following method to perform redirection:</p>
5.16 +<p>WebStack provides the following method in transaction objects to perform redirection:</p>
5.17 <dl><dt><code>redirect</code></dt><dd>This method accepts a path value
5.18 suitable for use in response headers indicating the location to which a
5.19 user shall be redirected. An optional response code (see <a href="responses.html">"Responses and Presentation"</a>) can be specified to modify the meaning of the redirection (as defined in the HTTP specifications).</dd></dl></div><p>Since the path value must be usable in response header, it is necessary to transform paths as described in the <a href="path-value-encoding.html">"Encoding and Decoding Path Values"</a> document, and an example of redirection is given in that document.</p></body></html>
5.20 \ No newline at end of file
6.1 --- a/docs/sessions-usage.html Sun Nov 20 23:37:12 2005 +0000
6.2 +++ b/docs/sessions-usage.html Sun Nov 20 23:37:51 2005 +0000
6.3 @@ -4,7 +4,6 @@
6.4
6.5 <title>Using Sessions</title><meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
6.6 <link href="styles.css" rel="stylesheet" type="text/css" /></head>
6.7 -
6.8 <body>
6.9 <h1>Using Sessions</h1>
6.10 <p>Unlike cookies, session information is always stored on the server
6.11 @@ -63,7 +62,7 @@
6.12 <pre> # In the respond method...<br /> trans.expire_session()</pre>
6.13 <p>Note that WebStack automatically knows which session is to be
6.14 expired since only one such session can exist for the identified user.</p>
6.15 -<h2>Session Limitations and Guidelines</h2>
6.16 +<h2><a name="Limitations"></a>Session Limitations and Guidelines</h2>
6.17 <ul>
6.18 <li>Due to various limitations in the storage of session information,
6.19 it is recommended that each item of data is converted to a string value