ZipHelp is a new, completely open help format developed by EC Software. It is very similar to eWriter Help. However, there are key differences:

•eWriter Help is a closed, proprietary format designed specifically for packaging and displaying Help+Manual projects. It can only be displayed with our own free eViewer, for which multiple versions are available for Windows and macOS platforms.

•ZipHelp is an open format using a standard Zip archive for packaging. It can be displayed with eViewer, but since the specifications are fully open anyone can also develop their own viewer for it.

•Our own eViewer can display ZipHelp files created with Help+Manual natively in the same way as eWriter Help files.

More information

You can find full information on the ZipHelp page and in the ZipHelp Documentation. Perhaps this will inspire you to develop your own ZipHelp viewer for a platform other than Windows or macOS.

About ZipHelp

Ziphelp is basically a collection of HTML files in a compressed zip archive. It is a specification for an open cross-platform help format for software applications, based on the standard formats HTML, XML and ZIP.

You can package any HTML files, along with their supporting CSS, JS and other files, into a regular zip archive, change the extension to .zhelp, and a ZipHelp viewer lieke eViewer can read it.

But ZipHelp is more than that. It also is a protocol based on the standard sitemap protocol to provide a ZipHelp viewer with extended information about the help system in an extended sitemap file. This extended information may include help keywords or context numbers, to enable a viewer to navigate the documentation and provide accurate context-sensitive help for an app.

Should I use ZipHelp with Help+Manual?

If you are only deploying Help+Manual projects as local documentation with eViewer on Windows or macOS, then eWriter Help is an easy choice. ZipHelp would be interesting if you want to generate documentation for other platforms — for example Unix or Linux distributions, for iOS or Android, or even for more exotic real-time OSs like Integrity or VxWorks— once someone has produced an alternative viewer for them based on the open protocol.

Features and pros and cons of ZipHelp:

File extension:

.zhelp

Formats:

A standard zip archive containing HTML and supporting files, with the .zhelp extension and a special sitemap protocol file.

Platforms:

Any platform for which a viewer is created. The EC Software eViewer for eWriter Help and ZipHelp is available for both Windows and macOS. Anyone can create a viewer for other platforms based on the open specifications.

Typical use:

Local and web-based software documentation. Unpackaged ZipHelp can be viewed normally on the Web with a regular browser.

Table of contents:

Yes, if you create one. Help+Manual creates ZipHelp with a TOC automatically.

Keyword index:

Yes, if you create one. Help+Manual creates ZipHelp with a keyword index automatically.

Full text search:

Yes, if you implement it. Help+Manual creates ZipHelp search automatically.

Context-sensitive help:

Full support for context-sensitive help

Popups:

Yes, if you provide support for it in your HTML. Help+Manual projects and skins support popups.

Multimedia:

Specific support depends on what you implement in your own HTML. ZipHelp generated by Help+Manual has the same multimedia support as WebHelp.

Printable by user:

Printing by topic, as in WebHelp. Even so, we recommend providing a PDF version for printing.

Pros:

Combines benefits of CHM and WebHelp, eliminating the disadvantages of both formats. Reliable HTML rendering because the same Windows HTML engine is always used. Same layout and skinning flexibility as WebHelp.

Multi-platform support is possible. EC Software eViewer already supports Windows and macOS. Viewers for any other OS can be developed since the entire format is fully open.

Cons:

Currently Windows and macOS only.