Extensions

Where To Find Extensions

There are some extensions in the Retrospectiva repository already for your delectation, located at http://retrospectiva.googlecode.com/svn/extensions/1-0. You can browse what is available at http://retrospectiva.org/browse/extensions/1-0

Download

Downloading extensions is very easy. Go to your Retrospectiva installation directory and call:

svn co http://retrospectiva.googlecode.com/svn/extensions/1-0/extension_name extensions/extension_name

Example with timeline extension:

svn co http://retrospectiva.googlecode.com/svn/extensions/1-0/timeline extensions/timeline 

For trunk users

If you installed Retrospectiva using Subversion (recommended), you can also use Retrospectiva’s Extension Manager (rxm) to install extensions. Since [r165], rxm includes the checkout feature, which automatically downloads extensions from remote repositories and (by default) also sets the svn:externals property enabling automatic synchronization for your extensions.

To install an extension, go to your Retrospectiva directory and call:

RAILS_ENV=production ruby script/rxm checkout http://extensions.host.com/path/extension

If you don’t want the svn:externals property to be set automatically, please use the --no-externals option, Example:

RAILS_ENV=production ruby script/rxm checkout http://extensions.host.com/path/extension --no-externals

Full example with the openid_auth extension:

RAILS_ENV=production ruby script/rxm checkout http://retrospectiva.googlecode.com/svn/extensions/1-1/openid_auth

Installation

Extensions can be managed with the Retrospectiva extension manager, a command-line tool for extensions,

To list all extensions, open a console, change to the root path of your retrospectiva installation and simply call:

ruby script/rxm list

To install an available extension, call:

RAILS_ENV=production ruby script/rxm install extension_name

To uninstall an available extension, call:

RAILS_ENV=production ruby script/rxm uninstall extension_name

To uninstall an available extension and to purge all extension-relevant data from the database, call:

RAILS_ENV=production ruby script/rxm uninstall extension_name --remove-db

After you have installed the extension, all you have to do is restart the application.

That’s it!

Extension development

[needs to be written]

Ideas

Please see the Extension ideas page for details.