EDIT

Setting up a Taxonomic Editor development environment

    This document describes all steps necessary to create a development environment to develop the EDIT Taxonomic Editor. If you are looking for 

%{toc|section=0|fromDepth=2|toDepth=3}

* Requirements

    The current version of the EDIT Taxonomic Editor is developed using the Eclipse IDE for RCP developers.

* Checking out the sources

    Use git to check out the sources from the EDIT repository to a location on your development machine.

---

$ git clone ssh://git@dev.e-taxonomy.eu/var/git/taxeditor.git

---

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

    * Start up eclipse and open a workspace. 

* Dependencies

    We have two modules that use maven for dependency resolution: cdmlibrary and the molecular module.

    In order to do that you have to run <<<mvn install>>> and <<<mvn validate>>> in your <<<taxeditor>>> directory.

$ cd taxeditor

$ mvn validate

---

    The maven pom.xml provides a special profile which you may want to use if you are developing the cdmlib at the same time. This profile, named <<<local-repository>>>, causes maven to always use the local maven repository, so the latest changes to the cdmlib will be used. You have to run <<<mvn install>>> in the cdmlib folder beforehand to install the local dependencies to the repository. In order to use this profile you would execute the <<<validate>>> gloal differently:

 $ mvn -P local-repository  -Dlocalrepo=/home/${youUserName}/.m2/repository validate

 ---

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

 ---

    After maven has finished follow these steps:

    The UI is implemented using a fixed version of SWT. So please follow the steps to correctly set the  {{{https://dev.e-taxonomy.eu/redmine/projects/edit/wiki/TaxonomicEditorDevelopersGuide#Target-RCP-Environment}Target-RCP-Environment}} 

* Bundle overview

    Let's have a quick look at some important projects:

** <eu.etaxonomy.taxeditor.store>

    This package communicates with cdmlib-service directly, offering all services, basic operations on cdm data as well as import export functionality. Database and user management is also contained in this package.

** <eu.etaxonomy.taxeditor.navigation>

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

** <eu.etaxonomy.taxeditor.editor>

    Everything that has to do with editing taxa or specimens or data that is connected to those resides in this plugin. This includes the <Name Editor>, the <Specimen Editor>, the <Details View>,

** <eu.etaxonomy.taxeditor.bulkeditor>

    The different bulkeditors are in this plugin.

** <eu.etaxonomy.taxeditor.molecular>

    This plugin provides editors and views for working with phylogenetic data like single reads and consensus sequences. This includes the <Alignment Editor>, the <Pherogram View> and export functionality.

    Manages the external dependencies for the molecular plugin.

** <eu.etaxonomy.taxeditor.printpublisher>

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

** <eu.etaxonomy.taxeditor.application>

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

** <eu.etaxonomy.taxeditor.cdmlib>

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

** <eu.etaxonomy.taxeditor.feature.platform>

    A feature containing all dependencies for the eclipse platform.

** <eu.etaxonomy.taxeditor>

    The product configuration for the standalone application.

** <eu.etaxonomy.taxeditor.test>

* Creating a launch configuration

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

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