From: jprocter <jprocter@compbio.dundee.ac.uk>
Date: Wed, 29 Jun 2011 17:33:37 +0000 (+0100)
Subject: documentation and targets for building a working applet examples
X-Git-Tag: Release_2_7~166
X-Git-Url: http://source.jalview.org/gitweb/?p=jalview.git;a=commitdiff_plain;h=5aad8085fbd06d2e0f6a97d71e8ed58d0e02e6db

documentation and targets for building a working applet examples
directory (JAL-834)
---

diff --git a/build.xml b/build.xml
index a75e4ea..5b1066f 100755
--- a/build.xml
+++ b/build.xml
@@ -134,8 +134,10 @@
 		</path>
 		<property name="source.dist.name" value="${basedir}/jalview-src.tar.gz" />
 		<!-- The Location of the java 1.1.8 jdk -->
-		<property name="java118.home" value="C:\Sun\jdk1.1.8" />
-		<!--<property name="applet.jre.tools" value="${java118.home}/lib/classes.zip" />
+		<!--<property name="java118.home" value="C:\Sun\jdk1.1.8" />
+		-->
+		<property name="java118.home" value="${java.home}" />
+		    <!--<property name="applet.jre.tools" value="${java118.home}/lib/classes.zip" />
 		--><!-- jre for 1.4 version -->
 		<property name="applet.jre.tools" value="${java.home}/lib/rt.jar"/>
 		
@@ -448,7 +450,7 @@
 
 
 	<!-- Compile, package and obfuscate Jalview Applet -->
-	<target name="makeApplet" depends="obfuscate" />
+	<target name="makeApplet" depends="obfuscate" description="assemble the final jalviewLite applet jar with or without obfuscation"/>
 
 	<target name="compileApplet" depends="init,clean">
 		<mkdir dir="${outputDir}" />
@@ -474,7 +476,7 @@
 			</fileset>
 		</jar>
 	</target>
-	<target name="obfuscate" depends="-obfuscatefake,-obfuscatereally" description="construct the final jalviewLite applet jar with or without obfuscation">
+	<target name="obfuscate" depends="-obfuscatefake,-obfuscatereally">
 	</target>
 	<target name="-obfuscatefake" depends="packageApplet" if="donotobfuscate">
 		<copy file="in.jar" tofile="${jalviewLiteJar}" overwrite="true" />
@@ -540,6 +542,10 @@
 				<include name="jalview-jalopy.xml" />
 				<include name="JalviewApplet.jpx" />
 				<include name="JalviewX.jpx" />
+				<include name="nbbuild.xml"/>
+				<include name="nbproject/genfiles.properties"/>
+        <include name="nbproject/project.properties"/>
+        <include name="nbproject/project.xml"/>
 				<include name="${sourceDir}/*.java" />
 				<include name="${sourceDir}/**/*.java" />
 				<include name="${sourceDir}/**/*.cdr" />
@@ -557,7 +563,22 @@
 				<include name="${schemaDir}/**/*" />
 				<include name="utils/**/*" />
 				<include name="${docDir}/**/*" />
+				<include name="examples/**/*" />
 			</tarfileset>
 		</tar>
 	</target>
+	<target name="pubapplet" description="installs the jalviewLite applet and dependent jars into an applet examples directory built under ${outputDir}" depends="makeApplet">
+	  <copy todir="${packageDir}/examples">
+	  <fileset dir="examples">
+	  	<include name="**/*"/>
+	  </fileset>
+	  	<fileset dir=".">
+	  	<include name="jalviewApplet.jar"/>
+	  		</fileset>
+	  	<fileset dir="appletlib">
+	  	      <include name="**/*"/>
+	  	        </fileset>
+	  </copy>
+	  		
+	</target>
 </project>
diff --git a/doc/building.html b/doc/building.html
index 9c09324..5202400 100755
--- a/doc/building.html
+++ b/doc/building.html
@@ -62,7 +62,21 @@ ant makedist
   key)
 </pre>
 
-<p>
+	<p>
+		<strong>Building the JalviewLite applet<br>
+		</strong> The JalviewLite applet is compiled using a subset of the packages in
+		the src directory (specifically: MCView, and jalview.{datamodel,
+		analysis, appletgui, utils, schemes, api, structure}, and
+		com.stevesoft.*). Once compiled, these class files are obfuscated to
+		make the code run efficiently. To compile the applet Jar, use the
+		makeApplet task - optionally passing in a 'donotobfuscate' property to
+		the ant build (e.g. -Ddonotobfuscate=true) to disable obfuscation. </p><p>
+		The ant target 'pubapplet' can be used to compile install the
+		jalviewApplet.jar and any dependent jars (under appletlib) into a copy
+		of the examples directory created under the <em>outputDir</em> build
+		property (which defaults to the 'dist' directory).
+	</p>
+	<p>
 <h1>using IDEs to build Jalview</h1>
 	<p>The Jalview source distribution includes project definitions for
 		Eclipse, Netbeans and some rather ancient Borland JBuilder .jpx
diff --git a/doc/index.html b/doc/index.html
index 8c18340..fcc01fe 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -32,11 +32,12 @@ Jalview Source Documentation
 	information about each task, and there's lots of comments too.</li>
 	<li></li>
 	<li>src - all jalview source packages, including any specially
-	adapted code from other GPL programs. See <a href="developing.html">Jalvew
+	adapted code from other GPL programs. See <a href="developing.html">Jalview
 	Development</a> for more info.</li>
 	<li>lib - All the libraries that Jalview depends on. Every jar
 	file in this directory should be added to the classpath when building
 	or running the jalview application.</li>
+	<li>appletlib - Any libraries that are specifically required for compiling and/or running the jalviewLite applet (e.g. an applet build of Jmol).
 	<li>help - the jalview JavaHelp documents<br>
 	<ul>
 		<li>help.hs - the main index page. This is generated by the
@@ -137,12 +138,11 @@ Jalview Source Documentation
 		documentation.</li>
 	</ul>
 	</li>
-	<li>dist - where the Jars and JNLP file for the java webstart distribution is generated.</li>
 	<li>installAnywhere - where the installAnywhere build is generated</li>
 	<li><em>keys</em> - you might not have this - see <a
 		href="building.html">building</a> for info on how to create it.</li>
-</ul>
-</li>
+<li>dist - where the Jars and JNLP file for the java webstart distribution is generated, and where a copy of the examples directory is created complete with jalviewApplet.jar and the contents of appletlib/*.jar.</li>
+<li>examples - a set of example jalview projects and web pages demonstrating the jalviewLite applet. This is essentially mirrors the <a href="http://www.jalview.org/examples/">www.jalview.org/examples</a> directory on Jalview's website.</li>
 <li>nbbuild.xml - custom config used by the vanilla netbeans project in nbproject</li>
 <li>nbproject - vanilla netbeans project</li>
 <li>JalviewApplet.jpx, JalviewX.jpx - old JBuilder project files</li>