README
author kairo@kairo.at
Wed, 21 Nov 2007 16:31:33 +0000
changeset 74 2afbf09f4c166d927913f12323c1b1b02f37a27c
parent 0 7607a87be3d5131452c783ad1333caeba01dad0c
child 643 c980901c4a7e8a8eed1b0c59bd4b43025c2c4a42
permissions -rw-r--r--
correct get involved link on start page, add doc as well

Directory Structure
-------------------
Contained in CVS:
bin - contains the build scripts
etc - Template Toolkit configuration
lib - various include files for the templates and the site map used to generate
      the navigation menus
src - the actual site content

Generated:
dest - the output of the build script (the finished website docroot)

Build Requirements
------------------
* expat library
* Perl modules:
  * Template Toolkit
  * XML::XPath

Building the Site
-----------------
To build manually:
* cd into the directory containing this README file
* run "bin/build"
* The "dest" directory will be created if it doesn't exist, and the tree will be
  built there.

To build from a cron job:
* Same as above, but run "bin/build-exclusive.pl" instead, which does locking
  to ensure build jobs don't overlap.

HTML files will be processed by Template Toolkit.  This means you can use Template
Toolkit directives in your pages for creative content or site-wide variables that
you define in one of the config files.  See http://www.template-toolkit.org/ for
documentation.

The main site look (banner, navigation, etc) is in lib/wrapper.tmpl

Configuration Files
-------------------
Most config files are self-documenting.  Read the comments in the files.