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