Nathan 0.1.2 - Installation Guide ================================= Nathan is distributed as a binary package and as a source package. The binary distro includes a precompiled blob that is fully functional, the documentation and no sources. The source distribution can be used for developing extensions or for saving bandwidth and has to be compiled by hand. Content ------- 1. Binary distribution 2. Source distribution 3. Running Nathan 4. Upgrading Nathan 1. Binary distribution ---------------------- The distribution has been compiled using the Java JDK 1.4.0 from Sun. o Download the zip or tar.bz2 file from nathan.sourceforge.net. o Unpack the file to a suitable directory. You will find the following directory structure: nathan - the root dir - bin - contains the start scripts - doc - contains the documentation - api - contains the API documentation generated with javadoc - lib - contains the excecutable nathan.jar file o Run Nathan (see below) 2. Source distribution ---------------------- To compile the project Apache Ant version 1.5.1 was used and is recommended. o Download the zip or tar.bz2 file from nathan.sourceforge.net. o Unpack the file to a suitable directory. You will find the following directory structure: build.xml - the ant file to compile the package nathan - the root dir - bin - contains the start scripts - classes - holds the compiled class files (empty) - doc - contains the documentation - api - will contain the API documentation generated with javadoc (empty) - lib - contains the necessary jar files - src - contains the source tree of Nathan - java - contains the java files - resource - contains miscellenous files and icons for the application o Compile the package by typing "ant jar". This will generate the nathan.jar file in the lib directory. o [optional] Generate the API documentation by typing "ant api". o Run Nathan (see below) 3. Running Nathan ----------------- Nathan stores imported files in a dedicated directory called the "repository". You have to pass the directory path to Nathan when running it. Alternative 1: Run Nathan via a start script - cd to the bin subdirectory and edit the nathan or nathan.bat file If you use a Linux/Unix system edit the nathan file and set NATHAN_HOME variable to the path of the nathan directory from the distribution. Possibly you have to add excecutability to the script (chmod a+x nathan). If you use a Windows system edit the nathan.bat file and set NATHAN_HOME variable accordingly. - [optional] Add the nathan/bin directory to your PATH. - Run nathan by invoking the script. Pass the repository directory to the script as a parameter. Alternative 2: Run Nathan directly from the jar file. - cd to the lib subdirectory. - Execute the jar file by typing "java -jar nathan.jar " The correct output on the command line should look something like this: ~/nathan/lib> java -jar nathan.jar ~/tmp/nathan/ Loaded Theme: KDE Loaded Types: de.winterfish.neonX.basicTypes.BasicTypes Loaded Types: de.winterfish.nathanX.person.PersonType Loaded Types: de.winterfish.nathanX.event.EventType 0 nodes in Nathan. Loaded Neon Extension: Bookmarks Neon Extension Loaded Transformer: de.winterfish.nathan.importer.transformers.SimpleTransformer Loaded Nathan Extension: Link Loaded Nathan Extension: Person Loaded Nathan Extension: Event Loaded Nathan Extension: New Text Node Loaded Nathan Extension: Export Original Loaded Nathan Extension: Revert to Original Loaded Nathan Extension: Manage Filters Please refer to the User Guide for operating Nathan. 4. Upgrading Nathan ------------------- 4.1 From 0.1 to 0.1.1 o Install the software as described above. o Edit the file "nathan.cfg" in the repository directory as follows: - The entry "nathanX" contains a comma seperated list of class names. Change the classname "de.winterfish.nathanX.LinkExtension" to "de.winterfish.nathanX.linkExtension.LinkExtension". o Run Nathan 4.2 From 0.1.1 to 0.1.2 No changes necessary