Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 9761 invoked from network); 8 Jan 2006 08:31:53 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 8 Jan 2006 08:31:53 -0000 Received: (qmail 73345 invoked by uid 500); 8 Jan 2006 08:31:52 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 73297 invoked by uid 500); 8 Jan 2006 08:31:52 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 73286 invoked by uid 99); 8 Jan 2006 08:31:52 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 08 Jan 2006 00:31:52 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Sun, 08 Jan 2006 00:31:51 -0800 Received: (qmail 9671 invoked by uid 65534); 8 Jan 2006 08:31:31 -0000 Message-ID: <20060108083131.9668.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r367010 - /cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ Date: Sun, 08 Jan 2006 08:31:26 -0000 To: cvs@cocoon.apache.org From: antonio@apache.org X-Mailer: svnmailer-1.0.5 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: antonio Date: Sun Jan 8 00:31:18 2006 New Revision: 367010 URL: http://svn.apache.org/viewcvs?rev=367010&view=rev Log: Fix javadocs. Add @version. Set final to static 2 constants. Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ContextPathModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/FlowAttributeModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/XMLMetaModule.java Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/BaseLinkModule.java Sun Jan 8 00:31:18 2006 @@ -30,10 +30,10 @@ * ../../ etc) to the base of the current request or sitemap URI. For * instance, if called within a <map:match pattern="a/b/c.xsp"> pipeline, * {baselink:SitemapBaseLink} would evaluate to ../../. + * + * based on {@link RequestURIModule} * * @author Torsten Knodt - * based on RequestURIModule - * */ public class BaseLinkModule extends AbstractInputModule implements ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ContextPathModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ContextPathModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ContextPathModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ContextPathModule.java Sun Jan 8 00:31:18 2006 @@ -54,24 +54,26 @@ *

- * 
- *    
- * 
+ * <map:transform src="skins/{forrest:skin}/xslt/fo/document2fo.xsl">
+ *    <map:parameter name="basedir" value="{contextpath:resources}/"/>
+ * </map:transform>
+ *

* * And then prepend this to all image paths: + *

  *  ...
- *  
+ *  <xsl:param name="basedir" select="''"/>
  *  ...
- *  
- *      
- *      
+ *  </xsl:template>
  *

* * @author Giacomo Pati - * @version $Id$ + * @version $Id: ContextPathModule.java 359191 2005-12-27 08:51:54Z cziegeler $ */ public class ContextPathModule extends AbstractInputModule implements Serviceable, ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsMetaModule.java Sun Jan 8 00:31:18 2006 @@ -26,9 +26,9 @@ /** * Old name for {@link DefaultsModule}. - * @deprecated Use DefaultsModule instead; this is not a 'meta' module and is + * @deprecated Use {@link DefaultsModule} instead; this is not a 'meta' module and is * thus misnamed. - * @version CVS $Id: DefaultsMetaModule.java,v 1.4 2004/03/05 13:02:48 bdelacretaz Exp $ + * @version $Id$ */ /* Deprecated 2003-03-19. Suggest we keep this class for compat with 2.0.x Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/DefaultsModule.java Sun Jan 8 00:31:18 2006 @@ -32,15 +32,17 @@ * Set a number of constants. To override the values with input from * another module, combine this one with the ChainMetaModule and an * arbitrary number of other modules. - * + * + *

  * <values>
  *  <skin>myskin</skin>
  *  <base>baseurl</base>
  *  ...
  * </values>
- *
+ *

+ * * @author Christian Haul - * @version CVS $Id: DefaultsModule.java,v 1.5 2004/03/05 13:02:48 bdelacretaz Exp $ + * @version $Id$ */ public class DefaultsModule extends AbstractLogEnabled implements InputModule, Configurable, ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/FlowAttributeModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/FlowAttributeModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/FlowAttributeModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/FlowAttributeModule.java Sun Jan 8 00:31:18 2006 @@ -27,7 +27,7 @@ * object is not found then an exception will be thrown. * * @author Daniel Fagerstrom - * @version CVS $Id$ + * @version $Id$ */ public class FlowAttributeModule extends AbstractJXPathModule implements ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/ProjectPathModule.java Sun Jan 8 00:31:18 2006 @@ -32,43 +32,46 @@ * ProjectPathModule provides relative and absolute paths with regards to the root of a project. *

Config: *

- *    
- *      	my/project/
- *    
+ *    <component-instance logger="core.modules.input"
+ *           name="myproject"
+ *           class="org.apache.cocoon.components.modules.input.ProjectPathModule">
+ *          <uri-prefix>my/project/</uri-prefix>
+ *    </component-instance>
  *

Usage: *

- * 
- *    
- * 
- *
+ *    <map:transform src="skins/{forrest:skin}/xslt/fo/document2html.xsl">
+ *       <map:parameter name="base" value="{myproject:relative}"/>
+ *    </map:transform>
+ *

* And then prepend this to all image paths: + *

  *  ...
- *  
+ *  <xsl:param name="base"/>
  *  ...
- *  
- *      
+ *  </xsl:template>
  *

* Then if you are in my/project/some/folder/page.html, the image will have a relative path bact to the root of the project. *

- *   
+ *   <img src="../../imagename.png"/>
  *

* Using 'myproject:path' would have given you: /some/folder/page.html
* Using 'myproject:folder' would have given you: /some/folder/ *

+ * + * @version $Id$ * */ public class ProjectPathModule extends AbstractInputModule implements Configurable, ThreadSafe { - protected static String PROJECT_PARAM_NAME = "uri-prefix"; - protected static String PROJECT_PARAM_DEFAULT = "/"; + protected static final String PROJECT_PARAM_NAME = "uri-prefix"; + protected static final String PROJECT_PARAM_DEFAULT = "/"; protected String projectBase; Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/PropertiesFileModule.java Sun Jan 8 00:31:18 2006 @@ -39,6 +39,7 @@ *

* * @author Unico Hommes + * @version $Id$ */ public class PropertiesFileModule extends AbstractJXPathModule implements InputModule, Serviceable, Configurable, ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLDecodeModule.java Sun Jan 8 00:31:18 2006 @@ -30,6 +30,8 @@ * <map:generate src="http://remote/page?param1={url-encode:{request-param:param1}}"/>
* Module configuration takes only one configuration parameter: * "encoding" which is a target string encoding. This is utf-8 by default. + * + * @version $Id$ */ public final class URLDecodeModule extends AbstractInputModule implements ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/URLEncodeModule.java Sun Jan 8 00:31:18 2006 @@ -30,6 +30,8 @@ * <map:generate src="http://remote/page?param1={url-encode:{request-param:param1}}"/>
* Module configuration takes only one configuration parameter: * "encoding" which is a target string encoding. This is utf-8 by default. + * + * @version $Id$ */ public final class URLEncodeModule extends AbstractInputModule implements ThreadSafe { Modified: cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/XMLMetaModule.java URL: http://svn.apache.org/viewcvs/cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/XMLMetaModule.java?rev=367010&r1=367009&r2=367010&view=diff ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/XMLMetaModule.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/java/org/apache/cocoon/components/modules/input/XMLMetaModule.java Sun Jan 8 00:31:18 2006 @@ -90,7 +90,7 @@ *

Produces Objects of type {@link org.apache.cocoon.xml.dom.DocumentWrapper DocumentWrapper}

* * @author Christian Haul - * @version CVS $Id: XMLMetaModule.java,v 1.4 2004/03/05 13:02:48 bdelacretaz Exp $ + * @version $Id$ */ public class XMLMetaModule extends AbstractMetaModule implements ThreadSafe {