cziegeler 2004/05/26 07:11:36
Modified: src/java/org/apache/cocoon/generation
MP3DirectoryGenerator.java JXTemplateGenerator.java
StreamGenerator.java XPathDirectoryGenerator.java
StatusGenerator.java RequestGenerator.java
LinkStatusGenerator.java
SessionAttributeGenerator.java
CalendarGenerator.java
src/documentation/xdocs/userdocs/generators
linkstatus-generator.xml request-generator.xml
status-generator.xml stream-generator.xml
xpathdirectory-generator.xml
Added: src/documentation/xdocs/userdocs/generators
calendar-generator.xml
Log:
Add all core generators
Revision Changes Path
1.5 +9 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java
Index: MP3DirectoryGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/MP3DirectoryGenerator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- MP3DirectoryGenerator.java 5 Mar 2004 13:02:55 -0000 1.4
+++ MP3DirectoryGenerator.java 26 May 2004 14:11:33 -0000 1.5
@@ -22,8 +22,16 @@
import java.io.RandomAccessFile;
/**
+ * @cocoon.sitemap.component.documentation
* An extension of DirectoryGenerators that adds extra attributes for MP3
* files.
+ *
+ * @cocoon.sitemap.component.name mp3directory
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.mp3directory
+ * @cocoon.sitemap.component.documentation.caching
+ * Uses the last modification date of the directory and the
contained files
+ *
* <p>
* Following extra attributes added to valid MP3 files:
* <blockquote>
1.43 +13 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/JXTemplateGenerator.java
Index: JXTemplateGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/JXTemplateGenerator.java,v
retrieving revision 1.42
retrieving revision 1.43
diff -u -r1.42 -r1.43
--- JXTemplateGenerator.java 24 Apr 2004 21:35:35 -0000 1.42
+++ JXTemplateGenerator.java 26 May 2004 14:11:33 -0000 1.43
@@ -97,6 +97,18 @@
import org.xml.sax.helpers.LocatorImpl;
/**
+ * @cocoon.sitemap.component.documentation
+ * Provides a generic page template with embedded JSTL and XPath
+ * expression substitution to access data sent by Cocoon Flowscripts.
+ *
+ * @cocoon.sitemap.component.name jx
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.jx
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
+ *
* <p>(<em>JX</em> for <a
href="http://jakarta.apache.org/commons/jxpath";>Apache <em>JX</em>Path</a>
* and <a href="http://jakarta.apache.org/commons/jexl";>Apache
<em>J</em>e<em>x</em>l</a>).</p>
* <p>Uses the namespace
<code>http://apache.org/cocoon/templates/jx/1.0</code></p>
1.10 +10 -2
cocoon-2.1/src/java/org/apache/cocoon/generation/StreamGenerator.java
Index: StreamGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/StreamGenerator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- StreamGenerator.java 6 Mar 2004 14:24:51 -0000 1.9
+++ StreamGenerator.java 26 May 2004 14:11:34 -0000 1.10
@@ -34,9 +34,17 @@
import java.io.StringReader;
/**
- *
+ * @cocoon.sitemap.component.documentation
* The <code>StreamGenerator</code> is a class that reads XML from a
* request InputStream and generates SAX Events.
+ *
+ * @cocoon.sitemap.component.name stream
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.stream
+ *
+ * @cocoon.sitemap.component.pooling.min 1
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
*
* For the POST requests with a mimetype of
application/x-www-form-urlencoded,
* or multipart/form-data the xml data is expected to be associated with the
1.10 +14 -2
cocoon-2.1/src/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java
Index: XPathDirectoryGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/XPathDirectoryGenerator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- XPathDirectoryGenerator.java 7 May 2004 21:13:50 -0000 1.9
+++ XPathDirectoryGenerator.java 26 May 2004 14:11:34 -0000 1.10
@@ -53,6 +53,18 @@
/**
+ * @cocoon.sitemap.component.documentation
+ * Generates an XML directory listing performing XPath queries on XML files.
It can be used both as a plain
+ * DirectoryGenerator or, by specifying a parameter <code>xpath</code>, it
will perform an XPath query on every XML
+ * resource.
+ *
+ * @cocoon.sitemap.component.name xpathdirectory
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.xpathdirectory
+ * @cocoon.sitemap.component.documentation.caching
+ * Uses the last modification date of the directory and the
contained documents
+ *
+ *
* <p>
* Generates an XML directory listing performing XPath queries on XML files.
It can be used both as a plain
* DirectoryGenerator or, by specifying a parameter <code>xpath</code>, it
will perform an XPath query on every XML
1.9 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/StatusGenerator.java
Index: StatusGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/StatusGenerator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- StatusGenerator.java 20 May 2004 10:48:16 -0000 1.8
+++ StatusGenerator.java 26 May 2004 14:11:34 -0000 1.9
@@ -36,7 +36,17 @@
import org.xml.sax.helpers.AttributesImpl;
/**
+ * @cocoon.sitemap.component.documentation
* Generates an XML representation of the current status of Cocoon.
+ *
+ * @cocoon.sitemap.component.name status
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.status
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
+ *
* Potted DTD:
*
* <code>
1.10 +11 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/RequestGenerator.java
Index: RequestGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/RequestGenerator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- RequestGenerator.java 5 Mar 2004 13:02:55 -0000 1.9
+++ RequestGenerator.java 26 May 2004 14:11:34 -0000 1.10
@@ -37,7 +37,17 @@
import org.xml.sax.helpers.AttributesImpl;
/**
+ * @cocoon.sitemap.component.documentation
* Generates an XML representation of the incoming request.
+ *
+ * @cocoon.sitemap.component.name request
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.request
+ *
+ * @cocoon.sitemap.component.pooling.min 2
+ * @cocoon.sitemap.component.pooling.max 16
+ * @cocoon.sitemap.component.pooling.grow 2
+ *
* <p>
* <b>Configuration options:</b>
* <dl>
1.10 +6 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/LinkStatusGenerator.java
Index: LinkStatusGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/LinkStatusGenerator.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- LinkStatusGenerator.java 28 Mar 2004 14:28:04 -0000 1.9
+++ LinkStatusGenerator.java 26 May 2004 14:11:34 -0000 1.10
@@ -45,7 +45,12 @@
import java.util.ArrayList;
/**
+ * @cocoon.sitemap.component.documentation
* Generates a list of links that are reachable from the src and their
status.
+ *
+ * @cocoon.sitemap.component.name linkstatus
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.linkstatus
*
* @author Michael Homeijer
* @author Nicola Ken Barozzi ([EMAIL PROTECTED])
1.5 +8 -1
cocoon-2.1/src/java/org/apache/cocoon/generation/SessionAttributeGenerator.java
Index: SessionAttributeGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/SessionAttributeGenerator.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SessionAttributeGenerator.java 5 Mar 2004 13:02:55 -0000 1.4
+++ SessionAttributeGenerator.java 26 May 2004 14:11:34 -0000 1.5
@@ -32,6 +32,13 @@
import java.util.Map;
/**
+ * @cocoon.sitemap.component.documentation
+ * Generates a document from a session attribute.
+ *
+ * @cocoon.sitemap.component.name sessionattribute
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.sessionattribute
+ *
* Generates a document from a session attribute. The attribute may be a DOM
* node, an <code>XMLizable</code>, or any other object, and is streamed
using
* the same rules as for <xsp:expr> in XSPs (see [EMAIL PROTECTED]
1.9 +7 -36
cocoon-2.1/src/java/org/apache/cocoon/generation/CalendarGenerator.java
Index: CalendarGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/java/org/apache/cocoon/generation/CalendarGenerator.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- CalendarGenerator.java 19 Apr 2004 15:58:58 -0000 1.8
+++ CalendarGenerator.java 26 May 2004 14:11:34 -0000 1.9
@@ -37,43 +37,14 @@
import org.xml.sax.helpers.AttributesImpl;
/**
+ * @cocoon.sitemap.component.documentation
* Generates an XML document representing a calendar for a given month and
year.
- * <p>
- * Here is a sample output:
- * <pre>
- * <calendar:calendar
xmlns:calendar="http://apache.org/cocoon/calendar/1.0";
- * year="2004" month="January" prevMonth="12" prevYear="2003"
- * nextMonth="02" nextYear="2004">
- * <calendar:week number="1">
- * <calendar:day number="1" date="January 1, 2004"/>
- * <calendar:day number="2" date="January 2, 2004"/>
- * <calendar:day number="3" date="January 3, 2004"/>
- * <calendar:day number="4" date="January 4, 2004"/>
- * </calendar:week>
- * ...
- * </calendar:calendar>
- * </pre>
- * <p>
- * The <i>src</i> parameter is ignored.
- * </p>
- * <p>
- * <b>Configuration options:</b>
- * <dl>
- * <dt> <i>month</i> (optional)
- * <dd> Sets the month for the calendar (January is 1). Default is the
current month.
- * <dt> <i>year</i> (optional)
- * <dd> Sets the year for the calendar. Default is the current year.
- * <dt> <i>dateFormat</i> (optional)
- * <dd> Sets the format for the date attribute of each node, as
- * described in java.text.SimpleDateFormat. If unset, the default
- * format for the current locale will be used.
- * <dt> <i>lang</i> (optional)
- * <dd> Sets the ISO language code for determining the locale.
- * <dt> <i>country</i> (optional)
- * <dd> Sets the ISO country code for determining the locale.
- * </dl>
- * </p>
*
+ * @cocoon.sitemap.component.name calendar
+ * @cocoon.sitemap.component.label content
+ * @cocoon.sitemap.component.logger sitemap.generator.calendar
+ * @cocoon.sitemap.component.documentation.caching TBD
+ *
* @version CVS $Id$
*/
public class CalendarGenerator extends ServiceableGenerator implements
CacheableProcessingComponent {
1.6 +1 -1
cocoon-2.1/src/documentation/xdocs/userdocs/generators/linkstatus-generator.xml
Index: linkstatus-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/linkstatus-generator.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- linkstatus-generator.xml 8 May 2004 08:57:57 -0000 1.5
+++ linkstatus-generator.xml 26 May 2004 14:11:34 -0000 1.6
@@ -17,9 +17,9 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
+ <!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>LinkStatus Generator</title>
- <subtitle>in @doctitle@</subtitle>
<version>0.9</version>
<type>Technical document</type>
<authors>
1.7 +1 -0
cocoon-2.1/src/documentation/xdocs/userdocs/generators/request-generator.xml
Index: request-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/request-generator.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- request-generator.xml 8 May 2004 08:57:57 -0000 1.6
+++ request-generator.xml 26 May 2004 14:11:35 -0000 1.7
@@ -17,6 +17,7 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
+ <!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>Request Generator</title>
<version>0.9</version>
1.6 +1 -0
cocoon-2.1/src/documentation/xdocs/userdocs/generators/status-generator.xml
Index: status-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/status-generator.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- status-generator.xml 8 May 2004 08:57:57 -0000 1.5
+++ status-generator.xml 26 May 2004 14:11:35 -0000 1.6
@@ -17,6 +17,7 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
+ <!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>Status Generator</title>
<version>0.9</version>
1.7 +1 -0
cocoon-2.1/src/documentation/xdocs/userdocs/generators/stream-generator.xml
Index: stream-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/stream-generator.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- stream-generator.xml 8 May 2004 08:57:57 -0000 1.6
+++ stream-generator.xml 26 May 2004 14:11:35 -0000 1.7
@@ -17,6 +17,7 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
+ <!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>Stream Generator</title>
<version>0.9</version>
1.6 +1 -0
cocoon-2.1/src/documentation/xdocs/userdocs/generators/xpathdirectory-generator.xml
Index: xpathdirectory-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.1/src/documentation/xdocs/userdocs/generators/xpathdirectory-generator.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- xpathdirectory-generator.xml 6 Mar 2004 02:25:35 -0000 1.5
+++ xpathdirectory-generator.xml 26 May 2004 14:11:35 -0000 1.6
@@ -17,6 +17,7 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
+ <!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>XPath Directory Generator</title>
<version>1.0</version>
1.1
cocoon-2.1/src/documentation/xdocs/userdocs/generators/calendar-generator.xml
Index: calendar-generator.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 1999-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.0//EN"
"document-v10.dtd">
<document>
<!-- This document will be enhanced by information taken from the javadoc
-->
<header>
<title>Description of the calendar generator</title>
<version>current</version>
<type>Reference</type>
<authors>
<person email="[email protected]" name="The Cocoon Community"/>
</authors>
</header>
<body>
<s1 title="Calendar Generator">
<p>Here is a sample output:</p>
<source>
<calendar:calendar xmlns:calendar="http://apache.org/cocoon/calendar/1.0";
year="2004" month="January" prevMonth="12" prevYear="2003"
nextMonth="02" nextYear="2004">
<calendar:week number="1">
<calendar:day number="1" date="January 1, 2004"/>
<calendar:day number="2" date="January 2, 2004"/>
<calendar:day number="3" date="January 3, 2004"/>
<calendar:day number="4" date="January 4, 2004"/>
</calendar:week>
...
</calendar:calendar>
</source>
<p>The <em>src</em> parameter is ignored.</p>
</s1>
<s1 title="Configuration">
<p>Configuration options:</p>
<ul>
<li><em>month</em> (optional) : Sets the month for the calendar (January
is 1). Default is the current month.</li>
<li><em>year</em> (optional) : Sets the year for the calendar. Default
is the current year.</li>
<li><em>dateFormat</em> (optional) : Sets the format for the date
attribute of each node, as described in
java.text.SimpleDateFormat. If unset, the default format for the
current locale will be used.</li>
<li><em>lang</em> (optional) : Sets the ISO language code for
determining the locale.</li>
<li><em>country</em> (optional) : Sets the ISO country code for
determining the locale.</li>
</ul>
</s1>
</body>
</document>
