# HG changeset patch # User paulb # Date 1121725878 0 # Node ID ab7be4e5ffbe4fcaace6433b9ba03f69b474a66c # Parent 83b5cc428615dfc006bf00c22842dfc37f129cd2 [project @ 2005-07-18 22:31:18 by paulb] Added a "what is...?" page to the documentation. Added an improved directory structure description using a table-based layout and an additional style. diff -r 83b5cc428615 -r ab7be4e5ffbe docs/directory.html --- a/docs/directory.html Mon Jul 18 16:43:02 2005 +0000 +++ b/docs/directory.html Mon Jul 18 22:31:18 2005 +0000 @@ -1,46 +1,91 @@ + + + + + + + + + + Creating Applications: Create a Directory - + + + + + + + + +

Creating Applications: Create a Directory

+ +

The recommended directory structure of an XSLForms application is as follows:

A top-level directory corresponding to a Python package, -containing...
-
- An __init__.py file and other source files, -containing the Web resources and other -application logic.
- A subdirectory containing non-code resources for the -application.
- Other package directories, if necessary.
-

For example, we might create a directory structure like this:

A top-level directory called Configurator, -containing...
-
- An __init__.py file containing the Web -resources and other application logic.
- A subdirectory called Resources containing -non-code resources.
-

In UNIX-style commands, this would be done as follows:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

	Example Directory Structure + +
A top-level directory corresponding to a Python package	Configurator +__init__.py
A subdirectory containing non-code resources for the +application	+ +	Resources + +...

For the above example, the directory structure would be created using UNIX-style commands as follows:

+ +

mkdir Configurator
mkdir Configurator/Resources
touch Configurator/__init__.py

+ +

It is in the Resources subdirectory that we will save our template files when designing them as -part of the next activity in the application development process.

+part of the next activity in the application development process.

+ + diff -r 83b5cc428615 -r ab7be4e5ffbe docs/index.html --- a/docs/index.html Mon Jul 18 16:43:02 2005 +0000 +++ b/docs/index.html Mon Jul 18 22:31:18 2005 +0000 @@ -2,14 +2,21 @@ + + + + + Developing Web Applications with XSLTools + + @@ -17,17 +24,22 @@ +

Developing Web Applications with XSLTools

This documentation introduces the XSLTools package and the XSLForms framework for developing forms-based Web applications using Python, libxml2dom, libxml2, libxslt and (optionally) WebStack.

Setting Up

First of all, let us assume that the XSLTools distribution has been unpacked and now sits in the XSLTools-0.1 directory.

Before we begin, we must make sure that the XSLTools package is available to Python. The easiest way to do this is to change into the XSLTools-0.1 @@ -35,8 +47,10 @@ script provided with the version of Python you are going to be using (possibly as a privileged user like root):

cd XSLTools-0.1
python setup.py install

If you don't want to install XSLTools in this way, or if you can't do so because you don't have root privileges, you can just make @@ -44,8 +58,10 @@ that the XSLTools-0.1 directory sits on your PYTHONPATH.

Viewing the API Documentation

The API documentation for use in conjunction with this guide can be found inside the apidocs directory within the XSLTools-0.1 directory. Of course, @@ -53,14 +69,21 @@ within Python by importing modules (such as XSLOutput) and using Python's built-in help function.

About XSLForms Applications

+ diff -r 83b5cc428615 -r ab7be4e5ffbe docs/styles.css --- a/docs/styles.css Mon Jul 18 16:43:02 2005 +0000 +++ b/docs/styles.css Mon Jul 18 22:31:18 2005 +0000 @@ -5,7 +5,7 @@ h1 { color: navy; font-family: sans-serif; - font-size: 2.0em; + font-size: 2em; } h2 { color: navy; @@ -64,3 +64,14 @@ top: 1em; } + .subdirectory { border-style: solid; + border-width: 1px; + padding: 0.25em; + display: block; + position: relative; + font-weight: normal; + top: 0.5em; + left: -5em; + background-color: rgb(153, 153, 255); + } + diff -r 83b5cc428615 -r ab7be4e5ffbe docs/what.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/what.html Mon Jul 18 22:31:18 2005 +0000 @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + What are XSLTools and XSLForms? + + + + + + + + + + + + + + + +

What are XSLTools and XSLForms?

+ + + +

XSLTools is the name of an entire distribution of modules, packages, examples and documentation; it includes...

The XSLForms +framework for developing forms-based Web applications using XML and XSL stylesheets and transformations.
The XSLOutput module for producing XML output from XML documents and XSL stylesheets.

The relationship between these two technologies is summarised in the diagram below:

+ + + + + + + + + + + + + + + +

	What it does
XSLForms	This is a solution which models Web form data as XML documents, presenting such documents using presentation templates.
XSLOutput	This provides the presentation support, producing Web pages from XML documents and XSL stylesheets.

XSLForms employs presentation templates which are converted to XSL +stylesheets, permitting the framework to take advantage of that +particular standardised and well-supported technology using XSLOutput +and, in turn, libxslt.

+ +