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.
development:plugins:recommendation_modules

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
development:plugins:recommendation_modules [2018/03/14 18:04] – [Key Plugin Details] demiankatzdevelopment:plugins:recommendation_modules [2023/11/27 18:50] (current) demiankatz
Line 11: Line 11:
 **Default Namespace:** \VuFind\Recommend **Default Namespace:** \VuFind\Recommend
  
-**Interface:** [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/Recommend/RecommendInterface.php|\VuFind\Recommend\RecommendInterface]]+**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Recommend/RecommendInterface.php|\VuFind\Recommend\RecommendInterface]]
  
 **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['recommend'] **Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['recommend']
  
-**Service Manager Name for Service Locator:** VuFind\RecommendPluginManager (VuFind 2.x-4.x), VuFind\Recommend\PluginManager (VuFind 5.0+)+**Service Manager Name for Service Locator:** VuFind\RecommendPluginManager (VuFind® 2.x-4.x), VuFind\Recommend\PluginManager (VuFind® 5.0+)
  
-**Template Name:** To display the related record recommendations, VuFind will attempt to load a template from the Recommend folder of the current theme whose name corresponds with the class of the plugin (ignoring the namespace).  The template will have access to the plugin object as $this->recommend.+**Template Name:** To display the related record recommendations, VuFind® will attempt to load a template from the Recommend folder of the current theme whose name corresponds with the class of the plugin (ignoring the namespace).  The template will have access to the plugin object as $this->recommend.
  
-See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind plugins.+See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.
  
 ===== Configuring Recommendations ===== ===== Configuring Recommendations =====
Line 26: Line 26:
  
 Recommendations may be associated with the top or sidebar region of the search results. They may be associated with specific search handlers or set as defaults for all non-customized handlers. They may also be set up to be displayed only when empty result sets are returned. Recommendations may be associated with the top or sidebar region of the search results. They may be associated with specific search handlers or set as defaults for all non-customized handlers. They may also be set up to be displayed only when empty result sets are returned.
 +
 +===== Related Video =====
 +
 +See the [[videos:code_generators_1|Code Generators Part 1]] video for a hands-on example of building a custom Recommendation module.
 ---- struct data ---- ---- struct data ----
 +properties.Page Owner : 
 ---- ----
  
development/plugins/recommendation_modules.1521050698.txt.gz · Last modified: 2018/03/14 18:04 by demiankatz