You are viewing a plain text version of this content. The canonical link for it is here.
Posted to svn@forrest.apache.org by cr...@apache.org on 2007/05/09 10:39:55 UTC
svn commit: r536457 -
/forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml
Author: crossley
Date: Wed May 9 01:39:53 2007
New Revision: 536457
URL: http://svn.apache.org/viewvc?view=rev&rev=536457
Log:
Add entries for Pipeline (#pipeline), Generator (#generator), Transformer (#transformer) and Serializer (#serializer) to explain the basic Cocoon components. Link to Cocoon docs for more.
Modified:
forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml
Modified: forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml?view=diff&rev=536457&r1=536456&r2=536457
==============================================================================
--- forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml (original)
+++ forrest/trunk/site-author/content/xdocs/docs_0_90/glossary.xml Wed May 9 01:39:53 2007
@@ -101,6 +101,26 @@
</notes>
</item>
</part>
+ <part id="g">
+ <title>G</title>
+ <item id="generator">
+ <term>Generator</term>
+ <definitions>
+ <definition>
+ A Generator is a Cocoon <link href="#sitemap">sitemap</link> component.
+ Each <link href="#pipeline">pipeline</link> begins with a Generator. Its job
+ is to generate XML content as SAX events and initialize the pipeline processing.
+ The default generator is the "File Generator" which reads an xml document
+ from the local file system or from any url.
+ </definition>
+ </definitions>
+ <notes>
+ <item-note>
+ <link href="site:sitemap-ref">Sitemap Reference</link> and the Cocoon documents linked from there.
+ </item-note>
+ </notes>
+ </item>
+ </part>
<part id="i">
<title>I</title>
<item id="internal-xml">
@@ -164,6 +184,25 @@
</part>
<part id="p">
<title>P</title>
+ <item id="pipeline">
+ <term>Pipeline</term>
+ <definitions>
+ <definition>
+ The Cocoon <link href="#sitemap">Sitemaps</link> have one or more pipelines
+ which handle the processing of various pieces of xml content.
+ Each pipeline begins with a
+ <link href="#generator">Generator</link>, continues with zero or more
+ <link href="#transformer">Transformers</link>, and ends with a
+ <link href="#serializer">Serializer</link>.
+ Aggregation enables building a hierarchy of pipelines.
+ </definition>
+ </definitions>
+ <notes>
+ <item-note>
+ <link href="site:sitemap-ref">Sitemap Reference</link> and the Cocoon documents linked from there.
+ </item-note>
+ </notes>
+ </item>
<item id="plugins">
<term>Plugins</term>
<definitions>
@@ -220,6 +259,24 @@
</item-note>
</notes>
</item>
+ <item id="serializer">
+ <term>Serializer</term>
+ <definitions>
+ <definition>
+ A Serializer is a Cocoon <link href="#sitemap">sitemap</link> component.
+ Each <link href="#pipeline">pipeline</link> ends with a Serializer. Its job
+ is to transform SAX events into binary or character streams for final
+ client consumption. One example (the default) is the "HTML Serializer"
+ which serializes xml content to html. The Serializer can have parameters
+ to configure its behaviour, e.g. to specify the document type declaration.
+ </definition>
+ </definitions>
+ <notes>
+ <item-note>
+ <link href="site:sitemap-ref">Sitemap Reference</link> and the Cocoon documents linked from there.
+ </item-note>
+ </notes>
+ </item>
<item id="sitemap">
<term>Sitemap</term>
<definitions>
@@ -287,6 +344,27 @@
<notes>
<item-note>
<link href="site:version-control">Version control</link>
+ </item-note>
+ </notes>
+ </item>
+ </part>
+ <part id="t">
+ <title>T</title>
+ <item id="transformer">
+ <term>Transformer</term>
+ <definitions>
+ <definition>
+ A Transformer is a Cocoon <link href="#sitemap">sitemap</link> component.
+ Each <link href="#pipeline">pipeline</link> has zero or more Transformers. Its job
+ is to transform SAX events into other SAX events.
+ The default transformer is the "XSLT Transformer" which uses an XSLT
+ stylesheet to transform xml content. The Transformer can have parameters
+ to configure its behaviour or pass data to the stylesheet.
+ </definition>
+ </definitions>
+ <notes>
+ <item-note>
+ <link href="site:sitemap-ref">Sitemap Reference</link> and the Cocoon documents linked from there.
</item-note>
</notes>
</item>