joerg 2004/03/05 16:07:02
Modified: src/java/org/apache/cocoon/generation VelocityGenerator.java
src/documentation/xdocs/userdocs/generators
velocity-generator.xml
Log:
bug 18116: fix documentation: property/@key => property/@name
Revision Changes Path
1.2 +16 -20
cocoon-2.0/src/java/org/apache/cocoon/generation/VelocityGenerator.java
Index: VelocityGenerator.java
===================================================================
RCS file:
/home/cvs/cocoon-2.0/src/java/org/apache/cocoon/generation/VelocityGenerator.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- VelocityGenerator.java 9 Mar 2003 00:02:59 -0000 1.1
+++ VelocityGenerator.java 6 Mar 2004 00:07:02 -0000 1.2
@@ -83,6 +83,7 @@
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.runtime.RuntimeServices;
import org.apache.velocity.runtime.log.LogSystem;
+import org.apache.velocity.runtime.resource.Resource;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
@@ -117,7 +118,7 @@
* Child Elements:
*
* <dl>
- * <dt><property key="propertyKey" value="propertyValue"/> (optional;
0..n)</dt>
+ * <dt><property name="propertyName" value="propertyValue"/>
(optional; 0..n)</dt>
* <dd>An additional property to pass along to the Velocity template
* engine during initialization</dd>
*
@@ -159,11 +160,6 @@
* </dl>
* </p>
*
- * <p> Additional Java objects can be exported from the Cocoon object
- * map to the Velocity context by adding one or more <export-object
- * key="objectMapKey" name="velocityContextName"/> child elements
- * to the generator configuration in the sitemap.</p>
- *
* @author <a href="mailto:[EMAIL PROTECTED]">Davanum Srinivas</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Michael McKibben</a>
* @version CVS $Id$
@@ -195,8 +191,8 @@
* 'context' property is not set.
* @throws ClassCastException if the 'context' property is not
* of type [EMAIL PROTECTED] Context}.
- * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#init
- */
+ * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#init(ExtendedProperties)
+ */
public void init(ExtendedProperties config)
{
this.resolverContext = (Context)config.get("context");
@@ -208,7 +204,7 @@
/**
* @param systemId the path to the resource
- * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#getResourceStream
+ * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#getResourceStream(String)
*/
public InputStream getResourceStream(String systemId) throws
org.apache.velocity.exception.ResourceNotFoundException
{
@@ -227,9 +223,9 @@
}
/**
- * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified
+ * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(Resource)
*/
- public boolean
isSourceModified(org.apache.velocity.runtime.resource.Resource resource)
+ public boolean isSourceModified(Resource resource)
{
long lastModified = 0;
try
@@ -245,7 +241,7 @@
}
/**
- * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified
+ * @see
org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(Resource)
*/
public long
getLastModified(org.apache.velocity.runtime.resource.Resource resource)
{
@@ -327,7 +323,7 @@
* from the configuration.
*
* @param configuration the class configurations.
- * @see org.apache.avalon.framework.configuration.Configurable#configure
+ * @see
org.apache.avalon.framework.configuration.Configurable#configure(Configuration)
*/
public void configure(Configuration configuration) throws
ConfigurationException
{
@@ -418,7 +414,7 @@
}
/**
- * @see org.apache.avalon.framework.activity.Initializable#initialize
+ * @see org.apache.avalon.framework.activity.Initializable#initialize()
*/
public void initialize() throws Exception
{
@@ -426,7 +422,7 @@
}
/**
- * @see org.apache.cocoon.sitemap.SitemapModelComponent#setup
+ * @see
org.apache.cocoon.sitemap.SitemapModelComponent#setup(SourceResolver, Map,
String, Parameters)
*/
public void setup(SourceResolver resolver, Map objectModel, String src,
Parameters params) throws ProcessingException,SAXException,IOException
{
@@ -478,7 +474,7 @@
* Free up the VelocityContext associated with the pipeline, and
* release any Source objects resolved by the resource loader.
*
- * @see org.apache.avalon.excalibur.pool.Recyclable#recycle
+ * @see org.apache.avalon.excalibur.pool.Recyclable#recycle()
*/
public void recycle()
{
@@ -501,7 +497,7 @@
/**
* Generate XML data using Velocity template.
*
- * @see org.apache.cocoon.generation.Generator#generate
+ * @see org.apache.cocoon.generation.Generator#generate()
*/
public void generate()
throws IOException, SAXException, ProcessingException
@@ -547,7 +543,7 @@
/**
* This implementation does nothing.
*
- * @see org.apache.velocity.runtime.log.LogSystem#init
+ * @see org.apache.velocity.runtime.log.LogSystem#init(RuntimeServices)
*/
public void init(RuntimeServices rs) throws Exception
{
@@ -556,7 +552,7 @@
/**
* Pass along Velocity log messages to our configured logger.
*
- * @see org.apache.velocity.runtime.log.LogSystem#logVelocityMessage
+ * @see
org.apache.velocity.runtime.log.LogSystem#logVelocityMessage(int, String)
*/
public void logVelocityMessage(int level, String message)
{
1.2 +1 -8
cocoon-2.0/src/documentation/xdocs/userdocs/generators/velocity-generator.xml
Index: velocity-generator.xml
===================================================================
RCS file:
/home/cvs/cocoon-2.0/src/documentation/xdocs/userdocs/generators/velocity-generator.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- velocity-generator.xml 9 Mar 2003 00:01:13 -0000 1.1
+++ velocity-generator.xml 6 Mar 2004 00:07:02 -0000 1.2
@@ -67,7 +67,7 @@
</p>
<dl>
- <dt><property key="propertyKey" value="propertyValue"/>
+ <dt><property name="propertyName" value="propertyValue"/>
(optional; 0..n)</dt>
<dd>
An additional property to pass along to the Velocity template
@@ -116,13 +116,6 @@
<dt>parameters (org.apache.avalon.framework.parameters.Parameters)</dt>
<dd>Any parameters passed to the generator in the pipeline</dd>
</dl>
-
- <p>
- Additional Java objects can be exported from the Cocoon object
- map to the Velocity context by adding one or more <export-object
- key="objectMapKey" name="velocityContextName"/> child elements
- to the generator configuration in the sitemap.
- </p>
</s2>
</s1>
