================================
Support for Quixote and REST Etc
================================

:author: Dave Kuhlman
:address: dkuhlman@rexx.com
    http://www.rexx.com/~dkuhlman

:revision: 1.0a
:date: July 20, 2004

:copyright: Copyright (c) 2004 Dave Kuhlman. This documentation is
    covered by The MIT License:
    http://www.opensource.org/licenses/mit-license.

:abstract: Documentation and support for Quixote and some Quixote
    appropriate tasks.

.. Note we cannot use the sectnum directive.  It generates
   duplicate section numbers.

.. sectnum::    :depth: 4

.. contents::   :depth: 4



Quixote and Apache and SCGI
===========================

For those who want to run Quixote on top of Apache and
SCGI/mod_scgi, here is a document that explains 
how to set Quixote with Apache and SCGI:
http://www.rexx.com/~dkuhlman/quixote_scgi.html.


Quixote and Medusa
==================

For those who want to run Quixote on top of the Medusa Web server,
here is a document that explains how to set up Quixote with Medusa:
http://www.rexx.com/~dkuhlman/quixote_usingmedusa.html.


Writing your first Quixote application
======================================

If you are new to Quixote, this how-to document might help you
write your first application more quickly:
`A Quixote Application: Getting Started`_.

.. _`A Quixote Application: Getting Started`:
    http://www.rexx.com/~dkuhlman/quixote_appgetgo.html


HTML scraping and Quixote
=========================

This document describes how to treat the Web and HTML Web pages as
resources from which you can extract data.  You can find it here:
http://www.rexx.com/~dkuhlman/quixote_htmlscraping.html.


Quixote User Interface How To
=============================

Here is some help with writing your user interface with Quixote:
http://www.rexx.com/~dkuhlman/quixote_uihowto.html.


A Quixote Application Skeleton
==============================

Here is help with constructing a Quixote application.  It's an
attempt enable you to create a Quixote application without
starting from scratch.  It also provides instructions on how to
modify and customize the skeleton application.

Documentation is here: 
http://www.rexx.com/~dkuhlman/quixote_skeleton.html.

The distribution file is here:
http://www.rexx.com/~dkuhlman/quixote_skeleton.zip.


A Quixote Application for Generating Configuration Files
========================================================

This small Quixote application is intended as an example or
skeleton for applications that (1) request a few parameters from a
user and then (2) generate a configuration (or other text) file
from a template file.

Documentation is here: 
http://www.rexx.com/~dkuhlman/quixote_configfilegen.html.

The distribution file is here:
http://www.rexx.com/~dkuhlman/quixote_iptables_firewall_config.zip.


A Quixote Application Skeleton Generator
========================================

``quixote_appgen`` is a Python application that generates a
skeleton of a Quixote application. ``quixote_appgen`` reads an
application specification from a configuration file, which is a
Python module containing a Python data structure.
``quixote_appgen`` generates source code for a Quixote application
to which you can "easily" add application specific code.

Documentation is here:
http://www.rexx.com/~dkuhlman/quixote_appgen.html.

The distribution file is here:
http://www.rexx.com/~dkuhlman/quixote_appgen-1.3b.tar.gz.



Quixote and REST
================

I've also been investigating REST (representational state
transfer).

Here is a `REST how-to document`_ that provides help with
implementing RESTful applications on top of ``AOLserver``, ``PyWX``, and
``Quixote``.

.. _`REST how-to document`:
    http://www.rexx.com/~dkuhlman/rest_howto.html


REST and FSM
============

I've also tried to develop a way to implement a complex process by
casting it into an FSM (finite state machine) and then
implementing that FSM in a REST-ful style on top of Quixote.

Here is an `FSM how-to document`_ explaining how to do that.
Examples and support code are in `fsm_examples.zip`_.

.. _`FSM how-to document`:
    http://www.rexx.com/~dkuhlman/fsm_howto.html

.. _`fsm_examples.zip`:
    http://www.rexx.com/~dkuhlman/fsm_examples.zip


Workflow and REST
=================

And, here is a `workflow how-to document`_ that describes support
for generating REST-ful Quixote applications from an XML
specification of an FSM or workflow.  Examples and support code
are in `workflow_examples.zip`_.

.. _`workflow how-to document`:
    http://www.rexx.com/~dkuhlman/workflow_howto.html

.. _`workflow_examples.zip`:
    http://www.rexx.com/~dkuhlman/workflow_examples.zip


FSM generator
=============

This `document on fsmGenerate.py`_ describes a more complete
application generator for FSM/REST applications that run on top of
Quixote.  And, `fsmGenerate_examples.zip`_ contains examples,
supporting code, and the code that does the work.

.. _`document on fsmGenerate.py`:
    http://www.rexx.com/~dkuhlman/fsmGenerate_howto.html

.. _`fsmGenerate_examples.zip`:
    http://www.rexx.com/~dkuhlman/fsmGenerate_examples.zip