• Table of contents
• Eclipse plugins and preferences
  • Quick Setup
    • Setting up eclipse
    • Setting up a new Workspace
  • Coding conventions
    • Eclipse Code Template for Java
  • Plugins
    • Subclipse
    • EGit
    • RunJettyRun
    • Remote Workspace Preferences
    • Web Development
      • AnyEditTools
      • JavaScript Development Tools
      • PHP codesniffer
      • PHP Development Tools
      • PHP Mess Detector
      • Web Page Editor
      • jshint
    • Documentation & UML
      • Architexa

---

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.

2. enable the following plugins:

• Remote Workspace Preferences

• TODO ...

Setting up a new Workspace¶

1. import the 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" !!

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

3. goto Java - Code Style - Code Templates

4. import the template by using Import...

• 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.

2. 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".

3. Restart eclipse and hit "Yes" to import the remote preferences. (If the dialog does not appear see the re-applying step below)

• 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!!!!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
  • 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: