Using Eclipse for MidCOM development
Eclipse is the recommended Integrated development environment to use in MidCOM development.
Requirements
- Download and install Eclipse
- Download and install the PHPEclipse plug-in
- Download and install tha Subclipse plug-in
Setting up the project
You can set up Eclipse to either work on a MidCOM SVN checkout, or just a local installation. For code sharing purposes, SVN is the recommended way a so it is explained here.
Note: This text is under update, as MidCOM has switched to using subversion for revision control.
Once PHPEclipse has been installed start the Eclipse application, and select File -> New -> Project.... This will launch the project setup wizard:
Select Checkout Projects from SVN as the project type and click Next.
Next you are asked for the SVN repository settings. Set the url to
svn+ssh://svn.gforge.nehmer.net/svnroot/midcom/trunk. If you got another gforge username than your current username, use
svn+ssh://YOURUSERNAME@svn.gforge.nehmer.net/svnroot/midcom/trunk where YOURUSERNAME of course should not be in uppercase.
Alternatively, you can also access the repository anonymously in read-only mode by setting the url to svn://svn.gforge.nehmer.net/svnroot/midcom/trunk.
After this, press Next.
Now click Finish and Eclipse will make you a checkout of the MidCOM code tree. You should be able to start working immediately.
After this, this page Running latest MidCOM from subversion explains the rest of the process.
Code documentation
MidCOM uses PhpDocumentor for code documentation purposes. See the Implementing phpDocumentor into Eclipse for how to use it together with PhpEclipse.
See also MidCOM PhpDoc HOWTO.
Outdated information:
Input cvs.tigris.org as the Host, /cvs as the Path, and input your account information.
Click Next again and you will be asked to select a Module. The CVS module for MidCOM development is midcom/fs-midcom.
Now click Finish and Eclipse will make you a checkout of the MidCOM code tree. You should be able to start working immediately. To make debugging easier, you can configure your MidCOM template site to use the Eclipse checkout directory of MidCOM as its MidCOM prefix.
Using Eclipse with CVS
When developing MidCOM components, it is important to do the work in CVS HEAD, and only port bug or security fixes to the branches.
Also, use the TODO and FIXME task tags in code comments to mark places that should be cleaned or require other attention. This way they're easily found by other developers using Eclipse.