[[PageOutline]]

= Setting up Eclipse =

== Plugins ==

Install the following plugins

 [http://subclipse.tigris.org subclipse ] (version 1.6.x)::
    Subversion interface, [http://subclipse.tigris.org/servlets/ProjectProcess?pageID=p4wYuA Installation instructions]

 
== Project setup ==

=== Checkout source ===

When you've installed the above plugins fire up [http://www.eclipse.org Eclipse] and follow these instructions 

 1. Click on `File -> Import`
 1. Select `SVN` -> `Checkout Projects from SVN` and click `Next`
 1. Check `Create new repository location` and click `Next`
 1. Enter `http://www.proteios.org/svn` and click `Next`
 1. Select `trunk` and click `Next`
 1. Check `Check out as a project configured using the New Project Wizard` and click `Finish`
 1. Select `Java` -> `Java Project` and click `Next`
 1. Enter a project name e.g. `ProteiosSE-2.x` 
 1. Check `Create new project in workspace` ProteiosSE
 1. JDK Compliance should be set to 5.0
 1. Check `Use project folder as root for sources and class files` and click `Next`
 1. In the `Source` tab, select your project(e.g. Proteios-2.x) in the list box and click the link `Remove project 'Proteios-2.x' from build path`
 1. Click `Finish`

You should now have a fresh checkout of [wiki:WikiStart Proteios] in your `Package navigator`

=== Configure project ===

 1. In the menu click `Project -> Properties`
 1. In the left frame double click `Java code style`
 1. Click `Code templates`
 1. Check `Enable project specific settings`
 1. Click `Import`
 1. Select the file `Proteios-2.x/misc/eclipse/code_templates.xml`

 Repeat steps 4-6 for 

 * `Java code styles -> Formatter` importing the file `Proteios-2.x/misc/eclipse/formatter_style.xml`
 * `Java code styles -> Organize imports` importing the file `Proteios-2.x/misc/eclipse/import_order.txt`

 Repeat these steps whenever files in `Proteios-2.x/misc/eclipse` are updated.

 7. In the left frame select `Java Build Path`
 1. In the right frame select `Source` tab
 1. Click `Add Folder...`
 1. Check all `src/` and `test/src` folders in api/core, api/waf, client/* and plugin/`
 1. Check `Allow output folders for source folder
 1. Doubleclick `Output folder:` below each source folder
 1. Create and select directory `build` in the same directory as the selected `src` directory(you have to find it in the directory structure)
 1. Click `Ok`
 1. Repeat the above three steps for each output folder, yes this is a pain but you only need to do this once :-)
 1. Click `Libraries` tab
 1. Click `Add JARs`
 1. Select all jar files in `api/external` 
 1. Repeat steps 17-18 for all subdirectories in `api/external`
 1. Click `Ok`

You also need to configure text file encoding and line delimiter by:

 20. In the menu click `Project -> Properties`
 1. In the left frame click `Resource` (or `Info`, in older versions of Eclipse)
 1. In section `Text file encoding` check `Other` and select ~~`ISO-8859-1`~~ `UTF-8`
 1. In section `New text file line delimiter` check `Other` and select `Unix`
 1. Click `Ok`

== Subversion ==

Setup eclipse to use our subversion config by

 1. In the menu click `Window -> Preferences`
 1. In the left fram click `Team -> SVN` (subclipse has to be installed)
 1. Set `Configuration location` to `your_workspace/proteios/misc/subversion`
 1. Click `Ok`

Next time you run a subversion command it will create additional files `README.txt` and `servers` in the above directory. You can safely ignore these files and even add them to svn ignore.

== Ant ==

Default ant tasks run fine from eclipse though a 'junit' task requires the junit.jar. Follow [http://docs.codehaus.org/display/GEOSDOC/Ant+-+junit,+build+failed%3D+Could+not+create+task+or+type+of+type+junit this] instruction how to configure eclipse.