About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
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 revisionPrevious revision
Next revision
Previous revision
Last revisionBoth sides next revision
building_a_recommendations_module [2010/07/15 13:38] demiankatzlegacy:vufind_1.x_developer_manual:building_a_recommendations_module [2015/12/14 17:18] – ↷ Page moved from vufind_1.x_developer_manual:building_a_recommendations_module to legacy:vufind_1.x_developer_manual:building_a_recommendations_module demiankatz
Line 2: Line 2:
  
 // 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.// // 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 documentation refers to VuFind 1.x; for newer versions, see [[development:plugins:recommendation_modules|this page]] instead. //
  
 ===== What is a recommendations module? ===== ===== What is a recommendations module? =====
Line 12: Line 14:
 To create a recommendations module, follow these steps: 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. +  * 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 Search/Recommend folder under both the classic and default themes. +  * 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'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.+  * 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.
 ---- struct data ---- ---- struct data ----
 ---- ----
  
legacy/vufind_1.x_developer_manual/building_a_recommendations_module.txt · Last modified: 2018/12/19 14:11 by demiankatz