Font size:
Our Contract
This document describes, in a very techy bullet-style way, how
to use Forrest.
This is documentation for development version v0.8
(More)
Note
This document describes the formal contract between the
Forrest distribution code, hereafter referred as
"Forrest", and
the Project (team) that is using it for generating
its documentation and web-site, hereafter referred to as "TheProject".
Note
Some terminology will assist: {docroot} is the location
inside TheProject's file hierarchy where all documentation related
resources are stored. Usually {docroot} equals to
{projecthome}/src/documentation
Forrest will:
Provide infrastructure ...
- Provide document type definitions (DTDs), skins, default sitemaps, Cocoon pipelines.
- Provide a willing team of supporting developers at the forrest-dev mail list.
- Use Cocoon to generate the HTML and PDF documentation for TheProject.
TheProject must:
Provide content and configuration ...
- Provide XML content in {docroot}/content/xdocs according to the Forrest DTDs or one of the other input formats.
- Provide navigation metadata using the configuration files site.xml and tabs.xml
- Provide the skin configuation file in {docroot}/skinconf.xml
TheProject can:
Add extra abilities ...
- Provide its own skin in {docroot}/skins/{your-skin-name} (Check the current Forrest skins and the related pipelines to see what they are doing. Bear in mind that the provided skins are able to be configured and may already meet your needs.)
- Provide own DTDs to handle other specialised document types in
{docroot}/resources/schema/dtd
- and extra stylesheets to convert own grammar to the intermediate 'document' structure.
- and declare those extra DTDs in {docroot}/resources/schema/catalog.xcat
- Provide its own overwriting versions of sitemaps ({docroot}/sitemap.xmap and other *.xmap files) ... (be sure you know what you are doing since you are then leaving the area where other Forresters can help you out.