Building a Recommendations Module

IMPORTANT: This new feature was introduced in VuFind 1.0. If you are using an earlier beta version, please upgrade to take advantage of it.

Sometimes it is useful to make suggestions to a user based on their search terms. Depending on the type of search performed, the best recommendations may vary. For example, you may wish to suggest popular author names based on an author search, or common subject headings based on a subject search. The recommendations module system allows custom code to be easily dropped in place so that you can display custom messages for any search type.

To create a recommendations module, follow these steps:

• Look at the interface specification in web/sys/Recommend/Interface.php. You will need to build a class based on this interface. The existing modules in web/sys/Recommend provide examples of how this may be done.
• Create templates to accompany your new class. These will be dynamically loaded into the search results screen. Some examples can be found in the Search/Recommend folder under each of VuFind's themes.
• Once your module is built, you can turn it on by editing web/conf/searches.ini – see the comments above the [SideRecommendations] / [TopRecommendations] sections of the file for details.