General Information
===================

PyCo is a content management system for small and almost static web pages.

The PyCo CMS consists of three parts which will build the final web page:
  * The pages structure
  * The page content
  * The template

The page structure is a simple folder structure containing files for pages.
Every element on the folder structure, whether file, folder or link, will be a
page on the final web page. A regular file defines the page using the file name
as page title and the file content as page content. A directory must contain a
file or link with the name '.content' which specifies the page created for the
folder. A link could link to another file, link or folder to make the page(s)
available on the position of the link. The order of the pages is defined by an
extended file attribute configurabel in the PyCo settings. The order attribute
is optional and stored for each file  used to sort the pages in a directory.

The page content is written in HTML. The content will be inserted into the
template without modification. To pass the content to a specific module the
content can be preceded with a shi-bang style declaration. The shi-bang
declaration looks like the following: '#! MODULE'. The declaration must existst
in the first line without any preceeding spaces. The 'MODULE' must be replaced
with the name of the mudule to pass the raw content throught. The description
of the renderers are located in the renderers code: /renderers/MODULE.

The template creates from the current context and the rendered content a
web page. The template will be loaded and populated with HTML created from the
page content and serveral other values from the current context. The rendered
template provides the final web page. The template system used is jinja2
which allows to write complex expressions inside of the template and is able to
process all the information provided by PyCo to build high quality web pages.
For further information about jinja2 see <http://jinja.pocoo.org/2/>.


Installation
============

See the file 'INSTALL'


Release notes for 0.0
=====================


How to report bugs
==================

Bugs should reported to the author at <dustin.frisch@gmail.com>.

In the bug report please include:

* Information about your system. For instance:

   - What operating system and version
   - What version of Apache / LightTPD 
   - What version of python

  And anything else you think is relevant.

* How to reproduce the bug. 

  Please include a short test that exhibits the behavior. As a last resort, you
  can also provide a pointer to a larger installation that can be
  downloaded.

* If the bug was a crash, the exact text that was printed out when the
  crash occured.

* Further information such as stack traces may be useful, but is not
  necessary.


Patches
=======

Patches should also be submitted the author at <dustin.frisch@gmail.com>. If
the patch fixes an existing bug, add the patch as an attachment to that bug
report.

Otherwise, enter a new bug report that describes the patch, and attach
the patch to that bug report.

Patches should be in unified diff form. (The -up option to GNU diff.)