Recent changes to 1_-_Introduction

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:31 -0000

--- v11
+++ v12
@@ -70,7 +70,7 @@

 ### Guesser

-The guesser component of Xena is responsible for ascertaining the type of a given XenaInputSource. In order to do this, for each Xena Type there is a corresponding guesser, which creates a Xena Guess object. Each Xena Guess object consists of a Xena Type and a number of attributes. The attributes are used by the Guesser to find the most likely Type for the given XenaInputSource. Attributes are weighted so as to allow accurate guessing to be undertaken. The following attributes are currently included in the Xena Guess object: 
+The guesser component of Xena is responsible for ascertaining the type of a given XenaInputSource. In order to do this, for each Xena Type there is a corresponding guesser, which creates a Xena Guess object. Each Xena Guess object consists of a Xena Type and a number of attributes. The attributes are used by the Guesser to find the most likely type for the given XenaInputSource. Attributes are weighted so as to allow accurate guessing to be undertaken. The following attributes are currently included in the Xena Guess object: 

   * MIME Type 
   * File Extension

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:31 -0000

--- v10
+++ v11
@@ -1,10 +1,9 @@
-Xena relies on plugins to allow it to normalise files. 
-
-The Xena architecture supports dynamic loading of plugins. This means that plugins are loaded when the program is run. The plugins are loaded through the plugin manager in one of two ways: 
+Xena relies on plugins to allow it to normalise files. The Xena architecture supports dynamic loading of plugins. This means that plugins are loaded when the program is run. The plugins are loaded through the plugin manager in one of two ways:

   * directly with an API call, passing in the fully-qualified class name of the main plugin class 
   * as a JAR file that is loaded while Xena is running. 

+  
 The aim of this _How To_ is to enable you to write a functional Xena plugin. It includes the following: 

   * creation of a simple plugin that performs a simple normalisation for a single file type

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:31 -0000

--- v9
+++ v10
@@ -1,3 +1,10 @@
+Xena relies on plugins to allow it to normalise files. 
+
+The Xena architecture supports dynamic loading of plugins. This means that plugins are loaded when the program is run. The plugins are loaded through the plugin manager in one of two ways: 
+
+  * directly with an API call, passing in the fully-qualified class name of the main plugin class 
+  * as a JAR file that is loaded while Xena is running. 
+
 The aim of this _How To_ is to enable you to write a functional Xena plugin. It includes the following:

   * creation of a simple plugin that performs a simple normalisation for a single file type

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:30 -0000

--- v8
+++ v9
@@ -89,7 +89,7 @@
 To view a file, Xena instantiates a XenaView object. The XenaView object has two important components to it:

   * JPanel 
-  * ContentHandler 
+  * ContentHandler. 

 The JPanel is used to actually display the Xena file, and the ContentHandler parses the XML of the normalised file and add components to the JPanel. In order to display a given normalised file, an appropriate viewer is instantiated, then an XML parser is instantiated and the content handler for XML parser is set to that of the viewer. The normalised file is then parsed, and the content handler performs the necessary actions to display the file.

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:30 -0000

--- v7
+++ v8
@@ -1,4 +1,4 @@
-The plugin _How To_ provides a resource for plugin development. It includes the following: 
+The aim of this _How To_ is to enable you to write a functional Xena plugin. It includes the following:

   * creation of a simple plugin that performs a simple normalisation for a single file type 
   * extending the simple normaliser, including the implementation of multiple file inputs, multiple output packages

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:30 -0000

--- v6
+++ v7
@@ -9,15 +9,6 @@

 [TOC]
-
-## Prerequisites
-
-The _How To_ assumes the following: 
-
-  * some experience with Java programming 
-  * JDK 1.6 or higher is installed 
-  * Apache Ant is installed and configured correctly 
-  * the _xena.jar_ file has been downloaded and exists on your filesystem. 

 ## Definitions

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:30 -0000

--- v5
+++ v6
@@ -59,7 +59,7 @@

 The normaliser component is responsible for taking a XenaInputSource and transforming it into an XML file. A normaliser should extend the abstract class AbstractNormaliser. 

-### Types
+### Type

 The XenaType object is used to associate a type with a normaliser. A single normaliser may normalise multiple types, but each type should correspond to a specific normaliser.

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:30 -0000

--- v4
+++ v5
@@ -18,9 +18,6 @@
   * JDK 1.6 or higher is installed 
   * Apache Ant is installed and configured correctly 
   * the _xena.jar_ file has been downloaded and exists on your filesystem. 
-
-  
-

 ## Definitions

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:29 -0000

--- v3
+++ v4
@@ -52,11 +52,11 @@

 The file namer component is responsible for generating new files for Xena output. 

-The abstract FileNamer has a number of methods and variables. Every FileNamer must have the following: 
+The abstract FileNamer has a number of methods and variables. Every FileNamer must have the: 

-  * The option to keep a history file containing the input source and the generated file name. 
-  * The option to overwrite Xena output files and use the same name for a given Xena Input Source. 
-  * The ability to access a map containing the Xena Input Source names and for each a list of generated filenames. 
+  * option to keep a history file containing the input source and the generated file name 
+  * option to overwrite Xena output files and use the same name for a given Xena Input Source 
+  * ability to access a map containing the Xena Input Source names and for each a list of generated filenames. 

 ### Normaliser

@@ -78,13 +78,13 @@

 The guesser component of Xena is responsible for ascertaining the type of a given XenaInputSource. In order to do this, for each Xena Type there is a corresponding guesser, which creates a Xena Guess object. Each Xena Guess object consists of a Xena Type and a number of attributes. The attributes are used by the Guesser to find the most likely Type for the given XenaInputSource. Attributes are weighted so as to allow accurate guessing to be undertaken. The following attributes are currently included in the Xena Guess object: 

-  * The MIME Type; 
-  * The File Extension; 
-  * The Magic number in the file header; 
-  * The Data in the body of the file; 
-  * The possibility the file is of the current type; 
-  * The case that Xena is certain the file is of the current type; 
-  * The priority of the current guesser. 
+  * MIME Type 
+  * File Extension 
+  * Magic number in the file header 
+  * Data in the body of the file 
+  * possibility the file is of the current type 
+  * Xena is certain the file is of the current type 
+  * priority of the current guesser. 

 By default, the values of the attributes, other than the priority of the guesser, are set to ‘Unknown’. Each guesser analyses the input source, and sets the attributes as required. 

@@ -100,8 +100,8 @@

 To view a file, Xena instantiates a XenaView object. The XenaView object has two important components to it: 

-  * A JPanel 
-  * A ContentHandler 
+  * JPanel 
+  * ContentHandler 

 The JPanel is used to actually display the Xena file, and the ContentHandler parses the XML of the normalised file and add components to the JPanel. In order to display a given normalised file, an appropriate viewer is instantiated, then an XML parser is instantiated and the content handler for XML parser is set to that of the viewer. The normalised file is then parsed, and the content handler performs the necessary actions to display the file.

1_-_Introduction modified by Allan Cunliffe

Allan Cunliffe — Thu, 13 Jun 2013 11:04:29 -0000

--- v2
+++ v3
@@ -17,7 +17,7 @@
   * some experience with Java programming 
   * JDK 1.6 or higher is installed 
   * Apache Ant is installed and configured correctly 
-  * the Xena.jar file has been downloaded and exists on your filesystem. 
+  * the _xena.jar_ file has been downloaded and exists on your filesystem.