This is a working draft of what reference pages ("manpages") could be, taking a simple and well-known component as an example.
This thread on cocoon-docs led to the creation of this page.
Cocoon Component Reference
NAME |
FileGenerator |
WHAT |
Generator that uses XML files, HTTP/XML or other XML Sources as input |
TYPE |
Generator, Sitemap Component |
BLOCK |
Core |
CLASS |
org.apache.cocoon.generation.FileGenerator |
Description
FileGenerator is usually configured to be the default generator.
It reads and parses an xml document from a Source, which is often a file from the local filesystem or an HTTP URL, but any Avalon Source can be used as input.
Usage
Sitemap pipeline examples
General case
<map:generate type="file" src="uri:/uri-source-path"/>
Generate from an XML file
<map:generate type="file" src="somepath/somefile.xml"/>
Generate from an HTTP/XML source
<map:generate type="file" src="http://somehost/thesource.xml"/>
Generate from another pipeline
<map:generate type="file" src="cocoon:/theOtherPipeline.xml"/>
Sitemap component configuration example
<map:generators default="file"> <map:generator label="content,data" logger="sitemap.generator.file" name="file" pool-grow="4" pool-max="32" pool-min="8" src="org.apache.cocoon.generation.FileGenerator"/> </map:generate>
Configurable Parameters
What parameters you can use with <map:parameter/>, what they do, and what format they expect
Effect on Object Model and Sitemap Parameters
What changes are made to the object model and sitemap parameters that may need to be known for subsequent steps in the pipeline.
Bugs/Caveats
What doesn't work as expected, doesn't work at all, or just needs to be mentioned
Author/History
Who wrote this, why, etc.
Copyright
Must guard intellectual property
See also
Links to related components pages
Notes on this working draft
- 2002-12-28 used this as layout template for Cocoon userdocs/readers documentation BernhardHuber