16.1.6 Evaluating OmniHelp

If you need cross-platform compatibility and easy localization, and you can manage with a JavaScript-based Help system, consider OmniHelp. You can read the OmniHelp Design Report here:

http://www.dita2go.com

Unlike JavaHelp, Oracle Help, or Eclipse Help, on the client side OmniHelp is based entirely on JavaScript. OmniHelp uses only JavaScript, framesets, and CSS; and therefore works on any operating system, with any current browser. For international use, if you furnish translated versions of text contained in three small JavaScript files, you have a localized interface. A technical writer can edit the text in these files without disturbing the JavaScript code.

OmniHelp provides contents and index, full-text Boolean search with JavaScript-style regular expressions, Context Sensitive Help, related-topic links, pop-ups, and secondary windows.

See §19. Generating OmniHelp.

Previous Topic:  16.1.5 Evaluating WebHelp

Next Topic:  16.1.7 Evaluating JavaHelp and Oracle Help for Java

Parent Topic:  16.1 Weighing Help-system alternatives

Sibling Topics:

16.1.1 Considering Help-system features

16.1.2 Understanding the effects of mid-topic links

16.1.3 Evaluating Microsoft Windows Help (WinHelp)

16.1.4 Evaluating Microsoft HTML Help

16.1.5 Evaluating WebHelp

16.1.7 Evaluating JavaHelp and Oracle Help for Java

16.1.8 Evaluating Eclipse Help

Table of ContentsIndex