Revision 2 - History - Plugin Tutorial - Redmine

Plugin Tutorial » History » Revision 2

Revision 1 (Jean-Philippe Lang, 2008-08-08 20:33) → Revision 2/119 (Jean-Philippe Lang, 2008-08-08 21:31)

h1. Plugin Tutorial 

 h2. Creating a new Plugin 

 Open up a command prompt and "cd" to your redmine directory, then execute the following command: 

   % ruby script/generate redmine_plugin pools 

 The plugin structure is created in @vendor/plugins/redmine_pools@: 

 <pre> 
       create    vendor/plugins/redmine_pools/app/controllers 
       create    vendor/plugins/redmine_pools/app/helpers 
       create    vendor/plugins/redmine_pools/app/models 
       create    vendor/plugins/redmine_pools/app/views 
       create    vendor/plugins/redmine_pools/db/migrate 
       create    vendor/plugins/redmine_pools/lib/tasks 
       create    vendor/plugins/redmine_pools/assets/images 
       create    vendor/plugins/redmine_pools/assets/javascripts 
       create    vendor/plugins/redmine_pools/assets/stylesheets 
       create    vendor/plugins/redmine_pools/lang 
       create    vendor/plugins/redmine_pools/README 
       create    vendor/plugins/redmine_pools/init.rb 
       create    vendor/plugins/redmine_pools/lang/en.yml 
 </pre> 

 Edit @vendor/plugins/redmine_pools/init.rb@ too adjust plugin information (name, author, description and version): version). 
 For example: 

 <pre><code class="ruby"> 
 require 'redmine' 

 Redmine::Plugin.register :redmine_pools do 
   name 'Pools plugin' 
   author 'John Smith' 
   description 'A plugin for managing pools' 
   version '0.0.1' 
 end 
 </code></pre> 

 Then restart start the application and point your browser to http://localhost:3000/admin/info. 
 After logging in, you should see your new plugin in the plugins list: 

 !plugins_list1.png! 

 h2. Generating a controller 

 TODO

Project

General

Profile

Redmine

Plugin Tutorial » History » Revision 2