Setting up a Taxonomic Editor development environment

	This document describes all steps necessarry to create a development environment to develop the EDIT Taxonomic Editor. If you are looking for 
	instructions on how to install the EDIT Taxonomic Editor please consult the {{{./manual.html} manual}}.
	
	<Table of Contents>
	
%{toc|section=0|fromDepth=2|toDepth=3}
	
* Requirements
	
	* CDM Library development environment set up on your machine (please follow the	instructions on {{{http://wp5.e-taxonomy.eu/cdmlib/getting-started.html#Developing_the_CDM_Library}how to install a CDM Library development environment}})
	
	* Eclipse PDE Version >= 3.6
	
	
* Checking out the sources

	Use subversion to check out the sources from the EDIT repository to a location on your development machine.
	
---
$ svn co http://dev.e-taxonomy.eu/svn/trunk/taxeditor
---

	This will leave you with a directory <<<taxeditor/>>> containing everything that is needed. We will have a look at the contents later on.

* Setting up eclipse

	The Taxonomic Editor uses maven for convenient configuration and automation of common tasks, such as setting up eclipse. 
	
---
$ cd taxeditor/
$ mvn eclipse:eclipse
---
	
	This will take some time, as maven will download the required dependencies and configure the projects. After maven has finished follow these steps:
	
	* Start up eclipse (make sure you have the required version installed) and open a workspace. 
	
	* Open up the Import Wizard via <File -\> Import...> from the menu
	
	* Choose <General -\> Existing projects into Workspace > and click next.
	
	* Check <Select Root Directory> and browse to the <<<taxeditor/>>> directory. After confirming the directory selection dialog, the <Projects> list should contain a number of projects.
	
	* Click <Select All> and finish the wizard.
	
	The package exporer should show a bunch of projects. Although it will also show a bunch of errors, so please read on.
	
	
* Initializing the cdmlib plugin

	The <cdmlib-plugin> project contains all dependencies needed for the CDM Library to work except the <<<cdmlib-*>>> artifacts itself. Therefore the 	
	<<<cdmlib-plugin>>> project will show an error.	In order to include these artifacts the project contains a shell (and bash) script to copy these from your local maven repository. Please make sure, that the <<<cdmlib-*>>> artifacts exist in your repository.
	
---
$ cd taxeditor/cdmlib-plugin/
$ ./_makeSources.sh
---

	Refresh the <<<cdmlib-plugin>>> project; the errors should be gone.
	
	<<Note:>> This will change in the very near future as these dependencies will also be managed by maven.

	After this you have to update the classpaths of all plugin projects as well. To do this right-click any of the <taxeditor-*> projects and choose <PDE Tools -\> Update Classpath...>. Click <Select All> in the dialog and confirm. After a rebuild of your entire workspace all errors should be gone and you are ready to go.
	
* Bundle overview

	Let's have a quick look at the projects:
	
** <taxeditor-store>


	
** <taxeditor-navigation>

	The <Taxon Navigator> as well as the <Search> view are located in this plugin.

** <taxeditor-editor>

	Everything that has to do with editing a taxon or data that is connected to a taxon resides in this plugin. This includes the <Name Editor>, the <Details View>,
	the <Supplemental View>, the <Descriptive Data View> as well as the <Media View>. All interface elements that are used in the <taxeditor-bulkeditor> plugin are 
	also located here.

** <taxeditor-bulkeditor>

	The different bulkeditors are in this plugin.

** <taxeditor-printpublisher>

	This plugin is a frontend and GUI for the <cdmlib-print> module. Please see the {{{http://wp5.e-taxonomy.eu/printpublisher/}according documentation}} for further information.

** <taxeditor-application>

	This plugin bundles all the previous plugins into an application and configures the look and feel.

** <taxeditor-cdmlib-plugin>

	As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.

** <taxeditor-feature-platform>

	A feature containing all dependencies for the eclipse platform.

** <taxeditor-feature-product>

	A feature configuring the standalone application and bundling all plugins and dependencies.

* Creating a launch configuration

	To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.
	
	* Expand <taxeditor-feature-product> and open <<<taxeditor.product>>>
	
	* In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>
	
	The Taxonomic Editor should launch.
	
* Where do I go from here?