|
1
|
------
|
|
2
|
Setting up a Taxonomic Editor development environment
|
|
3
|
------
|
|
4
|
n.hoffmann
|
|
5
|
------
|
|
6
|
|
|
7
|
|
|
8
|
Setting up a Taxonomic Editor development environment
|
|
9
|
|
|
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}}.
|
|
12
|
|
|
13
|
<Table of Contents>
|
|
14
|
|
|
15
|
%{toc|section=0|fromDepth=2|toDepth=3}
|
|
16
|
|
|
17
|
* Requirements
|
|
18
|
|
|
19
|
Please make sure that you have met the following requirements.
|
|
20
|
|
|
21
|
* 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}})
|
|
22
|
|
|
23
|
* Eclipse PDE Version >= 3.6
|
|
24
|
|
|
25
|
|
|
26
|
* Checking out the sources
|
|
27
|
|
|
28
|
Use subversion to check out the sources from the EDIT repository to a location on your development machine.
|
|
29
|
|
|
30
|
---
|
|
31
|
$ svn co http://dev.e-taxonomy.eu/svn/trunk/taxeditor
|
|
32
|
---
|
|
33
|
|
|
34
|
This will leave you with a directory <<<taxeditor/>>> containing everything that is needed. We will have a look at the contents later on.
|
|
35
|
|
|
36
|
* Setting up eclipse
|
|
37
|
|
|
38
|
The Taxonomic Editor uses maven for convenient configuration and automation of common tasks, such as setting up eclipse.
|
|
39
|
|
|
40
|
---
|
|
41
|
$ cd taxeditor/
|
|
42
|
$ mvn eclipse:eclipse
|
|
43
|
---
|
|
44
|
|
|
45
|
This will take some time, as maven will download the required dependencies and configure the projects. After maven has finished follow these steps:
|
|
46
|
|
|
47
|
* Start up eclipse (make sure you have the required version installed) and open a workspace.
|
|
48
|
|
|
49
|
* Open up the Import Wizard via <File -\> Import...> from the menu
|
|
50
|
|
|
51
|
* Choose <General -\> Existing projects into Workspace > and click next.
|
|
52
|
|
|
53
|
* 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.
|
|
54
|
|
|
55
|
* Click <Select All> and finish the wizard.
|
|
56
|
|
|
57
|
The package exporer should show a bunch of projects. Although it will also show a bunch of errors, so please read on.
|
|
58
|
|
|
59
|
|
|
60
|
* Initializing the cdmlib plugin
|
|
61
|
|
|
62
|
The <cdmlib-plugin> project contains all dependencies needed for the CDM Library to work except the <<<cdmlib-*>>> artifacts itself. Therefore the
|
|
63
|
<<<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.
|
|
64
|
|
|
65
|
---
|
|
66
|
$ cd taxeditor/cdmlib-plugin/
|
|
67
|
$ ./_makeSources.sh
|
|
68
|
---
|
|
69
|
|
|
70
|
Refresh the <<<cdmlib-plugin>>> project; the errors should be gone.
|
|
71
|
|
|
72
|
<<Note:>> This will change in the very near future as these dependencies will also be managed by maven.
|
|
73
|
|
|
74
|
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.
|
|
75
|
|
|
76
|
* Bundle overview
|
|
77
|
|
|
78
|
Let's have a quick look at the projects:
|
|
79
|
|
|
80
|
** <taxeditor-store>
|
|
81
|
|
|
82
|
|
|
83
|
|
|
84
|
** <taxeditor-navigation>
|
|
85
|
|
|
86
|
The <Taxon Navigator> as well as the <Search> view are located in this plugin.
|
|
87
|
|
|
88
|
** <taxeditor-editor>
|
|
89
|
|
|
90
|
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>,
|
|
91
|
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
|
|
92
|
also located here.
|
|
93
|
|
|
94
|
** <taxeditor-bulkeditor>
|
|
95
|
|
|
96
|
The different bulkeditors are in this plugin.
|
|
97
|
|
|
98
|
** <taxeditor-printpublisher>
|
|
99
|
|
|
100
|
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.
|
|
101
|
|
|
102
|
** <taxeditor-application>
|
|
103
|
|
|
104
|
This plugin bundles all the previous plugins into an application and configures the look and feel.
|
|
105
|
|
|
106
|
** <taxeditor-cdmlib-plugin>
|
|
107
|
|
|
108
|
As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.
|
|
109
|
|
|
110
|
** <taxeditor-feature-platform>
|
|
111
|
|
|
112
|
A feature containing all dependencies for the eclipse platform.
|
|
113
|
|
|
114
|
** <taxeditor-feature-product>
|
|
115
|
|
|
116
|
A feature configuring the standalone application and bundling all plugins and dependencies.
|
|
117
|
|
|
118
|
* Creating a launch configuration
|
|
119
|
|
|
120
|
To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.
|
|
121
|
|
|
122
|
* Expand <taxeditor-feature-product> and open <<<taxeditor.product>>>
|
|
123
|
|
|
124
|
* In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>
|
|
125
|
|
|
126
|
The Taxonomic Editor should launch.
|
|
127
|
|
|
128
|
* Where do I go from here?
|