ChiliProject is not maintained anymore. Please be advised that there will be no more updates.

We do not recommend that you setup new ChiliProject instances and we urge all existing users to migrate their data to a maintained system, e.g. Redmine. We will provide a migration script later. In the meantime, you can use the instructions by Christian Daehn.

Plugin Example

Simple example how to create Your first plugin.
Very important is to choose name for Your plugin which do not exist, to check what plugin name are not available go to Plugin Compatibility wiki page.
For purpose of this tutorial our plugin will be called: hermess

Step 1

Generate structure for Your plugin:

script/generate chiliproject_plugin hermess

Step 2

Generate controller for our plugin which we will use to handle our message

script/generate chiliproject_plugin_controller hermess messages index new edit update create destroy

Step 3

Add settings to our plugin. To do that we need to put in our init.rb file:

Redmine::Plugin.register :hermess do

...

settings :default => { "name" => nil,
                       "project_id" => nil,
                        "tracker_id" => nil
                     },
         :partial => "shared/our_partial_for_settings" 
end

Step 4

To handle additional gems in our plugin we just add Gemfile file.
For example:

    #Gemfile:

    gem 'will_paginate'

In that case after run bundle install in our chiliproject, he will install for Us will_paginate.