Skip to content

Highlighting hits

highlighted word inactive highlighted word inactive

BlackLab will insert <hl></hl> tags around all hits in your document.
The default settings will transform these into <span class="hl"></span> elements, which will be styled with a background color in the default CSS.
Additionally the paginator will allow you to jump to the next or previous hit in the document, it relies on the hl class to find the hits in the document.

WARNING

⚠️ It's important that you use the hl class for hits in your document, as the interface relies on this to highlight hits in the document view.

Example setup for correctly highlighting hits using a custom article.xsl file:

xml
<doc>
	<w>The</w>
	<w>quick</w>
	<w>brown</w>
	<w>fox</w>
	<w>jumps</w>
	<w>over</w>
	<w>the</w>
	<w>lazy</w>
	<w>dog</w>
</doc>

The paginator

It's important that you follow the convention of using hl as class for the hits, as the paginator element that lets you jump to the next or previous hit in the document relies on this. We simply look for elements with the class hl and let you jump to the next or previous one.

The paginator will hide itself if it can't find any hits in the document.

hit paginator

Apache license 2.0