WebHelp

<< Click to Display Table of Contents >>

Navigation:  Reference > Publishing Formats >

WebHelp

WebHelp outputs your project to normal HTML pages that can be displayed with a standard web browser, either locally or on the Internet. The WebHelp generated by Help+Manual is designed to emulate the appearance and functionality of HTML Help, with a TOC tree pane, a keyword index and full-text search (Pro version only).

The HTML code generated for WebHelp is CSS and DHTML based and is compatible with all modern browsers on all platforms (Windows, Linux, Mac OS X, Unix). It is intelligent code that automatically "downgrades gracefully" when it encounters old browses and browsers with restrictive security functions. On these browsers some of the "eye candy" functions will be turned off but the help will still be fully functional.

WebHelp is the best choice for help on the Internet and on local intranet systems, where HTML Help is restricted by Windows security barriers.

Features and pros and cons of WebHelp:

File extensions:

.htm and .html, graphics in JPG, PNG or GIF format. You can also set the extensions of your topic files to anything else required by your project in HTML Export Options (e.g. .php etc.).

Format:

A collection of HTML, graphics and other files in a directory, just like a website (it is a website)

Platforms:

All major computer platforms and browsers, including Mac and Linux

Browser compatibility:

The WebHelp output generated by Help+Manual is fully compatible with all major browsers. In addition to this the output will also work transparently on older and security-restricted browsers. It achieves this by automatically identifying browser capabilities and "downgrading gracefully", providing less dynamic and formatting features but still presenting a fully-functional help system.

Typical use:

Online help and documentation on the web or on local intranets where the use of HTML Help is not practical.

Table of contents:

Yes

Keyword index:

Yes

Full text search:

Yes (available in the Professional and Server versions of Help+Manual only)

Context-sensitive help:

Context calls from applications to topics and anchors in topics are supported. Field-level context popups displayed  within your applications are not supported.

Popups:

Yes, with JavaScript popups that are compatible with all current browsers and do not trigger popup blockers.

Multimedia:

Flash video and other video formats are supported. Support for playing the formats used must be installed on the user's computer. Also, the degree and quality of the support also depends on the support provided by the browser the user is using. So please test your output on all relevant browsers before distributing! If you really want to be sure your video will work use Flash.

Printable by user:

Limited to browser print functions, which can generally only print individual topics.

Pros:

Platform and cross-browser compatible, ideal for help on the web and intranet systems. All the flexibility and formatting power of HTML, including the ability to add functions with JavaScript etc. by adding your own code to topics and templates.

Cons:

WebHelp consists of many individual HTML files, graphics and other files.

See also:

WebHelp (Configuring Your Output)

WebHelp (Configuration Options)

Browser compatibility