1.1 --- a/docs/directory.html Mon Jul 18 16:43:02 2005 +0000
1.2 +++ b/docs/directory.html Mon Jul 18 22:31:18 2005 +0000
1.3 @@ -1,46 +1,91 @@
1.4 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
1.5 <html xmlns="http://www.w3.org/1999/xhtml">
1.6 <head>
1.7 +
1.8 +
1.9 +
1.10 +
1.11 <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
1.12 +
1.13 +
1.14 +
1.15 +
1.16 +
1.17 +
1.18 <title>Creating Applications: Create a Directory</title>
1.19 - <meta name="generator"
1.20 - content="amaya 8.1a, see http://www.w3.org/Amaya/" />
1.21 + <meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
1.22 +
1.23 +
1.24 +
1.25 +
1.26 <link href="styles.css" rel="stylesheet" type="text/css" />
1.27 </head>
1.28 +
1.29 +
1.30 <body>
1.31 +
1.32 +
1.33 <h1>Creating Applications: Create a Directory</h1>
1.34 +
1.35 +
1.36 <p>The recommended directory structure of an XSLForms application is as
1.37 follows:</p>
1.38 -<ul>
1.39 - <li>A top-level directory corresponding to a Python package,
1.40 -containing...<br />
1.41 - <ul>
1.42 - <li>An <code>__init__.py</code> file and other source files,
1.43 -containing the <a href="Web-resource.html">Web resources</a> and other
1.44 -application logic.</li>
1.45 - <li>A subdirectory containing non-code resources for the
1.46 -application.</li>
1.47 - <li>Other package directories, if necessary.</li>
1.48 - </ul>
1.49 - </li>
1.50 -</ul>
1.51 -<p>For example, we might create a directory structure like this:</p>
1.52 -<ul>
1.53 - <li>A top-level directory called <code>Configurator</code>,
1.54 -containing...<br />
1.55 - <ul>
1.56 - <li>An <code>__init__.py</code> file containing the Web
1.57 -resources and other application logic.</li>
1.58 - <li>A subdirectory called <code>Resources</code> containing
1.59 -non-code resources.</li>
1.60 - </ul>
1.61 - </li>
1.62 -</ul>
1.63 -<p>In UNIX-style commands, this would be done as follows:</p>
1.64 +
1.65 +<table style="text-align: left; width: 80%;" align="center" border="0" cellpadding="5" cellspacing="0" width="60%">
1.66 +
1.67 + <tbody>
1.68 +
1.69 + <tr>
1.70 +
1.71 + <td width="60%"></td>
1.72 +
1.73 + <th style="text-align: left;" colspan="2" width="40%">Example Directory Structure<br />
1.74 +
1.75 + </th>
1.76 +
1.77 +
1.78 + </tr>
1.79 +
1.80 + <tr>
1.81 +
1.82 + <th style="text-align: right;">A top-level directory corresponding to a Python package</th>
1.83 +
1.84 + <td style="background-color: rgb(204, 204, 255); border-top-style: solid; border-left-style: solid; border-right-style: solid; border-right-width: 1px; border-left-width: 1px; border-top-width: 1px;" align="undefined" valign="undefined"><span style="font-weight: bold;">Configurator</span><br />
1.85 +__init__.py</td>
1.86 +
1.87 + <td align="undefined" valign="undefined"></td>
1.88 +
1.89 + </tr>
1.90 +
1.91 +
1.92 + <tr>
1.93 +
1.94 + <th style="text-align: right;">A subdirectory containing non-code resources for the
1.95 +application</th>
1.96 +
1.97 + <td style="background-color: rgb(204, 204, 255); border-left-style: solid; border-right-style: solid; border-bottom-style: solid; border-left-width: 1px; border-right-width: 1px; border-bottom-width: 1px;" align="undefined" valign="undefined"><br />
1.98 +
1.99 + </td>
1.100 +
1.101 + <td><span class="subdirectory"><span style="font-weight: bold;">Resources</span><br />
1.102 +
1.103 +...</span></td>
1.104 +
1.105 + </tr>
1.106 +
1.107 +
1.108 + </tbody>
1.109 +</table>
1.110 +<p>For the above example, the directory structure would be created using UNIX-style commands as follows:</p>
1.111 +
1.112 +
1.113 <pre>mkdir Configurator<br />mkdir Configurator/Resources<br />touch Configurator/__init__.py</pre>
1.114 +
1.115 +
1.116 <p>It is in the <code>Resources</code> subdirectory that we will save
1.117 our template files when <a href="design.html">designing</a> them as
1.118 -part of the next activity in the application development <a
1.119 - href="overview.html">process</a>.</p>
1.120 +part of the next activity in the application development <a href="overview.html">process</a>.</p>
1.121 +
1.122 +
1.123 </body>
1.124 </html>
2.1 --- a/docs/index.html Mon Jul 18 16:43:02 2005 +0000
2.2 +++ b/docs/index.html Mon Jul 18 22:31:18 2005 +0000
2.3 @@ -2,14 +2,21 @@
2.4 <html xmlns="http://www.w3.org/1999/xhtml">
2.5 <head>
2.6
2.7 +
2.8 +
2.9
2.10 <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
2.11
2.12 +
2.13 +
2.14 +
2.15
2.16
2.17 <title>Developing Web Applications with XSLTools</title>
2.18 <meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
2.19
2.20 +
2.21 +
2.22
2.23 <link href="styles.css" rel="stylesheet" type="text/css" />
2.24 </head>
2.25 @@ -17,17 +24,22 @@
2.26
2.27 <body>
2.28
2.29 +
2.30 <h1>Developing Web Applications with XSLTools</h1>
2.31
2.32 +
2.33 <p>This documentation introduces the XSLTools package and the XSLForms
2.34 framework for developing forms-based Web applications using Python, <a href="http://www.boddie.org.uk/python/libxml2dom.html">libxml2dom</a>,
2.35 libxml2, libxslt and (optionally) <a href="http://www.boddie.org.uk/python/WebStack.html">WebStack</a>.</p>
2.36
2.37 +
2.38 <h2>Setting Up</h2>
2.39
2.40 +
2.41 <p>First of all, let us assume that the XSLTools distribution has been
2.42 unpacked and now sits in the <code>XSLTools-0.1</code> directory.</p>
2.43
2.44 +
2.45 <p>Before we begin, we must make sure that the XSLTools package is
2.46 available
2.47 to Python. The easiest way to do this is to change into the <code>XSLTools-0.1</code>
2.48 @@ -35,8 +47,10 @@
2.49 script provided with the version of Python you are going to be using
2.50 (possibly as a privileged user like <code>root</code>):</p>
2.51
2.52 +
2.53 <pre>cd XSLTools-0.1<br />python setup.py install</pre>
2.54
2.55 +
2.56 <p>If you don't want to install XSLTools in this way, or if you can't
2.57 do so
2.58 because you don't have <code>root</code> privileges, you can just make
2.59 @@ -44,8 +58,10 @@
2.60 that the <code>XSLTools-0.1</code> directory sits on your
2.61 <code>PYTHONPATH</code>.</p>
2.62
2.63 +
2.64 <h2>Viewing the API Documentation</h2>
2.65
2.66 +
2.67 <p>The API documentation for use in conjunction with this
2.68 guide can be found inside the <a href="../apidocs/index.html"><code>apidocs</code></a>
2.69 directory within the <code>XSLTools-0.1</code> directory. Of course,
2.70 @@ -53,14 +69,21 @@
2.71 within Python by importing modules (such as <a href="../apidocs/public/XSLOutput-module.html"><code>XSLOutput</code></a>)
2.72 and using Python's built-in <code>help</code> function.</p>
2.73
2.74 +
2.75 <h2>About XSLForms Applications</h2>
2.76
2.77 +
2.78 <ul>
2.79
2.80 +
2.81 + <li><a href="what.html">What are XSLTools and XSLForms?</a></li>
2.82 <li><a href="model.html">The XSLForms Conceptual Model</a></li>
2.83 +
2.84 <li><a href="overview.html">Creating Applications: An Overview</a></li>
2.85
2.86 +
2.87 </ul>
2.88
2.89 +
2.90 </body>
2.91 </html>
3.1 --- a/docs/styles.css Mon Jul 18 16:43:02 2005 +0000
3.2 +++ b/docs/styles.css Mon Jul 18 22:31:18 2005 +0000
3.3 @@ -5,7 +5,7 @@
3.4
3.5 h1 { color: navy;
3.6 font-family: sans-serif;
3.7 - font-size: 2.0em;
3.8 + font-size: 2em;
3.9 }
3.10
3.11 h2 { color: navy;
3.12 @@ -64,3 +64,14 @@
3.13 top: 1em;
3.14 }
3.15
3.16 + .subdirectory { border-style: solid;
3.17 + border-width: 1px;
3.18 + padding: 0.25em;
3.19 + display: block;
3.20 + position: relative;
3.21 + font-weight: normal;
3.22 + top: 0.5em;
3.23 + left: -5em;
3.24 + background-color: rgb(153, 153, 255);
3.25 + }
3.26 +
4.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
4.2 +++ b/docs/what.html Mon Jul 18 22:31:18 2005 +0000
4.3 @@ -0,0 +1,68 @@
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 +
4.8 +
4.9 +
4.10 +
4.11 +
4.12 +
4.13 + <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
4.14 +
4.15 +
4.16 +
4.17 +
4.18 +
4.19 +
4.20 +
4.21 +
4.22 +
4.23 + <title>What are XSLTools and XSLForms?</title>
4.24 + <meta name="generator" content="amaya 8.1a, see http://www.w3.org/Amaya/" />
4.25 +
4.26 +
4.27 +
4.28 +
4.29 +
4.30 +
4.31 + <link href="styles.css" rel="stylesheet" type="text/css" />
4.32 +</head>
4.33 +
4.34 +
4.35 +<body>
4.36 +
4.37 +
4.38 +
4.39 +<h1>What are XSLTools and XSLForms?</h1>
4.40 +
4.41 +
4.42 +
4.43 +<p>XSLTools is the name of an entire distribution of modules, packages, examples and documentation; it includes...</p>
4.44 +<ul>
4.45 + <li>The XSLForms
4.46 +framework for developing forms-based Web applications using XML and XSL stylesheets and transformations.</li>
4.47 + <li>The XSLOutput module for producing XML output from XML documents and XSL stylesheets.</li>
4.48 +</ul>
4.49 +<p>The relationship between these two technologies is summarised in the diagram below:</p>
4.50 +<table style="width: 80%; text-align: left; margin-left: auto; margin-right: auto;" border="0" cellpadding="5" cellspacing="0">
4.51 + <tbody>
4.52 + <tr>
4.53 + <td width="40%"></td>
4.54 + <th style="text-align: center;" width="60%">What it does</th>
4.55 + </tr>
4.56 + <tr>
4.57 + <th style="background-color: rgb(193, 255, 102); text-align: center; vertical-align: middle;">XSLForms</th>
4.58 + <td align="undefined" valign="undefined"><span class="explanation">This is a solution which models Web form data as XML documents, presenting such documents using presentation templates.</span></td>
4.59 + </tr>
4.60 + <tr>
4.61 + <th style="background-color: rgb(102, 203, 255); text-align: center; vertical-align: middle;">XSLOutput</th>
4.62 + <td align="undefined" valign="undefined"><span class="explanation">This provides the presentation support, producing Web pages from XML documents and XSL stylesheets.</span></td>
4.63 + </tr>
4.64 + </tbody>
4.65 +</table>
4.66 +<p>XSLForms employs presentation templates which are converted to XSL
4.67 +stylesheets, permitting the framework to take advantage of that
4.68 +particular standardised and well-supported technology using XSLOutput
4.69 +and, in turn, libxslt.</p>
4.70 +</body>
4.71 +</html>