Book Image

Redmine Plugin Extension and Development

By : Alex Bevilacqua
Book Image

Redmine Plugin Extension and Development

By: Alex Bevilacqua

Overview of this book

Related Content you might be interested in

Current Title:

Small book image
Redmine Plugin Extension and Development
Alex Bevilacqua
Mar, 2014 | 114 pages
No titles found
Table of Contents (16 chapters)
Redmine Plugin Extension and Development
Redmine Plugin Extension and Development
Credits
Credits
About the Author
About the Author
About the Reviewers
About the Reviewers
www.PacktPub.com
www.PacktPub.com
Preface
Preface
Free Chapter
1
Introduction to Redmine Plugins
Introduction to Redmine Plugins
An introduction to our sample plugin
Generating a new plugin
Diving into the initialization file
Summary
2
Extending Redmine Using Hooks
Extending Redmine Using Hooks
Understanding hooks
View hooks
Controller hooks
Model hooks
Helper hooks
A sample view hook implementation
Summary
3
Permissions and Security
Permissions and Security
Summarizing Redmine's permission system
Declaring custom permissions
Ensuring access restrictions in models, views, and controllers
Understanding custom content access control
Summary
4
Attaching Files to Models
Attaching Files to Models
Model preparation
Enabling attachments in our views
Controller modifications to accommodate attachments
Listing and managing attachments
Managing attachment permissions
Summary
5
Making Models Searchable
Making Models Searchable
Registering our plugin
Preparing our models to be searched
Configuring search options
Filtering search results using custom permissions
Including article content in the search
Summary
6
Interacting with the Activity Stream
Interacting with the Activity Stream
Overview of the activity stream
Preparing our model
Registering our model
Configuring an activity provider
Customizing activity entries
Summary
7
Managing Plugin Settings
Managing Plugin Settings
An overview of Redmine's global plugin settings
Enabling settings management
Configuration management
Exposing plugin methods to the settings partial
Accessing our settings
Summary
8
Testing Your Plugin
Testing Your Plugin
Testing infrastructure layout
Basics of test fixtures
Running tests
Writing functional tests
Writing integration tests
Writing unit tests
Preparing a test database
Continuous integration with Travis
Summary
Releasing Your Plugin
Releasing Your Plugin
Managing your plugin's source code
Starting a blog
Publishing your plugin on redmine.org
Announcing your plugin on redmine.org
Summary
Index
Index

Starting a blog

Now that our source has been published, we should write about why we created this plugin in the first place.

Actually, starting a blog is a bit out of the scope for this book, but if you're new to this process I would recommend GitHub Pages (http://pages.github.com), WordPress (http://wordpress.com), or Blogger (http://www.blogger.com).

Whether the goal was to solve a particular problem at work, fulfill some edge case we identified, or just scratch an itch, providing a bit of extra information about our motivation may help to encourage some users to take our plugin for a spin.

Once we begin to revise our plugin and add new features, the blog can also be used to announce new versions and include change log information.

A link to the blog can also be included within our plugin's initialization section as the author_url value (see Chapter 1, Introduction to Redmine Plugins for more information).

Previous Section
End of Section
Next Section