Recent changes to 2_-_Setup

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:09 -0000

--- v26
+++ v27
@@ -1,9 +1,12 @@
+[TOC]
+
+## Prerequisites
+
 This _How To_ assumes you have some experience with Java programming and have installed the following:

   * JDK 1.6 or higher <http://java.sun.com/j2se/1.5.0/download.jsp>
   * Apache Ant <http://ant.apache.org>
   * Xena <http://xena.sourceforge.net>. 
-[TOC]

 ## New file format

@@ -79,48 +82,53 @@

 4\. Create the compile path, to be used when compiling our plugins: 

+    
     <path id="compile.path">
-    <pathelement location="${xenajarlocation}"/>
+            <pathelement location="${xenajarlocation}"/>
     </path>

 5\. Add the _init_ and _clean_ targets: 

+    
     <target name="init" description="Create output directories">
-    <mkdir dir="${builddir}"/>
-    <mkdir dir="${distdir}"/>
-    </target>
+            <mkdir dir="${builddir}"/>
+            <mkdir dir="${distdir}"/>
+    </target>
+    
     <target name="clean" depends="init" description="--> Clear all output files">
-    <delete dir="${builddir}"/>
-    <delete dir="${distdir}"/>
+            <delete dir="${builddir}"/>
+            <delete dir="${distdir}"/>
     </target>

 Then the actual compile job itself, broken into a couple of lines. 

+    
     <target name="compile" depends="init" description="-->Compile the .java sources">
-    <javac srcdir="${srcdir}" destdir="${builddir}" debug="on"
-    verbose="on" classpathref="compile.path"/>
+                    <javac srcdir="${srcdir}" destdir="${builddir}" debug="on"
+                            verbose="on" classpathref="compile.path"/>
     </target>

 6\. Add the _makejar_ job: 

+    
     <target name="makejar" description="-->Make the jar file" depends="compile">
-    <delete >
-    <fileset file="${distdir}/${pluginname}.jar"/>
-    </delete>
-    <jar jarfile="${distdir}/${pluginname}.jar" manifest="etc/MANIFEST.MF">
-    <fileset dir="${builddir}">
-    <include name="**/*.class"/>
-    </fileset>
-    <fileset dir=".">
-    <include name = "name.properties"/>
-    </fileset>
-    <fileset dir="${srcdir}">
-    <include name = "**/*.properties"/>
-    </fileset>
-    </jar>
+            <delete >
+                    <fileset file="${distdir}/${pluginname}.jar"/>
+            </delete>
+            <jar jarfile="${distdir}/${pluginname}.jar" manifest="etc/MANIFEST.MF">
+                    <fileset dir="${builddir}">
+                            <include name="**/*.class"/>
+                    </fileset>
+                    <fileset dir=".">
+                            <include name = "name.properties"/>
+                    </fileset>
+                    <fileset dir="${srcdir}">
+                            <include name = "**/*.properties"/>
+                    </fileset>
+            </jar>
     </target>

@@ -140,18 +148,25 @@

 So, our _FooPlugin.java_ file content will be: 

+    
     package au.gov.naa.digipres.xena.demo.foo;
+    
     import au.gov.naa.digipres.xena.kernel.plugin.XenaPlugin;
+    
     public class FooPlugin extends XenaPlugin {
-    public static final String FOO_PLUGIN_NAME = "foo";
-      @Override
-    public String getName() {
-    return FOO_PLUGIN_NAME;
-      }
-     @Override
-     public String getVersion() {
-     return "0.1";
-      }
+    
+            public static final String FOO_PLUGIN_NAME = "foo";
+            
+            @Override
+            public String getName() {
+                    return FOO_PLUGIN_NAME;
+            }
+    
+            @Override
+            public String getVersion() {
+                    return "0.1";
+            }
+    
     }

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:09 -0000

--- v25
+++ v26
@@ -5,7 +5,7 @@
   * Xena <http://xena.sourceforge.net>. 
 [TOC]

-## A New File Format
+## New file format

 For the purpose of working through this tutorial, let's assume that we have a requirement to create a normaliser for a brand new file format. This file format, the 'foo' file format, is the mainstay of organisation X, and is specified as follows: All 'foo' files are UTF-8 text or ASCII, and should have the extension 'foo', and begin with the sequence of characters:

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:09 -0000

--- v24
+++ v25
@@ -24,9 +24,7 @@
     </foo>

-## First Steps
-
-### 1\. Create an outline of the plugin that will be loaded by Xena.
+## Create an outline of the plugin that will be loaded by Xena.

 Xena expects plugins to be loaded as JAR files, laid out in a specific way. To aid in this, the Apache Ant build tool will be used. To set up our plugin development directory, we will create a new folder, called _foo_plugin_, at an arbitrary place in the filesystem. This folder will be called the _home folder_, and designated by '~/' so our plugin will be contained in '~/foo_plugin'. For Windows users, switch the '/' to '\', and the '~' to something like _C:\Documents and Settings\UserName\My Documents_. 

@@ -40,7 +38,7 @@
     classname=au.gov.naa.digipres.xena.demo.foo.FooPlugin

-### 2\. Create the source folder for the package, and put the _name.properties_ file inside it.
+## Create the source folder for the package, and put the _name.properties_ file inside it.

 In this example, the source will be created in the folder named 'src', and the output of any compiling will go to 'bin', and a dist folder will contain the built JAR file. Any configuration files will be put into a folder named 'etc', and finally, any required external libraries (probably in JAR form) will be stored in the 'ext' folder. Create those folders and the _name.properties_ file now. At the end of setting up the folder structure, we should have the following entries in the _~/foo_plugin_ folder: 

@@ -51,17 +49,17 @@
     - name.properties

-### 3\. Create an Ant build file to do it all automatically.
+## Create an Ant build file to do it all automatically.

 The _foo_plugin_ directory contains a sample build file. The following instructions can be used to recreate this build file: 

-i. Create the top-level project element. Everything else in the _build.xml_ file listed below goes between these opening and closing project tags. 
+1\. Create the top-level project element. Everything else in the _build.xml_ file listed below goes between these opening and closing project tags. 

     <project name="foo" basedir="." default="makejar">
     </project>

-ii. Set the name of the plugin, and match the folder structure used in our project. 
+2\. Set the name of the plugin, and match the folder structure used in our project. 

     <property name="pluginname" value="foo"/>
     <property name="srcdir" value="src"/>
@@ -70,7 +68,7 @@
     <property name="distdir" value="dist"/>

-iii. Set the location of the _xena.jar_ file in a property named, appropriately, _xenajarlocation_. This is the most likely property to need changing, unless you happen to have the _xena_ file in the same relative location. 
+3\. Set the location of the _xena.jar_ file in a property named, appropriately, _xenajarlocation_. This is the most likely property to need changing, unless you happen to have the _xena_ file in the same relative location. 

 This guide assumes that you have already built the _xena.jar_ file. If this is not the case, please follow the build guide on the Xena website in order to do so. 

@@ -79,14 +77,14 @@
     <property name="xenajarlocation" value="../../xena/xena.jar" />

-iv. Create the compile path, to be used when compiling our plugins: 
+4\. Create the compile path, to be used when compiling our plugins: 

     <path id="compile.path">
     <pathelement location="${xenajarlocation}"/>
     </path>

-v. Add the _init_ and _clean_ targets: 
+5\. Add the _init_ and _clean_ targets: 

     <target name="init" description="Create output directories">
     <mkdir dir="${builddir}"/>
@@ -106,7 +104,7 @@
     </target>

-vi. Add the _makejar_ job: 
+6\. Add the _makejar_ job: 

     <target name="makejar" description="-->Make the jar file" depends="compile">
     <delete >
@@ -133,7 +131,7 @@

 The manifest file should be named _MANIFEST.MF_, and be placed in the _etc_ folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the _src_ directory tree. 

-### 4\. Create the FooPlugin class.
+## Create the FooPlugin class

 This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin: 

@@ -157,14 +155,32 @@
     }

-This file is expected to be in the JAR at the location: 'au/gov/naa/digipres/xena/demo/foo'. To make this happen, we will stick it into that location in the source tree. 
+This file is expected to be in the JAR at the location: _au/gov/naa/digipres/xena/demo/foo_. To make this happen, we will stick it into that location in the source tree. 

 So, several make directory commands later, we now have the folder: 

     ~/foo_plugin/src/au/gov/naa/digipres/xena/demo/foo

-This folder contains the single file "FooPlugin.java". To see that everything is going well, it is time to build our (empty) foo plugin for the first time. In a command shell, at the location '~/foo_plugin', type **ant**. If everything works, a JAR file, named _foo.jar_ will now exist in the folder _dist_. Running the command **jar -tvf foo.jar** reveals the contents of the JAR as such: 
+This folder contains the single file _FooPlugin.java_. 
+
+## Build the Foo plugin
+
+It is time to build our (empty) foo plugin for the first time. 
+
+1\. In a command shell, at the location '~/foo_plugin', type: 
+    
+    ant
+    
+
+If everything works, a JAR file, named _foo.jar_ will now exist in the folder _dist_. 
+
+2\. Type: 
+    
+    jar -tvf foo.jar
+    
+
+This reveals the contents of the JAR: 

     #jar -tvf foo.jar
         0 Wed Nov 21 15:03:48 EST 2007 META-INF/

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:09 -0000

--- v23
+++ v24
@@ -1,10 +1,9 @@
-## Prerequisites
-
 This _How To_ assumes you have some experience with Java programming and have installed the following:

   * JDK 1.6 or higher <http://java.sun.com/j2se/1.5.0/download.jsp>
   * Apache Ant <http://ant.apache.org>
   * Xena <http://xena.sourceforge.net>. 
+[TOC]

 ## A New File Format

@@ -27,7 +26,7 @@

 ## First Steps

-1\. Create an outline of the plugin that will be loaded by Xena. 
+### 1\. Create an outline of the plugin that will be loaded by Xena.

 Xena expects plugins to be loaded as JAR files, laid out in a specific way. To aid in this, the Apache Ant build tool will be used. To set up our plugin development directory, we will create a new folder, called _foo_plugin_, at an arbitrary place in the filesystem. This folder will be called the _home folder_, and designated by '~/' so our plugin will be contained in '~/foo_plugin'. For Windows users, switch the '/' to '\', and the '~' to something like _C:\Documents and Settings\UserName\My Documents_. 

@@ -41,7 +40,7 @@
     classname=au.gov.naa.digipres.xena.demo.foo.FooPlugin

-2\. Create the source folder for the package, and put the _name.properties_ file inside it. 
+### 2\. Create the source folder for the package, and put the _name.properties_ file inside it.

 In this example, the source will be created in the folder named 'src', and the output of any compiling will go to 'bin', and a dist folder will contain the built JAR file. Any configuration files will be put into a folder named 'etc', and finally, any required external libraries (probably in JAR form) will be stored in the 'ext' folder. Create those folders and the _name.properties_ file now. At the end of setting up the folder structure, we should have the following entries in the _~/foo_plugin_ folder: 

@@ -52,7 +51,7 @@
     - name.properties

-3\. Create an Ant build file to do it all automatically. 
+### 3\. Create an Ant build file to do it all automatically.

 The _foo_plugin_ directory contains a sample build file. The following instructions can be used to recreate this build file: 

@@ -73,9 +72,9 @@

 iii. Set the location of the _xena.jar_ file in a property named, appropriately, _xenajarlocation_. This is the most likely property to need changing, unless you happen to have the _xena_ file in the same relative location. 

-This guide assumes that you have already built the xena.jar file. If this is not the case, please follow the build guide on the Xena website in order to do so. 
+This guide assumes that you have already built the _xena.jar_ file. If this is not the case, please follow the build guide on the Xena website in order to do so. 

-The default location for the _xena.jar_ file is the xena directory of the root _plugin-howto_ directory. 
+The default location for the _xena.jar_ file is the _xena_ directory of the root _plugin-howto_ directory. 

     <property name="xenajarlocation" value="../../xena/xena.jar" />

@@ -127,14 +126,14 @@
     </target>

-The manifest for the JAR file is referenced in the _makejar_ target. Since there will be no main class in our plugin Jar, all we will include in our manifest file will be the line: 
+The manifest for the JAR file is referenced in the _makejar_ target. Since there will be no main class in our plugin JAR, all we will include in our manifest file will be the line: 

     Manifest-Version: 1.0

-The manifest file should be named _MANIFEST.MF_, and be placed in the etc folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the _src_ directory tree. 
+The manifest file should be named _MANIFEST.MF_, and be placed in the _etc_ folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the _src_ directory tree. 

-4\. Create the FooPlugin class. 
+### 4\. Create the FooPlugin class.

 This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin: 

@@ -165,7 +164,7 @@
     ~/foo_plugin/src/au/gov/naa/digipres/xena/demo/foo

-This folder contains the single file "FooPlugin.java". To see that everything is going well, it is time to build our (empty) foo plugin for the first time. In a command shell, at the location '~/foo_plugin', type **ant**. If everything works, a JAR file, named _foo.jar_ will now exist in the folder 'dist'. Running the command 'jar -tvf foo.jar' reveals the contents of the jar as such: 
+This folder contains the single file "FooPlugin.java". To see that everything is going well, it is time to build our (empty) foo plugin for the first time. In a command shell, at the location '~/foo_plugin', type **ant**. If everything works, a JAR file, named _foo.jar_ will now exist in the folder _dist_. Running the command **jar -tvf foo.jar** reveals the contents of the JAR as such: 

     #jar -tvf foo.jar
         0 Wed Nov 21 15:03:48 EST 2007 META-INF/

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

--- v22
+++ v23
@@ -13,9 +13,9 @@
     ~beginfoo

-After that, a foo file is partitioned into parts separated by the '~' character. The '\' character is used as an escape sequence, if it is followed by a '~' or '\' character these characters are taken as literal, otherwise the '\' is ignored. At this stage, this is all we are going to be concerned with, and when we preserve 'foo' files, we will be preserving each part of the file as a separate piece of XML. 
+After that, a foo file is partitioned into parts separated by the '~' character. The '\' character is used as an escape sequence, if it is followed by a '~' or '\' character these characters are taken as literal, otherwise the '\' is ignored. At this stage, this is all we are going to be concerned with. When we preserve 'foo' files, we will be preserving each part of the file as a separate piece of XML. 

-It is possible that some foo files will not have the correct filename extension, it is also possible that some files which are not 'foo' files will have the foo extension. Organisation X proposes that the XML schema for the preserved 'foo' file format will be as such: 
+It is possible that some foo files will not have the correct filename extension, it is also possible that some files which are not 'foo' files will have the foo extension. _Organisation X_ proposes that the XML schema for the preserved 'foo' file format will be as such: 

     <foo>
     <part>SOME DATA</part>
@@ -27,21 +27,23 @@

 ## First Steps

-The very first step we will undertake is to create an outline of the plugin that will be loaded by Xena. Xena expects plugins to be loaded as JAR files, laid out in a specific way. To aid in this, the Apache Ant build tool will be used. To set up our plugin development directory, we will create a new folder, called foo_plugin, at an arbitrary place in the filesystem. This folder will be called the home folder, and designated by '~/' so our plugin will be contained in '~/foo_plugin'. For Windows users, switch the '/' to '\', and the '~' to something like _C:\Documents and Settings\UserName\My Documents_. 
+1\. Create an outline of the plugin that will be loaded by Xena. 
+
+Xena expects plugins to be loaded as JAR files, laid out in a specific way. To aid in this, the Apache Ant build tool will be used. To set up our plugin development directory, we will create a new folder, called _foo_plugin_, at an arbitrary place in the filesystem. This folder will be called the _home folder_, and designated by '~/' so our plugin will be contained in '~/foo_plugin'. For Windows users, switch the '/' to '\', and the '~' to something like _C:\Documents and Settings\UserName\My Documents_. 

 To start off with, we get all the components we need to make a plugin. The first is the _name.properties_ file. This file should be loaded in the base directory of the JAR file, and should contain the fully qualified name of the plugin loader class, which is the class that will load all the components of the plugin. In this example, we will be putting all our classes in the package: 

     au.gov.naa.digipres.xena.demo.foo

-The plugin class loader will be called FooPlugin. So here is the content of our name.properties file: 
+The plugin class loader will be called FooPlugin. So here is the content of our _name.properties_ file: 

     classname=au.gov.naa.digipres.xena.demo.foo.FooPlugin

-The next thing we have to do is create the source folder for the package, and put the name.properties file inside that. 
+2\. Create the source folder for the package, and put the _name.properties_ file inside it. 

-In this example, the source will be created in the folder named 'src', and the output of any compiling will go to 'bin', and a dist folder will contain the built JAR file. Any configuration files will be put into a folder named 'etc', and finally, any required external libraries (probably in JAR form) will be stored in the 'ext' folder. Create those folders and the name.properties file now. At the end of setting up the folder structure, we should have the following entries in the _~/foo_plugin_ folder: 
+In this example, the source will be created in the folder named 'src', and the output of any compiling will go to 'bin', and a dist folder will contain the built JAR file. Any configuration files will be put into a folder named 'etc', and finally, any required external libraries (probably in JAR form) will be stored in the 'ext' folder. Create those folders and the _name.properties_ file now. At the end of setting up the folder structure, we should have the following entries in the _~/foo_plugin_ folder: 

     - /bin
     - /dist
@@ -50,15 +52,17 @@
     - name.properties

-Now, to make this all happen simply, we will create an Ant build file to do it all automatically. The _foo_plugin_ directory contains a sample build file. The following instructions can be used to recreate this build file. 
+3\. Create an Ant build file to do it all automatically. 

-First up, we will create the top-level project element. Everything else in the _build.xml_ file listed below goes between these opening and closing project tags. 
+The _foo_plugin_ directory contains a sample build file. The following instructions can be used to recreate this build file: 
+
+i. Create the top-level project element. Everything else in the _build.xml_ file listed below goes between these opening and closing project tags. 

     <project name="foo" basedir="." default="makejar">
     </project>

-Next we will set up a bunch of properties to set the name of the plugin, and match the folder structure used in our project. 
+ii. Set the name of the plugin, and match the folder structure used in our project. 

     <property name="pluginname" value="foo"/>
     <property name="srcdir" value="src"/>
@@ -67,7 +71,7 @@
     <property name="distdir" value="dist"/>

-Now we set the location of the _xena.jar_ file in a property named, appropriately, _xenajarlocation_. This is the most likely property to need changing, unless you happen to have the _xena_ file in the same relative location. 
+iii. Set the location of the _xena.jar_ file in a property named, appropriately, _xenajarlocation_. This is the most likely property to need changing, unless you happen to have the _xena_ file in the same relative location. 

 This guide assumes that you have already built the xena.jar file. If this is not the case, please follow the build guide on the Xena website in order to do so. 

@@ -76,14 +80,14 @@
     <property name="xenajarlocation" value="../../xena/xena.jar" />

-The next thing we do is create the compile path, to be used when compiling our plugins. 
+iv. Create the compile path, to be used when compiling our plugins: 

     <path id="compile.path">
     <pathelement location="${xenajarlocation}"/>
     </path>

-Now we add the _init_ and _clean_ targets. 
+v. Add the _init_ and _clean_ targets: 

     <target name="init" description="Create output directories">
     <mkdir dir="${builddir}"/>
@@ -103,7 +107,7 @@
     </target>

-And finally the _makejar_ job: 
+vi. Add the _makejar_ job: 

     <target name="makejar" description="-->Make the jar file" depends="compile">
     <delete >
@@ -123,14 +127,16 @@
     </target>

-The manifest for the JAR file is referenced in the makejar target. Since there will be no main class in our plugin Jar, all we will include in our manifest file will be the line: 
+The manifest for the JAR file is referenced in the _makejar_ target. Since there will be no main class in our plugin Jar, all we will include in our manifest file will be the line: 

     Manifest-Version: 1.0

-The manifest file should be named _MANIFEST.MF_, and be placed in the etc folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the src directory tree. 
+The manifest file should be named _MANIFEST.MF_, and be placed in the etc folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the _src_ directory tree. 

-Our next job will be to create the FooPlugin class. This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin: 
+4\. Create the FooPlugin class. 
+
+This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin: 

   * _getName_
   * _getVersion_. 
@@ -152,12 +158,14 @@
     }

-Now this file is expected to be in the JAR at the location: 'au/gov/naa/digipres/xena/demo/foo'. To make this happen, we will stick it into that location in the source tree. So, several make directory commands later, we now have the folder: 
+This file is expected to be in the JAR at the location: 'au/gov/naa/digipres/xena/demo/foo'. To make this happen, we will stick it into that location in the source tree. 
+
+So, several make directory commands later, we now have the folder: 

     ~/foo_plugin/src/au/gov/naa/digipres/xena/demo/foo

-This folder contains the single file "FooPlugin.java". To see that everything is going well, it is time to build our (empty) foo plugin for the first time. In a command shell, at the location '~/foo_plugin', type ant. If everything works, a JAR file, named foo.jar will now exist in the folder 'dist'. Running the command 'jar -tvf foo.jar' reveals the contents of the jar as such: 
+This folder contains the single file "FooPlugin.java". To see that everything is going well, it is time to build our (empty) foo plugin for the first time. In a command shell, at the location '~/foo_plugin', type **ant**. If everything works, a JAR file, named _foo.jar_ will now exist in the folder 'dist'. Running the command 'jar -tvf foo.jar' reveals the contents of the jar as such: 

     #jar -tvf foo.jar
         0 Wed Nov 21 15:03:48 EST 2007 META-INF/

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

--- v21
+++ v22
@@ -1,3 +1,11 @@
+## Prerequisites
+
+This _How To_ assumes you have some experience with Java programming and have installed the following: 
+
+  * JDK 1.6 or higher <http://java.sun.com/j2se/1.5.0/download.jsp>
+  * Apache Ant <http://ant.apache.org>
+  * Xena <http://xena.sourceforge.net>. 
+
 ## A New File Format

 For the purpose of working through this tutorial, let's assume that we have a requirement to create a normaliser for a brand new file format. This file format, the 'foo' file format, is the mainstay of organisation X, and is specified as follows: All 'foo' files are UTF-8 text or ASCII, and should have the extension 'foo', and begin with the sequence of characters:

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

--- v20
+++ v21
@@ -1,14 +1,3 @@
-## Prerequisites
-
-This _How To_ assumes you have some experience with Java programming and have installed the following: 
-
-  * JDK 1.6 or higher <http://java.sun.com/j2se/1.5.0/download.jsp>
-  * Apache Ant <http://ant.apache.org>
-  * Xena <http://xena.sourceforge.net>. 
-
-  
-
-
 ## A New File Format

 For the purpose of working through this tutorial, let's assume that we have a requirement to create a normaliser for a brand new file format. This file format, the 'foo' file format, is the mainstay of organisation X, and is specified as follows: All 'foo' files are UTF-8 text or ASCII, and should have the extension 'foo', and begin with the sequence of characters:

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

--- v18
+++ v19
@@ -92,8 +92,6 @@
     <mkdir dir="${builddir}"/>
     <mkdir dir="${distdir}"/>
     </target>
-    
-    
     <target name="clean" depends="init" description="--> Clear all output files">
     <delete dir="${builddir}"/>
     <delete dir="${distdir}"/>

2_-_Setup modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:05:08 -0000

--- v17
+++ v18
@@ -135,7 +135,10 @@

 The manifest file should be named _MANIFEST.MF_, and be placed in the etc folder, as specified in the ant build job. Also, the makejar job looks for the _name.properties_ file in the base directory, and any properties files in the src directory tree. 

-Our next job will be to create the FooPlugin class. This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin - getName and getVersion. 
+Our next job will be to create the FooPlugin class. This class will tell Xena what it is we can expect to find in the plugin. It specifies any normalisers, types, guessers, file namers, meta data package wrappers, help sets, basically anything that can be in a normaliser. It will need to extend the _XenaPlugin_ class, found in the _au.gov.naa.digipres.xena.kernel.plugin package_. For the moment, we will leave it almost entirely blank, we will just override the only two abstract methods in XenaPlugin: 
+
+  * _getName_
+  * _getVersion_. 

 So, our _FooPlugin.java_ file content will be: