2 Setting up a Taxonomic Editor development environment
8 Setting up a Taxonomic Editor development environment
10 This document describes all steps necessarry to create a development environment to develop the EDIT Taxonomic Editor. If you are looking for
11 instructions on how to install the EDIT Taxonomic Editor please consult the {{{./manual.html} manual}}.
15 %{toc|section=0|fromDepth=2|toDepth=3}
19 The current version of the EDIT Taxonomic Editor is developed against Eclipse PDE Version 3.6. Your PDE or at least your target platform have to have the same version.
22 * Checking out the sources
24 Use subversion to check out the sources from the EDIT repository to a location on your development machine.
27 $ svn co http://dev.e-taxonomy.eu/svn/trunk/taxeditor
30 This will leave you with a directory <<<taxeditor/>>> containing everything that is needed. We will have a look at the contents later on.
34 The Taxonomic Editor uses maven for convenient configuration and automation of common tasks, such as setting up eclipse.
41 This will take some time, as maven will download the required dependencies and configure the projects. After maven has finished follow these steps:
43 * Start up eclipse (make sure you have the required version installed) and open a workspace.
45 * Open up the Import Wizard via <File -\> Import...> from the menu
47 * Choose <General -\> Existing projects into Workspace > and click next.
49 * 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.
51 * Click <Select All> and finish the wizard.
53 The package exporer should show a bunch of projects. To get rid of the errors, you have to update the classpaths of all plugin projects. 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.
57 Let's have a quick look at the projects:
59 ** <eu.etaxonomy.taxeditor.store>
61 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.
63 ** <eu.etaxonomy.taxeditor.navigation>
65 The <Taxon Navigator> as well as the <Search> view are located in this plugin.
67 ** <eu.etaxonomy.taxeditor.editor>
69 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>,
70 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
73 ** <eu.etaxonomy.taxeditor.bulkeditor>
75 The different bulkeditors are in this plugin.
77 ** <eu.etaxonomy.taxeditor.printpublisher>
79 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.
81 ** <eu.etaxonomy.taxeditor.application>
83 This plugin bundles all the previous plugins into an application and configures the look and feel.
85 ** <eu.etaxonomy.taxeditor.cdmlib>
87 As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.
89 ** <eu.etaxonomy.taxeditor.feature.platform>
91 A feature containing all dependencies for the eclipse platform.
93 ** <eu.etaxonomy.taxeditor.product>
95 A feature configuring the standalone application and bundling all plugins and dependencies.
97 ** <eu.etaxonomy.taxeditor.test>
99 Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://swtbot.com/}SWTBot}}.
101 * Creating a launch configuration
103 To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.
105 * Expand <taxeditor-feature-product> and open <<<taxeditor.product>>>
107 * In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>
109 The Taxonomic Editor should launch. Note: You might want to tweak the launch configuration, e.g. increase the memory.
111 * Where do I go from here?
113 Please read the {{{http://dev.e-taxonomy.eu/trac/wiki/TaxonomicEditorDev}wiki}} for how-to's and code examples.