Navigation:  Reference > Help Formats >

Browser-based Help

Print this Topic Previous pageReturn to chapter overviewNext page

Browser-based Help outputs your project to normal HTML pages that can be displayed with a standard web browser, either locally or on the Internet. The Browser-based Help 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). It is cross-platform compatible and works with all major modern browsers. 

The HTML code generated for Browser-based Help has been completely rewritten from the ground up for Help & Manual 4. Instead of being based on JavaScript it now based primarily on CSS and DHTML, which means that it is compatible with all modern browsers. 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.

Browser-based help is the best choice for help on the Internet and on local intranet systems, where HTML Help and Winhelp are not so efficient.

Features and pros and cons of Browser-based Help:

File extensions:

.HTM and .HTML, graphics in .JPG, .PNG or .GIF format

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 Browser-based Help output by Help & Manual 4 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.

       For more details see Browser compatibility.

Typical use:

Online help on the web or on local intranets where the use of HTML Help is not practical. (HTML Help is primarily design for local use on single-user computers.) Quite a few users have also used Help & Manual 's Browser-based Help mode to develop websites that need to be organized in the same way as a help project.

Table of contents:

Yes

Keyword index:

Yes

Full text search:

Yes (available in the Professional version of Help & Manual only)

Context-sensitive help:

Not to the same extent as HTML Help and Winhelp, but context calls from applications to topics and anchors in topics are possible. Context popups called from applications are not supported.

Popups:

Yes. Help & Manual introduces JavaScript popups that are compatible with all current browsers.

Multimedia:

Flash animations and videos 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!

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:

Browser-based Help consists of dozens to hundreds single HTML files, graphics and other files. Not ideal for application help because of the multiple files and limited support for context-sensitive features.

See also:

Browser-based Help (Configuring Your Output)

Browser-based Help (Project Properties)

Browser compatibility

 


Page url: http://www.helpandmanual.com/help/index.html?hm_ref_formats_html.htm