Highlighting

eccenca Documentation

Introduction

Highlighting lets you highlight those parts of a Result Item that had an influence on marking the item as a hit.
This is an advanced feature and not all search engines might support it equally well or under all circumstances and in most cases it will increase the retrieval time.

Activation for a Search Query

The Common Search Attribute HighlightingResultName will activate the highlighting for a search query.

Highlighting Configuration

Configuration Location: [DataDictionary/Index/Configuration].

In addition to the plain ResultField it is possible to retrieve the content of an index field as a HighlightingField.
Those index fields must have StoreText=true.


A HighlightingResultField is returned in the result, iff

  • a highlighting was requested with the HighlightingResultName
  • the corresponding field was actually searched in the query

A HighlightingTransformer is retrieved from the HighlightingTransformerRegistry.xml by its Name.
Implementers may write their own transformers and add them to the registry as they need.

Search Result

When used the Result's HighlightingField will contain nested <HighLighted> elements enclosing the respective words or passages, which will also tell the Score of the passage.

For information see:

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.