About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


legacy:vufind_1.x_developer_manual:building_a_recommendations_module

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
legacy:vufind_1.x_developer_manual:building_a_recommendations_module [2015/12/14 17:18]
demiankatz ↷ Page moved from vufind_1.x_developer_manual:building_a_recommendations_module to legacy:vufind_1.x_developer_manual:building_a_recommendations_module
legacy:vufind_1.x_developer_manual:building_a_recommendations_module [2018/12/19 14:11] (current)
demiankatz
Line 1: Line 1:
 ====== Building a Recommendations Module ====== ====== 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.// +// This outdated page has been deleted ​to prevent confusion; for current documentation, see [[development:​plugins:​recommendation_modules|this page]]. ​To view old content ​for historical interestsee the "Old Revisions"​ list below. //
- +
-:!: // This documentation refers to VuFind 1.x; for newer versions, see [[development:​plugins:​recommendation_modules|this page]] ​instead// +
- +
-===== What is a recommendations module? ===== +
- +
-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. +
- +
- +
-===== How does it work? ===== +
- +
-To create a recommendations modulefollow these steps: +
- +
-  * Look at the interface specification in [[https://​vufind.svn.sourceforge.net/svnroot/vufind/​trunk/​web/​sys/​Recommend/​Interface.php|web/​sys/​Recommend/​Interface.php]]. ​ You will need to build a class based on this interface. ​ The existing modules in [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​sys/​Recommend/​|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 [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​interface/​themes/​default/​Search/​Recommend/​|Search/​Recommend]] folder under each of VuFind'​s themes. +
-  * Once your module is built, you can turn it on by editing [[https://​vufind.svn.sourceforge.net/​svnroot/​vufind/​trunk/​web/​conf/​searches.ini|web/​conf/​searches.ini]] -- see the comments above the [SideRecommendations] / [TopRecommendations] sections of the file for details.+
legacy/vufind_1.x_developer_manual/building_a_recommendations_module.txt · Last modified: 2018/12/19 14:11 by demiankatz