Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "EPF Wiki Development Guide"
m (→Install Ruby and Ruby Gems) |
m |
||
| Line 4: | Line 4: | ||
Minimum Requirements | Minimum Requirements | ||
| − | + | * Ruby 1.8.4 | |
| − | + | * Ruby Gems 0.9.0 | |
| − | + | * Rails 2.0.2 | |
| − | + | * MySQL 5.0.15 or higher | |
| − | + | * [http://sourceforge.net/projects/unxutils Windows UnxUtils] (for Windows) | |
| − | + | * [http://tinymce.moxiecode.com TinyMCE] (TODO replace this with a EPL compliant HTML Editor) | |
You can use another database, in fact you can use any of [http://wiki.rubyonrails.org/rails/pages/DatabaseDrivers 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. | You can use another database, in fact you can use any of [http://wiki.rubyonrails.org/rails/pages/DatabaseDrivers 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. | ||
| Line 15: | Line 15: | ||
Ruby is shipped with [http://en.wikipedia.org/wiki/SciTE 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. | Ruby is shipped with [http://en.wikipedia.org/wiki/SciTE 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. | 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. | ||
| Line 25: | Line 25: | ||
The following gems need te be installed | The following gems need te be installed | ||
| − | + | * Tidy ([http://rubyforge.vm.bytemark.co.uk/gems/tidy-1.1.2.gem tidy-1.1.2.gem]) | |
| − | + | * MySQL ([http://rubyforge.vm.bytemark.co.uk/gems/mysql-2.7.1-mswin32.gem mysql-2.7.1-mswin32.gem]) | |
| − | + | * Rails 2.0.2 | |
| + | * XHTMLDiff | ||
These can be installed with the following commands: | These can be installed with the following commands: | ||
| Line 44: | Line 45: | ||
=== Aptana Studio === | === Aptana Studio === | ||
| − | + | # [http://www.aptana.com/studio/download/ Download Aptana Studio] | |
| − | + | # Add RadRails to Aptana Studio by following the Start Page instructions (Help > Aptana Studio Start Page...). | |
See the [http://www.aptana.tv/movies/aptana_radrails_intro/aptana_radrails_intro.html screencast] for more information. | See the [http://www.aptana.tv/movies/aptana_radrails_intro/aptana_radrails_intro.html screencast] for more information. | ||
| Line 58: | Line 59: | ||
See also [http://www.eclipse.org/epf/composer_dev_guide/cvs_setup.php CVS Repository Setup] in the EPF Composer Development Guide. | See also [http://www.eclipse.org/epf/composer_dev_guide/cvs_setup.php 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: [http://rtef.info/ Richtext Editor: Fork (RTEF)] | ||
| + | |||
| + | # Download TinyMCE from [http://tinymce.moxiecode.com/download.php tinymce.moxiecode.com] | ||
| + | # 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''' | ||
=== Create a Development and Test Database === | === Create a Development and Test Database === | ||
| − | + | ||
== Run Tests == | == Run Tests == | ||
| Line 72: | Line 80: | ||
== References == | == References == | ||
| + | |||
| + | [http://meta.wikimedia.org/wiki/Cheatsheet Wikipedia Cheatsheet] | ||
[http://www.eclipse.org/epf/composer_dev_guide/ EPF Composer Development Guide] | [http://www.eclipse.org/epf/composer_dev_guide/ EPF Composer Development Guide] | ||
[http://www.aptana.com/rails Welcome to RadRails, the Ruby on Rails authoring environment for Aptana Studio and Eclipse] | [http://www.aptana.com/rails Welcome to RadRails, the Ruby on Rails authoring environment for Aptana Studio and Eclipse] | ||
| + | |||
| + | [http://dev.eclipse.org/ipzilla/show_bug.cgi?id=2254 CQ2254 IPZilla for HTML editor] | ||
Revision as of 05:35, 11 April 2008
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.
Contents
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
- Download Aptana Studio
- 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)
- Download TinyMCE from tinymce.moxiecode.com
- 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
Create a Development and Test Database
Run Tests
Build Process
Bugzilla Setup
See EPF Composer Development Guide
References
EPF Composer Development Guide
Welcome to RadRails, the Ruby on Rails authoring environment for Aptana Studio and Eclipse