In another new Flare project, I copied in only the. Since the search did work on the most fundamental of levels, the next logical step was to try and clean up the results. htm files that support context-sensitive help, were being pulled into the search results. Files that weren't normally indexed when you generate a Flare project, such as the. htm files that already live on our website and just dump them into a new Flare project and see how the search works." I can't speak to how intelligent Flare is when it comes to phrases, word proximity, classic SEO stuff, but suffice to say they were not key to implementing the search on our site. Basically, Flare iterates through topic files and extracts the words, topic titles, and URLs. What happened next: A story of some failures with a happy endingįrom using Flare, I had some anecdotal understanding of how the search functionality for the HTML5 Flare output was constructed. It immediately fit some of the criteria, primarily that there was no additional expense associated with implementing it, and the implementation would utilize software that our writers were already familiar with. ![]() I explored some other options, but from the start it was evident to me that we could leverage Flare 12 to implement the search system we wanted. Flare 11 introduced numerous fixes and improvements to previous version, and Flare 12 has continued that. For the HTML5-based formats, Flare constructs a fairly comprehensive client-based (i.e., Javascript-based) search system. I wanted to ensure that users would always be directed to framed, in-context content. This is an issue with searching MadCap Flare's tripane content even from major search providers such as Google and Bing. And even if you do enable the option, adding extra steps for navigating a website is undesirable. Any subsequent topic you navigate to from the unframed topic will also be missing the wrapper. If you do not enable this option, it is difficult to return to the framed view. MadCap Flare provides an option when you generate the help system that will embed a link in each topic that, when clicked, reopens the topic within the wrapper. When you do, the table of contents is not displayed (since the topic is not being displayed in a frame), which can leave a user without a clear indication of where in the hierarchy of topics they are, as well as preventing them from easily navigating to other topics in the help system. One of the limitations of the tripane skin is that it is possible to access a topic file directly. htm file rendered in an iframe) alongside a table of contents, functionally a wrapper for the topic. The tripane format utilizes frames to display a topic (architecturally, an. ![]() The Tenable technical writing team utilizes MadCap Flare in the day to day to produce content predominantly in Flare's tripane format.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |