The Skencil Website
===================

Overview
--------

The Skencil website consists of a bunch of static html files that are generated
from a page layout file and files that contain the bodies of every page.

FAQ and Release Notes sections of the website are generated by scripts that are
in folders faq/ and relnotes/, respectively. The rest of the pages are just
plain html files in folder pages/.


Required Software
-----------------

Roughly these software packages are required to build the html files of the
Skencil website.

- Python version 2.2 or above is required.

- Docutils (http://docutils.sf.net) (for Release Notes)

- Python XML (http://pyxml.sf.net) (for the FAQ)

- The following are needed if you want to build the gallery files:

  * Skencil 0.6.13. More precisely, any Skencil version that contains
    sk2ppm which was first shipped with 0.6.13

  * cjpeg. In Debian woody package: libjpeg-progs

  * pnmscale. In Debian woody package: netpbm

  * Fonts to generate the Gallery images in the Skencil's font_path.

    (If you get warning messages like:
    I cannot find the metrics for the font URWChanceryL-MediItal.
    The file z003034l.afm is not in the font_path.
    I'll use the metrics for Times-Roman instead.
    you can ignore this or add a path to font_path which has "z003034l.afm".)


Required accounts
-----------------

The sources of the website are kept in folder skencil.org/ in Skencil's
"Software" CVS repository on Savannah. To make changes to them you either have
to send us patches or get commit permission from us which requires a
Savannah account and becoming a member of the Skencil project at Savannah
(http://savannah.nongnu.org/projects/skencil/).

The actual hosted html files are in Skencil's "Web Pages" CVS repository.


Building the Website
--------------------

Run "./updatepages.py" to update the web-pages in folder skencil/.
(Use "--force" to create all of them regarding of the creation times.)
If you also want to update Release Notes or the FAQ, you have to run the
updatefaq and updaterelnotes.py scripts in folders faq/ and relnotes/
before you run updatepages.py.

Gallery images can be built by running "make" in folder gallery/. Note
that the gallery images require a lot of space for intermediate files;
currently aroung 60MB.

To upload the final html files to Savannah, just commit them to Skencil's
"Web Pages" CVS repository. That can be achieved easily if "Web Pages" is
checked out as skencil/ folder.