Yawns Documentation
This page contains all of the currently available documentation for the Yawns software. More content will be added over time.
- Administrator's Guide
This document describes how to work with your site once you've installed it.
It focusses upon the site administrators typical tasks:
- Publishing articles.
- Editing articles.
- Regenerating feeds.
- Flushing the memory cache.
- Code Documentation
The code itself is documented using Perls "plain old documentation" system, and can be browsed online.
- Installation Guide
There is a complete installation guide for installing a copy of Yawns upon a Debian GNU/Linux host.
Installation upon other platforms should be very similar; most of the work is installing the software dependencies.
- Software Requirements List
The requirements list contains a list of all the required software you'll need to install.
Mostly this is just Apache/Apache2, MySQL, and a collection of Perl modules.
- Template Guide
This document briefly explains how the site templates, which control the look and feel of your Yawns site, are organised.
- Test Suite Guide
The site testing guide describes the test suite which is included within the distribution, and demonstrates the different ways in which the existing test cases may be executed.