====== Search Result Highlighting ======

VuFind supports highlighting in all of its current search modules, but the details are slightly different for each search platform.

===== Solr =====

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.

==== Technical Details ====

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.

==== Further Reading ====

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 (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 ====

If you add any significant features to your local VuFind instance, please consider sharing them in [[http://vufind.org/jira|JIRA]] for inclusion in future releases of VuFind -- there is definitely a potential for additional highlighting-related configuration options.

===== 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 [[configuration:files:summon.ini|Summon.ini]].

===== WorldCat =====

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.