[Openpcl-svncommits] SF.net SVN: openpcl: [182] openpcl/build.xml

[<doc...@us...>]

Revision: 182
          http://openpcl.svn.sourceforge.net/openpcl/?rev=182&view=rev
Author:   documentsystems
Date:     2007-10-30 15:47:39 -0700 (Tue, 30 Oct 2007)

Log Message:
-----------
Howard Hoagland. Changed to use mixed case for project name in the generated JavaDoc but use lowercase project name for the jar file name. Removed the jdom.jar file. Changed alot of other lines for clarity.

Modified Paths:
--------------
    openpcl/build.xml

Modified: openpcl/build.xml
===================================================================
--- openpcl/build.xml	2007-10-30 22:42:39 UTC (rev 181)
+++ openpcl/build.xml	2007-10-30 22:47:39 UTC (rev 182)
@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="ISO-8859-1"?>
-<project name="openpcl" default="all">
+<project name="OpenPCL" default="all">
 
-	<property name="project.name" value="openpcl"/>
+	<property name="lowercase.project.name" value="openpcl"/>
 	<property name="lib.dir" value="lib"/>
 	<property name="src.dir" value="src"/>
 	<property name="build.dir" value="build"/>
 	
-	<property name="doc.dir" value="doc"/>
-	<property name="javadoc.dir" value="${doc.dir}/api"/>
+	<property name="doc.dir" value="docs"/>
+	<property name="api.dir" value="${doc.dir}/api"/>
 
 	<property name="rel.dir" value="rel"/>
 	<property name="rel.website.dir" value="${rel.dir}/website"/>
@@ -27,19 +27,16 @@
 	<property name="izpack.dir" value="c:/program files/izpack"/>
 	<property name="jsmooth.dir" value="c:/program files/jsmooth"/>
 
-	<!--
-	Keystore information for signing applet jar
-	The keystore file included in this project is a test one and it might need to get
-	regenerated every six months.  The way to do this is to do the following:
-	> cd ${src.localinstaller.dir}
-	> keytool -genkey -alias ${project.name} -keystore ${project.name}.keystore
-	> ** password is also ${project.name} **
-	> keytool -export -alias project -rfc -file sig.x509
-	-->
+	<!-- Keystore information for signing applet jar
+			The keystore file included in this project is a test one and it might need to get
+			regenerated every six months.  The way to do this is to do the following:
+	> keytool -genkey -alias ${keystore.alias} -keystore ${keystore.file}
+	> ** password is also ${keystore.alias} **
+	> keytool -export -alias project -rfc -file sig.x509 -->
 
-	<property name="keystore.alias" value="${project.name}"/>
-	<property name="keystore.file" value="${project.name}.keystore"/>
-	<property name="keystore.password" value="${project.name}"/>
+	<property name="keystore.alias" value="${lowercase.project.name}"/>
+	<property name="keystore.file" value="${keystore.alias}.keystore"/>
+	<property name="keystore.password" value="${keystore.alias}"/>
 	
 	<!-- 
 	1) Build an cross-platform installer using IzPack (Windows, Unix) 
@@ -80,6 +77,7 @@
 	<!-- jar.pclrenderimage -->
 	<target name="jar.pclrenderimage" depends="compile" 
 		description="Build pclrenderimage.jar for server side only (no OpenPCLViewer UI class files)">
+		<!-- The pclrenderimage.jar file is built unsigned in the lib dir -->
 		<jar jarfile="${lib.dir}/pclrenderimage.jar">
 			<fileset dir="${build.dir}" includes="${pclrenderimage.dir}/**/*.class"/>
 		</jar>
@@ -87,9 +85,10 @@
 	</target>
 
 	<!-- jar.openpcl -->
-	<target name="jar.openpcl" depends="jar.pclrenderimage" description="Build openpcl.jar">
-		<!-- openpcl.jar is built unsigned in the lib dir -->
-		<jar jarfile="${lib.dir}/${project.name}.jar">
+	<target name="jar.openpcl" depends="jar.pclrenderimage" 
+		description="Build openpcl.jar has all the UI class files and all the pclrenderimage class files">
+		<!-- The openpcl.jar file is built unsigned in the lib dir -->
+		<jar jarfile="${lib.dir}/${lowercase.project.name}.jar">
 			<fileset dir="${build.dir}" includes="**/*.class"/>
 			<fileset dir="${src.dir}" includes="**/viewer/images/**"/>
 			<fileset dir="${src.dir}" includes="**/htmlfiles/**"/>
@@ -103,11 +102,10 @@
 		description="Copies .jar files from lib to rel and signs the jar files in rel">
 		<!-- Make the release directory -->
     <mkdir dir="${rel.dir}"/>
-		<!-- Copy the 4 unsigned .jar files from lib to rel -->
+		<!-- Copy the 3 unsigned .jar files from lib to rel -->
     <copy todir="${rel.dir}">
 	    <fileset dir="${lib.dir}" includes="openpcl.jar"/>
 	    <fileset dir="${lib.dir}" includes="pclrenderimage.jar"/>
-	    <fileset dir="${lib.dir}" includes="jdom.jar"/>
 	    <fileset dir="${lib.dir}" includes="TableLayout.jar"/>
     </copy>
 		<!-- Sign the jars -->
@@ -121,11 +119,17 @@
 
 	<!-- javadoc -->
 	<target name="javadoc" depends="applet" description="Builds JavaDoc API files">
-		<mkdir dir="${javadoc.dir}"/>
-		<javadoc packagenames="com.${project.name}.*" sourcepath="${src.dir}"
-				 defaultexcludes="yes" destdir="${javadoc.dir}" author="true"
-         version="true" use="true" classpathref="classpath" windowtitle="${project.name}">
-			<doctitle><![CDATA[<h1>${project.name}</h1>]]></doctitle>
+		<mkdir dir="${api.dir}"/>
+		<javadoc packagenames="com.${lowercase.project.name}.*"
+				sourcepath="${src.dir}"
+				defaultexcludes="yes"
+				destdir="${api.dir}"
+				author="true"
+				version="true"
+				use="true"
+				classpathref="classpath"
+				windowtitle="${ant.project.name} API">
+			<doctitle><![CDATA[<h1>${ant.project.name}</h1>]]></doctitle>
 			<bottom><![CDATA[<i>OpenPCL <a href="http://www.openpcl.com">http://www.openpcl.com</a></i>]]></bottom>
 			<tag name="todo" scope="all" description="To do:"/>
 			<link href="http://java.sun.com/j2se/1.5.0/docs/api/"/>
@@ -133,23 +137,25 @@
 		<echo>Finished OpenPCL Ant build.xml "javadoc" target.</echo>
 	</target>	
 
-	<!-- release -->
-	<target name="release" depends="javadoc" description="Creates the zip file that contains everything">
-		<!-- Create a zip file with everything -->
-		<zip destfile="${rel.dir}/${project.name}.zip" update="true">
-			<zipfileset file="build.xml" prefix="${project.name}"/>
-			<zipfileset file="${project.name}.keystore" prefix="${project.name}"/>
-			<zipfileset dir="${doc.dir}" prefix="${project.name}/${doc.dir}"/>
-			<zipfileset dir="${lib.dir}" prefix="${project.name}/${lib.dir}" includes="*.jar"/>
-			<zipfileset dir="${src.dir}" prefix="${project.name}/${src.dir}" excludes="**/izpackdoc/**,**/jsmoothdoc/**"/>
+	<!-- makezipfile -->
+	<target name="makezipfile" depends="javadoc" 
+		description="Creates the zip file of the source code and JavaDoc">
+		<zip destfile="${rel.dir}/${lowercase.project.name}.zip" update="true">
+			<zipfileset file="build.xml" prefix="${lowercase.project.name}"/>
+			<zipfileset file=".classpath" prefix="${lowercase.project.name}"/>
+			<zipfileset file="${keystore.alias}.keystore" prefix="${lowercase.project.name}"/>
+			<zipfileset dir="${doc.dir}" prefix="${lowercase.project.name}/${doc.dir}"/>
+			<zipfileset dir="${lib.dir}" prefix="${lowercase.project.name}/${lib.dir}" includes="*.jar"/>
+			<zipfileset dir="${rel.dir}" prefix="${lowercase.project.name}/${rel.dir}" includes="*.jar"/>
+			<zipfileset dir="${src.dir}" prefix="${lowercase.project.name}/${src.dir}" excludes="**/izpackdoc/**,**/jsmoothdoc/**"/>
 		</zip>
 		<echo>To create the installer, download IzPack from (http://www.izforge.com/izpack)</echo>
 		<echo>Installed? ${izpack.installed}</echo>
-		<echo>Finished OpenPCL Ant build.xml "release" target.</echo>
+		<echo>Finished OpenPCL Ant build.xml "makezipfile" target.</echo>
 	</target>
 	
 	<!-- installer -->
-	<target name="installer" depends="" if="izpack.installed">
+	<target name="installer" depends="" description="Make a self install .jar file" if="izpack.installed">
 		<!-- Task definition for IzPack (creates an installer jar) -->
 		<taskdef name="izpack" classname="com.izforge.izpack.ant.IzPackTask" classpath="${izpack.dir}/lib/compiler.jar"/>	
 		<!-- Use IzPack to create an installer jar file (cross-platform), do not bundle JRE here -->
@@ -175,10 +181,10 @@
 	
 	<!-- website -->
 	<target name="website" depends="installer-windows" description="Copies files to put in the project website">
-		<!-- Make sure the directory is created -->
 		<delete dir="${rel.website.dir}"/>
 		<mkdir dir="${rel.website.dir}"/>
-		<!-- Copy the everything in rel -->
+		
+		<!-- Copy from rel -->
 	    <copy todir="${rel.website.dir}">
 			<fileset dir="${rel.dir}" excludes="website/**"/>
 	    </copy>
@@ -189,6 +195,7 @@
 			<fileset dir="${src.data.dir}"/>
 	    </copy>
 		<!-- Copy the everything in doc -->
+			<mkdir dir="${rel.website.dir}/${doc.dir}"/>
 	    <copy todir="${rel.website.dir}/${doc.dir}">
 			<fileset dir="${doc.dir}"/>
 	    </copy>
@@ -196,7 +203,7 @@
     	<echo>Upload the contents of ${rel.website.dir} to the project website</echo>
 	</target>
 	
-	<target name="all" depends="release" description="clean, compile, jar, applet, javadoc, release">
+	<target name="all" depends="makezipfile" description="clean, compile, jar, applet, javadoc, makezipfile">
 	</target>
 
 </project>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.