Das Ergebnis-Highlighting ist ein spezielles Feature für Lucene-Suchen, über welches der Suchbegriff in den Feldern von gefundenen Ergebnisdokumenten automatisch hervorgehoben werden kann. Voraussetzung dafür ist, dass die Suche über dieses Attribut dafür aktiviert wurde.
Es kann pro Website-Besucher immer nur eine Lucene-Suche das Ergebnis-Highlighting benutzen. Dies ist grundsätzlich die letzte Lucene-Suche, welche für diesen Benutzer mit Attribut highlight="true" ausgeführt wurde.
Die Hervorhebung findet in den Ausgaben des Tags <tml:
item> für die Dokumente des Suchergebnisses statt und kann dort über die Attribute
highlightprefix und
highlightsuffix parametrisiert werden.
Als fortgeschrittenere Funktion kann die Ergebnisausgabe auch über die Methode
this.bestFragments() auf die besten Ergebnis-Fragmente eingeschränkt werden.
Nach Möglichkeit sollte die Methode
this.removeLuceneQuery() benutzt werden nachdem das Highlighting einer Lucene-Volltextsuche nicht mehr benötigt wird, um Ressourcen zu sparen.