Chapter 5. Making Models Searchable

Our knowledgebase plugin is meant to facilitate the creation and management of large quantities of categorized information. Once this system grows to a certain size, it will no longer be feasible to simply navigate directly to content when a user is trying to find something generic.

Redmine provides an extremely versatile search system for all of its own internal models, which can easily be extended to plugin models through the application of a couple of built-in plugins.

This chapter will introduce the Redmine search subsystem and how our models can quickly hook into it.

We will cover the following topics in this chapter:

• Initializing our plugin to be included in Redmine searches

• Setting up the required result formatting through acts_as_event

• Getting our model ready to actually be searched using acts_as_searchable

• How Redmine permissions limit the availability of search functionality

• How custom permissions can be used to override search results