EDIT

{{>toc}}

----

# Eclipse plugins and preferences

_Plugins, code templates, coding conventions, preferences etc. for EDIT CDM Development in php, java, javascript._

*TIP*: _For quickly setting up eclipse you may want to import the @prefs-available-software-sites.xml@, see the "Plugins" for more on this._

----

## Quick Setup

### Setting up eclipse

1. import the @prefs-available-software-sites.xml@, see the "Plugins" for more on this.

1. enable the following plugins:

  * Remote Workspace Preferences

  * TODO ...

### Setting up a new Workspace

1. import the [[EclipsePreferencesforTeams#RemoteWorkspacePreferences|Remote Workspace Preferences]] from http://dev.e-taxonomy.eu/svn/trunk/devtools/eclipse/4.x/prefs/prefs_remote_workspace_preferences.epf 

## Coding conventions

### Eclipse Code Template for Java

_NOTE: The Code Template is now deployed via the Remote Workspace Preferences (see below), so there is no longer a need to apply it manually!_

To work with an eclipse IDE you may use the code template below, which includes the license comment,

the log4j logger import, and the class comment (@author, @creation, @version).

To use it you have to:

1. download the attached file _CDM-Java-Code-Template.xml_. For downloading it click link below, scroll down and click "*ORIGINAL FORMAT*" !! 

1. open eclipse preferences (MS Windows: window-preferences; MAC: eclipse-preferences)

1. goto Java - Code Style - Code Templates

1. import the template by using Import...

1.  

  * don't forget to check the "Generate comments" check box in the "New Java Class" wizard or  

  * OR even better set this as **default** for the new class wizard by checking Window > Preferences... > Java > Code Style > templates > Automatically add comments...

## Plugins

The available software sites to be added to eclipse can be downloaded from here: http://dev.e-taxonomy.eu/svn/trunk/devtools/eclipse/4.x/prefs/prefs-available-software-sites.xml

Apply these setting by going to "Available Software Sites" in the eclipse preferences, click on import and browse to the location to where you downloaded @prefs-available-software-sites.xml@.

### Subclipse

Subclipse is an Eclipse team provider for the Subversion version

control system. 

* project site: http://subclipse.tigris.org/

* update site: http://download.eclipse.org/releases/juno

* set up:

### EGit

Eclipse Git is an Eclipse Team provider based on JGit, a pure Java implementation of the Git version control system.

* project site: http://eclipse.org/egit

* update site: http://download.eclipse.org/releases/juno

* set up:

### RunJettyRun

* project site: http://code.google.com/p/run-jetty-run/

* update site: 

* set up: Install via Eclipse Marktplace

### Remote Workspace Preferences

For now we decided to use this plugin for distributing preferences within the team, but we may switch to another solution in future, see #3335 (Share workspace setting within the team) for more information.

* project site: https://marketplace.eclipse.org/content/remote-workspace-preferences-plug

* update site: http://netceteragroup.github.io/eclipse-team-etceteras/updatesite (or install via eclipse marketplace)

* set up:

  1. Install the _Remote Workspace Preferences_ plugin and restart eclipse. **Currently not available** 

  1. Go to _File->Import->General->Remote Preferences->From URL_, paste this URL: http://dev.e-taxonomy.eu/svn/trunk/devtools/eclipse/4.x/prefs/prefs_remote_workspace_preferences.epf and hit "Finish".

  1. Restart eclipse and hit "Yes" to import the remote preferences.

* To re-import/re-apply the preferences go to _File->Import->General->Remote Preferences->From configured URL_ which will now show all the applicable preferences files.

* Once the `prefs_remote_workspace_preferences.epf` file has changed you will need to paste the above URL again into the "From URL" text field.

### Web Development

#### AnyEditTools

* project site: http://andrei.gmxhome.de/anyedit/

* update site: http://andrei.gmxhome.de/eclipse/

* set up:

#### JavaScript Development Tools

* project site: http://www.eclipse.org/webtools/jsdt/

* update site: http://download.eclipse.org/releases/juno

* set up:

#### PHP codesniffer

[_CodeSniffer is broken in indigo!!!!_](http://sourceforge.net/tracker/index.php?func=detail&aid=3395739&group)id=263892&atid=1127654*

* project site: http://xfragger.de/209/php-codesniffer-fur-eclipse

* update site: http://www.phpsrc.org/eclipse/pti/

* recommendet plugins:   

  * core

  * library.pear

  * tools.phpmd 

  * tools.phpunit

  * tools.codesniffer

* set up:

  * disable all codesniffer rules in Window > Preferences

  * download [Codesniffer rules for Drupal CDM](http://dev.e-taxonomy.eu/svn/branches/drupal/dataportal-to-drupal7/helper-scripts/Codesniffer/Drupal_CDM)

  * in project settings enable the Drupal_CDM Codesniffer rules

  * for drupal projects exclude the following files and folders:

~~~

*/drupal*/modules/*,*/drupal*/includes/*,*/drupal*/misc/*,*/drupal*/themes/*,*/drupal*/profiles/*,*.png,*.gif,*.jpg

~~~

#### PHP Development Tools

* project site: http://www.eclipse.org/projects/project.php?id=tools.pdt

* update site: http://download.eclipse.org/releases/juno

* set up:

#### PHP Mess Detector

* project site: http://phpmd.org/

* update site: 

* set up:

#### Web Page Editor

* project site: http://help.eclipse.org/indigo/index.jsp?topic=%2Forg.eclipse.jst.jsf.doc.user%2Fhtml%2Fgettingstarted%2Fwpe%2Fwpe_getting_started.html

* update site: http://download.eclipse.org/releases/juno

* set up:

#### jshint

* project site: http://github.eclipsesource.com/jshint-eclipse/about.html

* update site: http://github.eclipsesource.com/jshint-eclipse/updates/

* set up:

### Documentation & UML

#### Architexa

Just Another Eclipse Plugin which helps in understanding and documenting code. Architexa can turn a large Java codebase into a comprehensible and navigable diagram of functionality and dependency.

Requires registration!

* project site: http://www.architexa.com/

* update site: 

* set up: