Okay. Today is actually Wednesday. In some places in the world, it’s already Thursday. But I haven’t posted for several months, so you’ll have to cut me a little slack. Let’s pretend it is Tuesday.
Today’s post comes in response to some Flare consulting I was doing last week, and was further prompted by a conversation I had with a co-worker about improving Flare’s search results.
First, if you peruse the MadCap forums, you’ve probably seen several posts on search results, with many users claiming that they have a hard time getting relevant topics to appear at the top of the search results. The responses to these questions usually deal with the technical function of the search feature in Flare, but in many cases don’t provide much actionable information for the person who can’t get a relevant topic to appear at the top of the search results.
Additionally, I was searching a MadCap Flare generated help system at work yesterday. I knew the exact name of the topic I was searching for, but when I entered that into the search form, the topic I wanted (again, an exact match to the search term) came up fifth in the search result list.
There are some coding changes that I would love to see implemented in Flare (such as utilizing index key words a key terms for search results), but barring a change to the back end code, every day Flare users need some way to improve how a specific topic appears in search results for a key word or key phrase. That is what today’s Flare Tip Tuesday is here to help you with.
Where to begin? Open Flare to the topic you want to modify.
Now, you will want to open your style sheet, and create a class of “P”. I’ll call mine HiddenTerms.
Frankly, the easiest way to do this is to open the style sheet in the internal text editor, and at the end of the document, paste the following text:
Now save your style sheet and go back to the topic you want to modify.
Somewhere in your document (it doesn’t matter where, really; I generally place mine on a new line right after the title) add a new paragraph, and type in your key word search terms. Using the style panel, set the style for that paragraph to p.HiddenTerms. Generate your output.
Now when you search for a term that you included in that paragraph, the affected topic should show up higher in the search results.
You should be aware that since the text is hidden, it obviously can’t be highlighted, so you user won’t be able to scan down the page to find the highlighted term. If that is an issue for you, then you will want to try to solve this problem a different way.
You can also use this same tip to add keywords to an image or to a video. Since Flare doesn’t know what the content of a video or image is, it can’t use that to help improve search. But you can create a hidden paragraph of text directly before or after the video or image, and load it with key word terms, so that your customer can find that image or video when they search for the proper term.