src/site/apt/getting-started.apt

   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         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.
  20
  21
  22 * Checking out the sources
  23
  24         Use subversion to check out the sources from the EDIT repository to a location on your development machine.
  25
  26 ---
  27 $ svn co http://dev.e-taxonomy.eu/svn/trunk/taxeditor
  28 ---
  29
  30         This will leave you with a directory <<<taxeditor/>>> containing everything that is needed. We will have a look at the contents later on.
  31
  32 * Setting up eclipse
  33
  34         * Start up eclipse (make sure you have the required version installed) and open a workspace.
  35
  36         * Open up the Import Wizard via <File -\> Import...> from the menu
  37
  38         * Choose <General -\> Existing projects into Workspace > and click next.
  39
  40         * 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 all starting with
  41         <<<eu.etaxonomy.taxditor>>> which should be checked for import.
  42
  43         * Click <Select All> to finish the wizard and import the projects into your workspace.
  44
  45         You should now be able to see the taaxeditor projects in your workspace.
  46
  47         * Install {{{http://www.eclipse.org/swtbot/downloads.php}SWTBot}} using the Eclipse-Install-Wizard via <Help -\> Install new Software> If the SWTBot repository is not already added to your Eclipse-Path
  48         then paste the URL in the <Work With> row. Click <Add> and use the Filter to find, check and install the SWTBot packages.
  49
  50         * Same procedure for the <Graphical Editing Framework Zest Visualization Toolkit SDK>. In case there is no repository already shipped with Eclipse, one can find the update URL {{{http://www.eclipse.org/gef/updates/index.php}here}}.
  51
  52 * Dependencies
  53
  54         The Taxonomic Editor uses <maven 3> for convenient configuration and automation of common tasks,
  55         such as resolving dependencies and automating builds.
  56
  57         The <<<latest snapshot branch>>> of the Taxonomic Editor is programmed against the latest
  58         SNAPSHOT version of the cdmlibrary. Because that dependency will change quickly, we
  59         do not imclude it with the other dependencies but rather install it with maven.
  60
  61         In order to do that you have to run <<<mvn validate>>> in your <<<taxeditor/eu.etaxonomy.taxeditor.cdmlib>>> directory.
  62
  63 ---
  64 $ cd taxeditor/eu.etaxonomy.taxeditor.cdmlib/
  65 $ mvn validate
  66 ---
  67
  68         This will take some time, as maven will download the required dependencies.
  69         After maven has finished follow these steps:
  70
  71
  72         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.
  73
  74 * Bundle overview
  75
  76         Let's have a quick look at the projects:
  77
  78 ** <eu.etaxonomy.taxeditor.store>
  79
  80         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.
  81
  82 ** <eu.etaxonomy.taxeditor.navigation>
  83
  84         The <Taxon Navigator> as well as the <Search> view are located in this plugin.
  85
  86 ** <eu.etaxonomy.taxeditor.editor>
  87
  88         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>,
  89         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
  90         also located here.
  91
  92 ** <eu.etaxonomy.taxeditor.bulkeditor>
  93
  94         The different bulkeditors are in this plugin.
  95
  96 ** <eu.etaxonomy.taxeditor.printpublisher>
  97
  98         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.
  99
 100 ** <eu.etaxonomy.taxeditor.application>
 101
 102         This plugin bundles all the previous plugins into an application and configures the look and feel.
 103
 104 ** <eu.etaxonomy.taxeditor.cdmlib>
 105
 106         As said before, <cdmlib> dependecies reside in this plugin. Please also note that this plugin does not contain any sourcecode.
 107
 108 ** <eu.etaxonomy.taxeditor.feature.platform>
 109
 110         A feature containing all dependencies for the eclipse platform.
 111
 112 ** <eu.etaxonomy.taxeditor>
 113
 114         The product configuration for the standalone application.
 115
 116 ** <eu.etaxonomy.taxeditor.test>
 117
 118         Automated GUI Tests for the Taxonomic Editor that can be run with {{{http://swtbot.com/}SWTBot}}.
 119
 120 * Creating a launch configuration
 121
 122         To start the Taxonomic Editor from your newly created development environment you need to create a launch configuration.
 123
 124         * Expand <eu.etaxonomy.taxeditor> and open <<<eu.etaxonomy.taxeditor.product>>>
 125
 126         * In the <Testing> section (down left) click on <Launch an Eclipse application in Debug mode>
 127
 128         The Taxonomic Editor should launch. Note: You might want to tweak the launch configuration, e.g. increase the memory.
 129
 130 * Where do I go from here?
 131
 132         Please read the {{{http://dev.e-taxonomy.eu/trac/wiki/TaxonomicEditorDev}wiki}} for how-to's and code examples.