Implementing Highlighting in Madcap Flare's HTML5 Output
If you've ever been frustrated by the lack of keyword highlighting in Flare's HTML5 output, check out the script Scott DeLoach created for this. It works pretty well. Details for the HTML5 Highlighter are on Scott's site: http://www.clickstart.net/highlighter/.
I created a quick video tutorial showing how to actually incorporate the highlighter in Flare. It's not difficult to incorporate but does require a few steps.
(Make sure you change the video quality to 720 on the video so that it's clear.)
Why doesn't Flare include highlighting in HTML5 search results by default? In this forum thread, Scott explains that Flare's HTML5 output is intended to simulate Google's search results, which don't have highlighting. Google does bold-format words in the search results page, though, but perhaps bold formatting is new. At any rate, Google's algorithm extends well beyond keywords, so the most relevant result might not have any keywords relating to your search at all, actually.
The HTML5 highlighter works well except for one problem: it doesn't expand drop-down hotspots to automatically show keyword locations. Users have to expand the drop-down hotspot sections to see if highlighted keywords exist there.
Here are a few features I think would be worthwhile:
- A "Was this topic helpful?" type of rating with some feedback options.
- A comment field.
- A button that makes snow fall on the screen (just kidding!)
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.