Searching in Web-Based Help
Self on Help
Thoughts from the OASIS DITA Help Subcommittee Chair
When a DITA information set is transformed into a book, the deliverable is a self-contained. Its navigation devices (page numbers, TOC, index, cross-references) are constructed from the DITA source. Likewise, when a compiled Help deliverable is created, the navigation is constructed. However, a compiled Help file is typically read in a viewing program that allows full text searching; that form of navigation is provided by the viewing engine, and is not derived from the DITA source.
But what about when uncompiled Help, such as a bunch of HTML topics, is generated from the information set? Yes, the "derived" navigation (TOC, maybe an index) might be created, but where's the full-text search? The viewing engine (a browser) only has the abiltiy to search within the current topic, and is blissfully unaware that a topic is part of a collection to topics.
Most HTML-based Help authoring tools (HATs) create a "WebHelp" output which includes JavaScript search routines that permit text searches through the collection of topics. And if HTML output is to be hosted on a Web server, a server-based search engine could be configured to permit searching through all topics.
Is the lack of a JavaScript search facility in DITA OT generated HTML output from DITA going to throttle DITA take-up? Will the benefits of a DITA authoring approach be overshadowed by the obvious inferiority of DITA-generated HTML compared to HAT-generated HTML?
Reason for choosing Eclipse Help?
Tony,
Don't the other DITA Help compilation options (e.g., chm?) offer TOC, keywords, and search?
I know that is why we built the DITA Infocenter with Eclipse Help.
Have you tried it?
It has all the DITA specs in a help format, with a button to recontextualize the TOC after following hyperlinks in the topic frame.
http://www.ditainfocenter.com
Cheers.
Bob Doyle
Eclipse Help tied to Server implementation
Bob
You are absolutely right when you point out that Eclipse Help provides integrated search, index and TOC in a tri-pane design much like a "WebHelp" output. So does this mean that DITA-generated HTML is not inferior to HAT-generated HTML?
In the Eclipse context, DITA-generated Help is equal to, if not better, than HAT-generated. However, the Eclipse context, where the Help is supporting an Eclipse application, running standalone on a server with an Eclipse InfoCenter, or installed with the Eclipse environment on end-user PCs, is rare.
By contrast, HAT-generated Help with JS search has few dependencies. The output files can be just plonked onto a CD, or copied to the G: drive, or uploaded to a Web server, without any real complications.
I'm not knocking Eclipse Help at all, by the way!
Tony