Skencil documentation
=====================

The skencil documentation consists of two main parts:

  User's Guide        user documentation

  Developer's Guide   documentation of Skencil's internals for developers 
                      and script authors


Building the documentation
--------------------------

The documentation is written in DocBook XML and converted to HTML by
docbook-xslt and xsltproc.  On a debian sarge system you have to install
the packages docbook-xml, docbook-xsl and xsltproc.

With the relevant software installed and configured, it should be enough
to simply run make in this directory.  Afterwards, the HTML-version of
the documentation should be in usersguide/html/ and devguide/html/
respectively.


Documentation conventions
-------------------------

Some conventions to keep in mind when modifying the documentation:

  - The documents are split into several HTML files with one file being
    generated for every chapter and sect1 element.  The names of the
    HTML files are derived from the id's of those elements.  Therefore,
    all chapter and sect1 elements should have an id attribute.  Also,
    the id of all sect1 elements of a chapter should have the same
    prefix which is derived from the chapter's id.  E.g. the scripting
    chapter has the id "script" and all id's of the sect1's in the
    chapter start with "script-".
