+ ------
+ Setting up a Taxonomic Editor development environment
+ ------
+ n.hoffmann
+ ------
+
+
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}}.
-
-
+ This document describes all steps necessary 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
-
-
+
+ The current version of the EDIT Taxonomic Editor is developed using the Eclipse IDE for RCP developers.
+
+
* Checking out the sources
- Use subversion to check out the sources from the EDIT repository to a location on your development machine.
-
+ Use git 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
+$ 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.
+ 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.
-
+ * Start up eclipse and open a workspace.
+
+ * Open up the Import Wizard via <File -\> Import...> from the menu
+
+ * Choose <Maven -\> Existing maven projects > and click next.
+
+ * For setting the <Root Directory> browse to the <<<taxeditor/>>> directory. After confirming the directory selection dialog, the <Projects> list should contain a number of projects all starting with
+ <<<eu.etaxonomy.taxeditor>>> 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 taxeditor projects in your workspace.
+
+* Dependencies
+
+ The Taxonomic Editor uses <maven 3> for convenient configuration and automation of common tasks,
+ such as resolving dependencies and automating builds.
+
+ We have two modules that use maven for dependency resolution: cdmlibrary and the molecular module.
+
+ The <<<latest snapshot branch>>> of the Taxonomic Editor is programmed against the latest
+ SNAPSHOT version of the cdmlibrary. Because that dependency will change quickly, we
+ do not include it with the other dependencies but rather install it with maven.
+
+ In order to do that you have to run <<<mvn install>>> and <<<mvn validate>>> in your <<<taxeditor>>> directory.
+
---
-$ cd taxeditor/cdmlib-plugin/
-$ ./_makeSources.sh
+$ cd taxeditor
+$ mvn clean install
+$ mvn validate
---
- 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.
+ 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.
+
+ There is also a convenience shell script <<<setup-project.sh>>> in the <<<taxeditor>>> directory which runs the above mentioned commands.
+
+ ---
+ $ ./setup-project.sh
+ ---
+
+
+ After maven has finished follow these steps:
- 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.
-
+ 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 the projects:
-
-** <taxeditor-store>
+ 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>
-
-** <taxeditor-navigation>
+ 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>,
+ 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 <Taxon Navigator> as well as the <Search> view are located in this plugin.
+** <eu.etaxonomy.taxeditor.bulkeditor>
-** <taxeditor-editor>
+ The different bulkeditors are 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.
+** <eu.etaxonomy.taxeditor.molecular>
-** <taxeditor-bulkeditor>
+ 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.
- The different bulkeditors are in this plugin.
+** <eu.etaxonomy.taxeditor.molecular.lib>
-** <taxeditor-printpublisher>
+ Manages the external dependencies for the molecular 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.
+** <eu.etaxonomy.taxeditor.webapp>
+
+ Provides all remoting facilities i.e. manages the internal CDM Server to connect to remote data sources.
-** <taxeditor-application>
+** <eu.etaxonomy.taxeditor.printpublisher>
- This plugin bundles all the previous plugins into an application and configures the look and feel.
+ This plugin is a frontend and GUI for the <cdmlib-print> module. Please see the {{{http://cybertaxonomy.org/printpublisher/}according documentation}} for further information.
-** <taxeditor-cdmlib-plugin>
+** <eu.etaxonomy.taxeditor.application>
- As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.
+ This plugin bundles all the previous plugins into an application and configures the look and feel.
-** <taxeditor-feature-platform>
+** <eu.etaxonomy.taxeditor.cdmlib>
- A feature containing all dependencies for the eclipse platform.
+ As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.
-** <taxeditor-feature-product>
+** <eu.etaxonomy.taxeditor.feature.platform>
- A feature configuring the standalone application and bundling all plugins and dependencies.
+ A feature containing all dependencies for the eclipse platform.
+
+** <eu.etaxonomy.taxeditor>
+
+ The product configuration for the standalone application.
+
+** <eu.etaxonomy.taxeditor.test>
+
+ Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://eclipse.org/swtbot/}SWTBot}}.
* 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.
-
+ To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.
+
+ * Expand <eu.etaxonomy.taxeditor> and open <<<eu.etaxonomy.taxeditor.product>>>
+
+ * In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>
+
+ The Taxonomic Editor should launch. Note: You might want to tweak the launch configuration, e.g. increase the memory.
+
* 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.
BGBM BDI Projects / taxeditor.git / blobdiff