EPF Wiki Development Guide

Welcome to the EPF Wiki Development Guide. This guide covers the steps necessary to begin development on EPF Wiki using Aptana Studio, CVS, and Bugzilla.

Development Environment Setup

Minimum Requirements

• Ruby 1.8.4
• Ruby Gems 0.9.0
• Rails 2.0.2
• MySQL 5.0.15 or higher
• Windows UnxUtils (for Windows)
• TinyMCE (TODO replace this with a EPL compliant HTML Editor)

You can use another database, in fact you can use any of supported databases by Rails migrations. UnxUtils is included with the requirements because the current documentation of EPF Wiki assumes the development environment will run on Windows (XP) and the production environment on Linux.

Ruby is shipped with SCIntilla based Text Editor so this minimum setup is already very complete. But for more serious development work the following extra components come highly recommended.

• XAMPP
• Aptana Studio

XAMPP includes MySQL so this replaces the MySQL database listed with the minimum requirements. On top of that XAMPP includes many other usefull components for development.

Install Ruby and Ruby Gems

Download and install Ruby from www2.ruby-lang.org. Download and install Ruby Gems from rubygems.org

The following gems need te be installed

• Tidy (tidy-1.1.2.gem)
• MySQL (mysql-2.7.1-mswin32.gem)
• Rails 2.0.2
• XHTMLDiff

These can be installed with the following commands:

gem install tidy
gem install mysql
gem install rails -v=2.0.2
gem install xhtmldiff

Ruby Gems can be installed using command gem install or can be installed manually by downloading the gems from gems.rubyforge.org. Your proxy server can be specified using p switch, for more information type gem help install

The version of Ruby on Rails to install depends on the version EPF Wiki is currently using. You can check the version online in environment.rb in the EPF Wiki CVS Repository.

The Tidy Gem is just a wrapper, the dll needs is a separate download. Download from tidy.sf.net and unzip to lib\tidy. The tidy folder should now contain three folders bin, include, lib. This location is specified by the environment variable EPFWIK_TIDY_PATH. [[TODO check if this is still true ]]

Aptana Studio

1. Download Aptana Studio
2. Add RadRails to Aptana Studio by following the Start Page instructions (Help > Aptana Studio Start Page...).

See the screencast for more information.

Checkout project from CVS

Start Aptana Studio and switch to the CVS repository perspective. Add a repository location with the following properties

Connection type: extssh
Host: dev.eclipse.org
Repository path: /cvsroot/technology

See also CVS Repository Setup in the EPF Composer Development Guide.

TinyMCE

This commercial editor can be integrated with EPF Wiki. This is a more a advanced editor than the one that ships with EPF Wiki: Richtext Editor: Fork (RTEF)

1. Download TinyMCE from tinymce.moxiecode.com
2. Extract the contents and copy the folder tinymce\jscripts\tiny_mce to [application install dir]\public\javascripts. The folder javascripts\tinymce should now contain Javascript library tiny_mce.js

Bugzilla Setup

See EPF Composer Development Guide

References

Wikipedia Cheatsheet

EPF Composer Development Guide

Welcome to RadRails, the Ruby on Rails authoring environment for Aptana Studio and Eclipse

CQ2254 IPZilla for HTML editor