Difference between revisions of "SetupEclipse"

From KalypsoDev
Jump to: navigation, search
 
(20 intermediate revisions by one user not shown)
Line 1: Line 1:
 +
= Setting up Eclipse for Kalypso =
 +
 
Kalypso is a java application being developed with [http://www.eclipse.org Eclipse]. This article describes how to set up eclipse in order to start developing with Kalypso.
 
Kalypso is a java application being developed with [http://www.eclipse.org Eclipse]. This article describes how to set up eclipse in order to start developing with Kalypso.
  
Line 4: Line 6:
  
 
Download and install the current versions of
 
Download and install the current versions of
* [http://java.sun.com][Sun's JDK 6] (use OpenJDK under Linux, with Sun's SDK Kalypso will freeze)
+
* [http://java.oracle.com Oracle's JDK 7]
* [http://www.eclipse.org][Eclipse 3.5.1 SDK]
+
* [http://www.eclipse.org Eclipse 3.8 SDK]
  
Tip: The installation path of eclipse should not contain any whitespace ' ', else some of the ant-scripts used to compile Kalypso will get into trouble.
+
Tip: The installation path of eclipse should not contain any white-space ' ', else some of the ant-scripts used to compile Kalypso will get into trouble.
  
 
==Starting Eclipse==
 
==Starting Eclipse==
Line 14: Line 16:
  
 
;-vm <nowiki><path to your java 6 sdk>/bin/javaw.exe</nowiki> (required)
 
;-vm <nowiki><path to your java 6 sdk>/bin/javaw.exe</nowiki> (required)
:kalypso <big>MUST</big> be started with the <big>Java Developer Kit (JDK)</big> (NOT the Runtime Edition (JRE)), else some of the ant-code generation will not work properly
+
:Kalypso <big>MUST</big> be started with the <big>Java Developer Kit (JDK)</big> (NOT the Runtime Edition (JRE)), else some of the ant-code generation will not work properly
  
 
;-data <nowiki><path to workspace directory></nowiki>  (optional)
 
;-data <nowiki><path to workspace directory></nowiki>  (optional)
:use a distinquished workspace directory for your kalypso sources
+
:use a distinquished workspace directory for your Kalypso sources
  
 
; -vmargs -Xmx1024m
 
; -vmargs -Xmx1024m
Line 24: Line 26:
 
==Configure Eclipse==
 
==Configure Eclipse==
  
In order to be able to compile kalypso, eclipse should be configured as follows:
+
In order to be able to compile Kalypso, Eclipse should be configured as follows:
 +
 
 +
===Additionally required Eclipse-Plug-ins===
 +
 
 +
{| border="1" cellpadding="4" cellspacing="1"
 +
|+ Eclipse Plug-Ins
 +
! Name
 +
! Remark
 +
! Use
 +
! Source / Update Site
 +
|-
 +
| Subversive SVN Team Provider || Required to fetch Kalypso sources || Optional || Juno Update Site ||
 +
|-
 +
| Mylyn Team Support || For easy access to Kalypso Trac(s) || Optional || Juno Update Site ||
 +
|-
 +
| Eclipse XML Editors and Tools || || Required || Juno Update Site ||
 +
|-
 +
|  Babel Language Packs || Kalypso depends on Babel - Required packs: 'eclipse', xxx? || Required || http://download.eclipse.org/technology/babel/update-site/R0.11.0/juno/ ||
 +
|-
 +
| KalypsoDevelopTools || Helper for exporting/importing i10n property files to and from excel || Optional || http://dev.bjoernsen.de/updatesites/KalypsoDevelopTools/
 +
|-
 +
| NatTable || Kalypso depends on NatTable || Required || http://download.eclipse.org/nattable/releases/1.0.1/repository/
 +
|-
 +
| NSIS || Eclipse NSIS - Setup Tool || Optional || http://eclipsensis.sf.net/update
 +
|-
 +
| UOMo|| Eclipse UOMo - || Required || http://download.eclipse.org/uomo/0.6/repository/
 +
|-
 +
|}
 +
 
 +
'''Note''': Features Kalypso has real dependencies on (i.e. are required to compile Kalypso) are marked as 'required'.
  
 
===workspace_loc (required)===
 
===workspace_loc (required)===
Line 48: Line 79:
  
 
===Network connections (optional)===
 
===Network connections (optional)===
Do not forget to confugure your network connections via
+
Do not forget to configure your network connections via
 
:Menu: <tt>Window->Preferences...</tt>
 
:Menu: <tt>Window->Preferences...</tt>
 
::Page <tt>General/Network connection</tt>
 
::Page <tt>General/Network connection</tt>
Line 55: Line 86:
  
 
===XML-Files (optional)===
 
===XML-Files (optional)===
Define kalypso specific file extensions as xml content via
+
Define Kalypso specific file extensions as xml content via
 
:Menu: <tt>Window preferences...</tt>
 
:Menu: <tt>Window preferences...</tt>
 
::Page: <tt>Generel/Content types</tt>
 
::Page: <tt>Generel/Content types</tt>
Line 68: Line 99:
 
* .kod
 
* .kod
 
* .sld
 
* .sld
 +
* .ort
 
* _others_?
 
* _others_?
  
You should do this right now, as changing anything here later will result in a complete rebuild of kalypso.
+
You should do this right now, as changing anything here later will result in a complete rebuild of Kalypso.

Latest revision as of 11:29, 13 January 2014

Contents

[edit] Setting up Eclipse for Kalypso

Kalypso is a java application being developed with Eclipse. This article describes how to set up eclipse in order to start developing with Kalypso.

[edit] Installation of Java and Eclipse

Download and install the current versions of

Tip: The installation path of eclipse should not contain any white-space ' ', else some of the ant-scripts used to compile Kalypso will get into trouble.

[edit] Starting Eclipse

We recommend the following command-line options when starting eclipse:

-vm <path to your java 6 sdk>/bin/javaw.exe (required)
Kalypso MUST be started with the Java Developer Kit (JDK) (NOT the Runtime Edition (JRE)), else some of the ant-code generation will not work properly
-data <path to workspace directory> (optional)
use a distinquished workspace directory for your Kalypso sources
-vmargs -Xmx1024m
Kalypso is quite big, give eclipse enough memory to handle all this stuff

[edit] Configure Eclipse

In order to be able to compile Kalypso, Eclipse should be configured as follows:

[edit] Additionally required Eclipse-Plug-ins

Eclipse Plug-Ins
Name Remark Use Source / Update Site
Subversive SVN Team Provider Required to fetch Kalypso sources Optional Juno Update Site
Mylyn Team Support For easy access to Kalypso Trac(s) Optional Juno Update Site
Eclipse XML Editors and Tools Required Juno Update Site
Babel Language Packs Kalypso depends on Babel - Required packs: 'eclipse', xxx? Required http://download.eclipse.org/technology/babel/update-site/R0.11.0/juno/
KalypsoDevelopTools Helper for exporting/importing i10n property files to and from excel Optional http://dev.bjoernsen.de/updatesites/KalypsoDevelopTools/
NatTable Kalypso depends on NatTable Required http://download.eclipse.org/nattable/releases/1.0.1/repository/
NSIS Eclipse NSIS - Setup Tool Optional http://eclipsensis.sf.net/update
UOMo Eclipse UOMo - Required http://download.eclipse.org/uomo/0.6/repository/

Note: Features Kalypso has real dependencies on (i.e. are required to compile Kalypso) are marked as 'required'.

[edit] workspace_loc (required)

In order make the ant-scripts compiling parts of kalpyso work, the ant-property

workspace = ${workspace_loc}

must be defined via

Menu: Window->Preferences...
Page Ant/Runtime
Tab Properties
Button:Add Property...

Linux: before getting the sources, set the workspace encoding of eclipse to ISO-8859-1:

Menu: Window->Preferences...
Page General/Workspace
Text File Exncoding:Other ISO-8859-1

[edit] ManualJRE (optional)

In order to build the DocBook manuals of Kalypso, a 1.4.2 JRE named 'ManualJRE' must be defined under

Menu Window->Preferences...
Page: Java/Installed JREs
Button Add...

[edit] Network connections (optional)

Do not forget to configure your network connections via

Menu: Window->Preferences...
Page General/Network connection

in order to use the help system or install additional eclipse features.


[edit] XML-Files (optional)

Define Kalypso specific file extensions as xml content via

Menu: Window preferences...
Page: Generel/Content types
Entry: XML

Add the following extensions:

  • .gml
  • .gft
  • .gmt
  • .gtt
  • .ott
  • .odt
  • .kod
  • .sld
  • .ort
  • _others_?

You should do this right now, as changing anything here later will result in a complete rebuild of Kalypso.

Personal tools
Namespaces

Variants
Actions
Navigation
Manuals
Toolbox