blob: 023498d3bdc62455817be061471d92a3522ec3f5 [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN" "document-v10.dtd">
<document>
<header>
<title>Generators in Cocoon</title>
<version>0.9</version>
<type>Technical document</type>
<authors>
<person name="Carsten Ziegeler" email="cziegeler@apache.org"/>
</authors>
<abstract>This document describes all of the available generators of Cocoon.</abstract>
</header>
<body>
<s1 title="Goal">
<p>This document lists all of the available generators of Apache Cocoon and describes their
purpose.</p>
</s1>
<s1 title="Overview">
<p>A generator is the starting point of an xml pipeline. It generates XML content as SAX
events and initializes pipeline processing. Every pipeline match containing a generator
must be terminated by a serializer.
</p>
<p>In the sitemap file, each generator has a unique name which is mapped to a Java class. One
generator name must be declared as the default generator. Each generator may have additional
configuration information specified in child elements.
</p>
<p>For conceptual information on generators see the user's guide document
<link href="../concepts/sitemap.html">The Sitemap</link>.
</p>
</s1>
<s1 title="The Generators in Apache Cocoon">
<ul>
<li><link href="directory-generator.html">Directory Generator</link></li>
<li><link href="file-generator.html">File Generator</link> (The default generator)</li>
<li><link href="extractor-generator.html">Fragment Extractor Generator</link> (optional: Batik block)</li>
<li><link href="html-generator.html">HTML Generator</link> (optional: HTML block)</li>
<li><link href="imagedirectory-generator.html">Image Directory Generator</link></li>
<li><link href="jsp-generator.html">JSP Generator</link> (optional: JSP block)</li>
<li><link href="linkstatus-generator.html">LinkStatus Generator</link></li>
<li>MP3 Directory Generator (no documentation exists)</li>
<li><link href="error-generator.html">Notifying Generator</link></li>
<li><link href="php-generator.html">Php Generator</link> (optional: PHP block)</li>
<li><link href="profile-generator.html">Profile Generator</link> (optional: Profiler block)</li>
<li><link href="request-generator.html">Request Generator</link></li>
<li><link href="script-generator.html">Script Generator</link> (optional: BSF block)</li>
<li><link href="search-generator.html">Search Generator</link> (optional: Lucene block)</li>
<li><link href="serverpages-generator.html">Server Pages Generator</link></li>
<li><link href="status-generator.html">Status Generator</link></li>
<li><link href="stream-generator.html">Stream Generator</link></li>
<li><link href="velocity-generator.html">Velocity Generator</link> (optional: Velocity block)</li>
<li><link href="wsproxy-generator.html">Web Service Proxy Generator</link> (optional: Proxy block)</li>
<li><link href="xmldbcollection-generator.html">XML:DB Collection Generator</link> (optional: XMLDB block)</li>
<li><link href="xmldb-generator.html">XML:DB Generator</link> (optional: XMLDB block)</li>
<li><link href="xpathdirectory-generator.html">XPath Directory Generator</link></li>
</ul>
</s1>
</body>
</document>