The Kupu website
================

This is a custom web application for maintaining the Kupu website. It's geared
towards developers, and is therefore filesystem-oriented: rather than providing
a fancy web interface it uses Subversion for storage, versioning, metadata and
staging, which makes that website editors can work on the filesystem using 
their favorite editor and tools. 

Files in a special working copy, from the `kupusite`_ repository, are used to 
generate the body contents of web pages. The system parses the files, places
layout and navigation 'around' the rendered contents, and presents it. Contents
can be provided in both HTML and ReStructured Text format (the latter is 
preferred).

The system has certain special directories in which the contents is handled
differently. Examples of such components are the download page and the
screenshots page. Files in those directories are presented in lists together
with some metadata, which is read from the file's SVN properties. See the
'config.py' file for the registered special handlers, and the 'README' files in
the handler directories ('kupusite' repository) which properties are expected.

Requirements
------------

To set up a local instance for testing the data, the following requirements
will need to be met:

  * `Apache`_ 2.x
  * `Python`_ 2.4.x
  * `mod_python`_ for that Apache and Python
  * `docutils`_ (XXX version?)
  * `libxml2`_
  * `lxml`_
  * the `Py`_ lib
  * `templess`_

.. _`kupusite`: http://johnnydebris.net:8080/kupusite
.. _`Apache`: http://www.apache.org
.. _`Python`: http://www.python.org
.. _`mod_python`: http://www.modpython.org
.. _`docutils`: http://docutils.sourceforge.net
.. _`libxml2`: http://xmlsoft.org
.. _`lxml`: http://codespeak.net/lxml/
.. _`Py`: http://codespeak.net/py/current/doc/
.. _`templess`: http://templess.johnnydebris.net/

Installation
------------

To install the package, make sure all packages mentioned above are properly
installed and configured. Make an SVN checkout of the 'kupusite' (data) package 
somewhere into a directory that is available via the Apache server. Copy the
file 'htaccess' to '<web directory>/.htaccess' and modify it if necessary
(the PythonPath will probably need to be adjusted so the 'kupusite' package 
(code) can be found). Modify config.py so the paths are correct and start 
Apache. Now if you visit the directory using your browser everything should 
work.

Additional note: the web server will need to have write access in the 
'screenshots' directory in order for the screenshots application to work.
found).