jro_apps/redmine Files · extra/sample_plugin/init.rb

Removed inconsistent user manual stuff (html/docbook content and controller). Help link now points to the Redmine guide which will be more easy to maintain....

Removed inconsistent user manual stuff (html/docbook content and controller). Help link now points to the Redmine guide which will be more easy to maintain. Also removed the useless components directory. git-svn-id: http://redmine.rubyforge.org/svn/trunk@835 e93f8b46-1217-0410-a6f0-8f06a7374b81

Jean-Philippe Lang - - Load All Authors

File last commit:

r742:dbcf2065b86d


                r824:a53c86f063ad

Download file

             init.rb
        
                    25 lines
            
             | 936 B
            
                | text/x-ruby
            
             |
                RubyLexer
            
             / extra / sample_plugin / init.rb
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      # Redmine sample plugin

      require 'redmine'

      RAILS_DEFAULT_LOGGER.info 'Starting Example plugin for RedMine'

      Redmine::Plugin.register :sample_plugin do

        name 'Example plugin'

        author 'Author name'

        description 'This is a sample plugin for Redmine'

        version '0.0.1'

        settings :default => {'sample_setting' => 'value', 'foo'=>'bar'}, :partial => 'settings/settings'

        # This plugin adds a project module

        # It can be enabled/disabled at project level (Project settings -> Modules)

        project_module :example_module do

          # A public action

          permission :example_say_hello, {:example => [:say_hello]}, :public => true

          # This permission has to be explicitly given

          # It will be listed on the permissions screen

          permission :example_say_goodbye, {:example => [:say_goodbye]}

        end

        # A new item is added to the project menu

        menu :project_menu, :label_plugin_example, :controller => 'example', :action => 'say_hello'

      end

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

				# Redmine sample plugin
				require 'redmine'

				RAILS_DEFAULT_LOGGER.info 'Starting Example plugin for RedMine'

				Redmine::Plugin.register :sample_plugin do
				name 'Example plugin'
				author 'Author name'
				description 'This is a sample plugin for Redmine'
				version '0.0.1'
				settings :default => {'sample_setting' => 'value', 'foo'=>'bar'}, :partial => 'settings/settings'

				# This plugin adds a project module
				# It can be enabled/disabled at project level (Project settings -> Modules)
				project_module :example_module do
				# A public action
				permission :example_say_hello, {:example => [:say_hello]}, :public => true
				# This permission has to be explicitly given
				# It will be listed on the permissions screen
				permission :example_say_goodbye, {:example => [:say_goodbye]}
				end

				# A new item is added to the project menu
				menu :project_menu, :label_plugin_example, :controller => 'example', :action => 'say_hello'
				end