EDIT

		------

		Setting up a Taxonomic Editor development environment

		------

		n.hoffmann

		------

	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

* 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

	* 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.

	<<<eu.etaxonomy.taxditor>>> which should be checked for import.

	* Click <Select All> to finish the wizard and import the projects into your workspace.

	You should now be able to see the taaxeditor projects in your workspace.

	then paste the URL in the <Work With> row. Click <Add> and use the Filter to find, check and install the SWTBot packages.

	* Same procedure for the <Graphical Editing Framework Zest Visualization Toolkit SDK>. In case there is no repository already shipped with Eclipse, one can find the update URL {{{http://www.eclipse.org/gef/updates/index.php}here}}.

	The Taxonomic Editor uses <maven 3> for convenient configuration and automation of common tasks, 

	such as resolving dependencies and automating builds.

	do not imclude it with the other dependencies but rather install it with maven.

---

---

	This will take some time, as maven will download the required dependencies.

	After maven has finished follow these steps:

* Bundle overview

	Let's have a quick look at the projects:

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

	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.

	The different bulkeditors are in this plugin.

	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.

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

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

	A feature containing all dependencies for the eclipse platform.

	Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://swtbot.com/}SWTBot}}.

	To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.

	* In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>

* Where do I go from here?

	Please read the {{{http://dev.e-taxonomy.eu/trac/wiki/TaxonomicEditorDev}wiki}} for how-to's and code examples.