| the Apache XML site |

| Home |

| Community |

| Samples |

# Our Contract

PDF

Notice: The legal tone of this document is just a gimmick, this is not a legal document in any sense. At all times: since this is open source: the real contract is described in the implementation details of the full distribution. This tries to list (not explain) what the ins and outs of using Forrest is about. Please let the forrest-dev mail list know if any of the bullets listed here are out of sync with the real implementation.

This document describes in a very techy bullet-style way how to use Forrest.

- Forrest will:
- TheProject Must:
- TheProject Can:

This document describes the formal contract between the Forrest distribution code, hereafter referred as Forrest, and the Project (team) using it for generating its documentation web-site, hereafter TheProject, or in the best case: You.

### Forrest will:

- provide DTDs, skins, cocoon-pipelines, and 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:

Note
{docroot} is the location inside TheProject's file hierarchy where all documentation related resources are stored. Commonly, {docroot} equals to {projecthome}/src/documentation

- provide XML content in {docroot}/content/xdocs according to the forrest DTDs,
- provide content navigation metadata by adding site.xml and tabs.xml files in there as well.
- provide own xml project descriptor files in the directory {projecthome}

### TheProject Can:

- provide its own skin in a directory {docroot}/skins/{your-skin-name} (check the current Forrest skins and the related pipelines to see what they are doing)
- provide own DTDs (and stylesheets) to work with in {docroot}/resources/schema/dtd
  - maybe also extra required stylesheets to convert own grammar to 'document' (being the format that the skins work on)
  - and probably with an updated {docroot}/resources/schema/catalog
- provide its own overwriting versions of {docroot}/sitemap.xmap (and other *.xmap files), {docroot}/cocoon.xconf etc ... (be sure you know what you are doing since you're leaving the area where other Forresters can help you out.

by Marc Portier

Copyright © 2002-2003 The Apache Software Foundation. All rights reserved.