Author: veithen Date: Wed Jul 21 07:23:06 2010 New Revision: 966119 URL: http://svn.apache.org/viewvc?rev=966119&view=rev Log: Simplifying the Maven site, step 2: use Velocity templates (which are directly supported by the Maven site plugin) instead of ant to substitute the axis2_version variable in Xdocs.
Added: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml.vm - copied, changed from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml.vm - copied, changed from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml.vm - copied, changed from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml.vm - copied, changed from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml.vm - copied, changed from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml Removed: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml Modified: axis/axis2/java/core/trunk/modules/documentation/pom.xml Modified: axis/axis2/java/core/trunk/modules/documentation/pom.xml URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/pom.xml?rev=966119&r1=966118&r2=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/pom.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/pom.xml Wed Jul 21 07:23:06 2010 @@ -224,6 +224,13 @@ </dependency> </dependencies> + <properties> + <!-- This variable is used in some Xdocs and is substituted using Velocity. Note that + we can't use the project.version variable directly because of the dot. See + http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html --> + <axis2_version>${project.version}</axis2_version> + </properties> + <build> <plugins> <plugin> Copied: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml.vm (from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml) URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml.vm?p2=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml.vm&p1=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml&r1=966113&r2=966119&rev=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/contents.xml.vm Wed Jul 21 07:23:06 2010 @@ -25,12 +25,12 @@ "HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /> <meta http-equiv="content-type" content= "text/html; charset=us-ascii" /> -<title>Axis2/Java @axis2_version@ Documentation Home</title> +<title>Axis2/Java ${axis2_version} Documentation Home</title> <link href="../css/axis-docs.css" rel="stylesheet" type="text/css" media="all" /> </head> <body lang="en" xml:lang="en"> -<h1>Apache Axis2/Java Version @axis2_version@ Documentation +<h1>Apache Axis2/Java Version ${axis2_version} Documentation Index</h1> <h2>Introduction</h2> <p>Apache Axis2, the third generation Web services engine is more @@ -39,7 +39,7 @@ efficient, more modular and more XML-ori carefully designed to support the easy addition of plug-in modules that extend its functionality for features such as security and increased reliability.</p> -<p>Apache Axis2 Version @axis2_version@ is a bugfix release, fixing several +<p>Apache Axis2 Version ${axis2_version} is a bugfix release, fixing several problems in version 1.5. Please see the release notes for more details.</p> <p>This page describes our list of available documents.</p> Copied: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml.vm (from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml) URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml.vm?p2=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml.vm&p1=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml&r1=966113&r2=966119&rev=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/installationguide.xml.vm Wed Jul 21 07:23:06 2010 @@ -82,7 +82,7 @@ focus on running Apache Axis2 using the Distribution.</p> <p><a href="../download.cgi"> Download</a> distribution packages of the Apache Axis2 -...@axis2_version@ version (latest).</p> +${axis2_version} version (latest).</p> <p><a href="http://ws.apache.org/axis2/download.cgi">Download</a> distribution packages of all versions of Apache Axis2.</p> <p>The distribution packages provided are as follows:</p> @@ -182,7 +182,7 @@ directory into which you installed the J Axis2 Standard Binary Distribution</a> into a convenient location so that the distribution resides in its own directory. Set an environment variable AXIS2_HOME to the pathname of the extracted -directory of Axis2 (Eg: /opt/axi...@axis2_version@). Linux users +directory of Axis2 (Eg: /opt/axis2-${axis2_version}). Linux users can alternatively run the setenv.sh file available in the AXIS2_HOME/bin directory to set the AXIS2_HOME environment variable to the Axis2 classpath.</p> Copied: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml.vm (from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml) URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml.vm?p2=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml.vm&p1=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml&r1=966113&r2=966119&rev=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/pojoguide.xml.vm Wed Jul 21 07:23:06 2010 @@ -233,17 +233,17 @@ builds a JAR at <em>build/lib/rpc-client the client</li> </ul> <p>Before you can build the source, you'll need to download the -Axis2 @axis2_vers...@-bin and @axis2_vers...@-war distributions +Axis2 ${axis2_version}-bin and ${axis2_version}-war distributions from <a href= "../download.cgi">here</a>. Then modify the following line inside the build.xml file (in the Axis2_HOME/samples/pojoguide directory in the extracted Axis2 -...@axis2_version@ Standard Binary (bin) Distribution) :</p> +${axis2_version} Standard Binary (bin) Distribution) :</p> <pre> <property name="axis2.home" value="c:\apps\axis2" /> </pre> <p>This modification contains the path to the root of the unzipped -Axis2 @axis2_vers...@-bin <a href= +Axis2 ${axis2_version}-bin <a href= "../download.cgi">download</a>. With that explanation, you'll now build the source by typing the following: ant</p> @@ -265,7 +265,7 @@ development.</p> <p>Now get a <a href="http://tomcat.apache.org/">Tomcat</a> distribution (I used v5.5), and start it up by running <em>bin/startup.bat</em> or <em>bin/startup.sh</em>. Once it's -running, deploy the Axis2 @axis2_vers...@-war by copying the +running, deploy the Axis2 ${axis2_version}-war by copying the axis2.war file to Tomcat's webapps directory. Tomcat will proceed by deploying axis2 and un-archiving it into the webapps directory. Now copy the WeatherService directory that was created at the time @@ -561,7 +561,7 @@ ready for our WeatherSpringService.</p> <h3>Build and Deploy Using Apache Axis2 and Tomcat</h3> <p>Your POJO is now ready for primetime within the Spring Framework. Before you build, you'll first need to make sure the -axis2-spri...@axis2_version@.jar and spring.jar files are in the +axis2-spring-${axis2_version}.jar and spring.jar files are in the project's <em>Axis2_HOME/lib</em> directory.</p> <p><strong>Note:</strong> The service will not deploy if you add the above .jar files to the service archive due to class loding @@ -587,7 +587,7 @@ at startup.</p> client:</p> <pre> run.client: - [javac] Compiling 1 source file to C:\axi...@axis2_version@\samples\pojoguidespring\build\cl + [javac] Compiling 1 source file to C:\axis2-${axis2_version}\samples\pojoguidespring\build\cl asses <b>[java] Temperature : 89.9 [java] Forecast : Sunny Copied: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml.vm (from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml) URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml.vm?p2=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml.vm&p1=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml&r1=966113&r2=966119&rev=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/soapmonitor-module.xml.vm Wed Jul 21 07:23:06 2010 @@ -138,9 +138,9 @@ code to the web.xml (The SOAPMonitorPort <p>Finally, the applet classes must be placed into the Web application so that they can be loaded by the Web browser. You can get the compiled applet -classes from the WEB-INF/lib/soapmonitor-servl...@axis2_version@.jar which is inside +classes from the WEB-INF/lib/soapmonitor-servlet-${axis2_version}.jar which is inside the extracted axis2.war. To extract the content of the file, simply -execute the command, <code>jar -xf soapmonitor-servl...@axis2_version@.jar</code>. +execute the command, <code>jar -xf soapmonitor-servlet-${axis2_version}.jar</code>. The applet code is in the org.apache.axis2.soapmonitor.applet package and therefore the 'org' directory created by the unpacking of JAR file should be placed in <CATALINA_HOME>/webapps/axis2/.</p> Copied: axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml.vm (from r966113, axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml) URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml.vm?p2=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml.vm&p1=axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml&r1=966113&r2=966119&rev=966119&view=diff ============================================================================== --- axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml (original) +++ axis/axis2/java/core/trunk/modules/documentation/xdocs/docs/userguide-buildingservices.xml.vm Wed Jul 21 07:23:06 2010 @@ -425,7 +425,7 @@ Service</h3> <pre> java org.apache.axis2.wsdl.WSDL2Java -uri file:///C:/apps/axis2/samples/zSample/Axis2UserGuide.wsdl -p -org.apache.axis2.axis2userguide -d adb -s -wv @axis2_version@ -ss -sd +org.apache.axis2.axis2userguide -d adb -s -wv ${axis2_version} -ss -sd </pre> <p>Note: Make sure all the .jar files in the Axis2 lib directory is set to the CLASSPATH before you run the above code.</p> @@ -439,19 +439,19 @@ to use the Axis2 DataBinding Framework, only synchronous or blocking code (-s), and to generate server-side code (-ss) as opposed to a client, including the services.xml service descriptor file (-sd). It also specifies version -...@axis2_version@ for the WSDL file (-wv)<strong>.</strong></p> +${axis2_version} for the WSDL file (-wv)<strong>.</strong></p> <p><strong>Code Listing 14.2:</strong></p> <p>You can also use the following script files to achieve the same. In this case you do not have the set the CLASSPATH manually.</p> <p>For Linux:</p> <pre> $AXIS2_HOME/bin/wsdl2java.sh -uri file:///C:/apps/axis2/samples/zSample/Axis2UserGuide.wsdl --p org.apache.axis2.axis2userguide -o target_directory_name -d adb -s -wv @axis2_version@ -ss -sd +-p org.apache.axis2.axis2userguide -o target_directory_name -d adb -s -wv ${axis2_version} -ss -sd </pre> <p>For MS Windows:</p> <pre> %AXIS2_HOME%\bin\wsdl2java.bat -uri file:\\\C:\apps\axis2\samples\zSample\Axis2UserGuide.wsdl --p org.apache.axis2.axis2userguide -o target_directory_name -d adb -s -wv @axis2_version@ -ss -sd +-p org.apache.axis2.axis2userguide -o target_directory_name -d adb -s -wv ${axis2_version} -ss -sd </pre> <p>In both instances, at this point, you should see four new items in your chosen directory: the build.xml file, which includes