apache > cocoon

- Home

# Refactoring of Cocoon Samples

## Overview

The Cocoon samples are now under `src/webapp/samples/` and have been refactored to be self contained, to have their own sitemaps, and to utilise some common resources.

However, there are still some old samples that have not yet been moved into this new structure. They were at `src/webapp/docs/samples/` and not available from the samples page. Please help to bring them back. Samples refactoring progress is tracked at SamplesRefactor.

## Procedure

- Choose your favourite missing sample.
- Create a new directory under `webapp/samples`
- Follow the example of some other samples, e.g. `i18n/` or `misc/`
- `cp samples/misc/sitemap.xmap samples/yours/sitemap.xmap` and edit it to suit your own matches.
- `cp samples/misc/samples.xml samples/yours/samples.xml` and edit it to become the front page to your collection of samples.
- Move the documents from the old sample at `webapp/docs/samples`
- Make links to your new samples from other pages.
- Remove the old sample from `webapp/docs/samples`
- Ensure that the new sample works as expected.
- Send a patch via Jira

## Other discussion

There has been some discussion on cocoon-dev ...

- Samples Refactoring: Documentation Structure

Errors and Improvements? If you see any errors or potential improvements in this document please help us: View, Edit or comment on the latest development version (registration required).