Both sides previous revisionPrevious revisionNext revision | Previous revision |
configuration:highlighting [2015/12/14 20:42] – [Summon] demiankatz | configuration:highlighting [2020/09/22 14:35] (current) – demiankatz |
---|
====== Search Result Highlighting ====== | ====== Search Result Highlighting ====== |
| |
// IMPORTANT: This page refers to features that were added in VuFind 1.1. If you are using an earlier version, you will have to [[legacy:installation:migration_notes#upgrading_1.0.x_to_1.1|upgrade]]. // | |
| |
VuFind supports highlighting in all of its current search modules, but the details are slightly different for each search platform. | VuFind supports highlighting in all of its current search modules, but the details are slightly different for each search platform. |
| |
| |
===== Solr ===== | ===== Solr ===== |
| |
VuFind's main Solr-based search has customizable highlighting features controlled by the highlighting setting in [[:searches.ini]]. The related snippets setting and [Snippets_Captions] section may be used to control the display of highlighted text snippets when matches are found outside of the fields normally displayed by default as part of a search result. | VuFind's main Solr-based search has customizable highlighting features controlled by the highlighting setting in [[configuration:files:searches.ini]]. The related snippets setting and [Snippets_Captions] section may be used to control the display of highlighted text snippets when matches are found outside of the fields normally displayed by default as part of a search result. |
| |
==== VuFind 1.x Technical Details ==== | ==== Technical Details ==== |
| |
If more advanced customization is needed, note that a lot of the highlighting behavior is controlled by the default [[https://vufind.svn.sourceforge.net/svnroot/vufind/trunk/web/RecordDrivers/IndexRecord.php|IndexRecord record driver]], with some low-level pieces embedded in the [[https://vufind.svn.sourceforge.net/svnroot/vufind/trunk/web/sys/Solr.php|Solr class]]. | If more advanced customization is needed, note that a lot of the highlighting behavior is controlled by the [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php|\VuFind\RecordDriver\SolrDefault record driver]], with some low-level pieces embedded in the Search system. |
| |
==== VuFind 2.x Technical Details ==== | |
| |
VuFind 2.x works much like 1.x, though the base record driver is now found in [[https://github.com/vufind-org/vufind/blob/master/module/VuFind/src/VuFind/RecordDriver/SolrDefault.php|\VuFind\RecordDriver\SolrDefault]] and more of the highlighting logic has been moved out of the low-level Solr connection class and into the higher level Search objects. | |
| |
==== Further Reading ==== | ==== Further Reading ==== |
The [[http://wiki.apache.org/solr/HighlightingParameters|Solr highlighting documentation]] provides some information on what is possible. | The [[http://wiki.apache.org/solr/HighlightingParameters|Solr highlighting documentation]] provides some information on what is possible. |
| |
For more technical details on VuFind's highlighting implementation, see [[http://blog.library.villanova.edu/libtech/2011/03/23/highlighting-and-snippets-in-vufind-1-1/|this blog post]]. | For more technical details on VuFind's highlighting implementation (now significantly outdated), see [[http://blog.library.villanova.edu/libtech/2011/03/23/highlighting-and-snippets-in-vufind-1-1/|this blog post from 2011]]. |
| |
==== Sharing Enhancements ==== | ==== Sharing Enhancements ==== |
===== Summon ===== | ===== Summon ===== |
| |
Highlighting in the Summon module is slightly less flexible than Solr highlighting, but it works very similarly, using the highlighting and snippets settings found in [[:summon.ini|Summon.ini]]. | Highlighting in the Summon module is slightly less flexible than Solr highlighting, but it works very similarly, using the highlighting and snippets settings found in [[configuration:files:summon.ini|Summon.ini]]. |
| |
===== WorldCat ===== | ===== WorldCat ===== |
| |
==== VuFind 1.x Details ==== | VuFind's WorldCat module does not currently support highlighting. The feature was dropped in release 2.0 in the interest of simplifying the code. If you need this capability, please vote on the [[http://vufind.org/jira/browse/VUFIND-640|VUFIND-640 JIRA ticket]] so it can be prioritized appropriately. |
| |
Since WorldCat does not have a native highlighting feature, VuFind achieves highlighting of WorldCat results through the |highlight modifier in the WorldCat/list-list.tpl Smarty template -- there are no .ini settings involved. To change highlighting functionality, you can override the template and/or change the definition of the highlight CSS class. | |
| |
==== VuFind 2.x Details ==== | |
| |
VuFind 2.x's WorldCat module does not currently support highlighting. The feature was dropped in the interest of simplifying the code. If you need this capability, please vote on the [[http://vufind.org/jira/browse/VUFIND-640|VUFIND-640 JIRA ticket]] so it can be prioritized appropriately. | |
---- struct data ---- | ---- struct data ---- |
| properties.Page Owner : |
---- | ---- |
| |