Winhelp questions

Navigation:  »No topics above this level«

Winhelp questions

Return to chapter overview

Show/Hide Hidden Text

Click to expand/collapseHotspots in my graphics don't work in Winhelp!

Graphics with hotspots are no longer supported in the obsolete Winhelp format. Hotspots in Winhelp graphics can be imported from old Winhelp projects for use in other publishing formats but you can no longer generate Winhelp files with active hotspots.

Click to expand/collapseI would like to use browse sequences in my Winhelp files!

Browse sequences are no longer supported. They were actually only relevant in Winhelp (HTML Help and all other formats do not support browse sequences), which is now an obsolete format that is only supported backward compatibility. If you are still using Winhelp you should consider switching to HTML Help (CHM) or Webhelp (HTML) as soon as possible.

Click to expand/collapseMy published Winhelp file doesn't display a Table of Contents!

Winhelp always consists of two files: An .hlp file containing the help topics and a .cnt file containing the Table of Contents (TOC). You must always distribute both of these files if you want to have a TOC. If you only distribute the .hlp file the help will be functional but you will not have a TOC.

Click to expand/collapseThe "chapters with text" in my project are empty in the Winhelp output!

The obsolete Winhelp format doesn't support chapters with text.  If your project contains chapters with text they will be exported twice: Once as a chapter without text and once as a sub-topic of the chapter without text, with the same name as the chapter. This "duplicate" topic will contain the content of your chapter with text.

If you are publishing both to Winhelp and to formats that support chapters with text you can use Help & Manual's conditional output features to create alternative topic and chapter versions for Winhelp and the other formats.

Click to expand/collapseThe custom TOC icons I selected aren't displayed in my Winhelp output!

This is one of the many limitations of the obsolete Winhelp format. It does not support custom icons in the TOC.

Click to expand/collapseSingle top-level topics become sub-topics of the next chapter above them in the TOC!

This is an uncorrected bug in the Microsoft Winhelp format. If a chapter in the TOC is followed by a single top-level topic the single topic will become a sub-topic of the chapter above it.

This problem only affects single topics (i.e. topics that are not part of a chapter) that are top-level topics. Help & Manual automatically applies a fix to correct the problem for single topics that are not top-level topics. However, there is no solution for the top-level topics because Microsoft has not corrected the bug in the compiler. The only workaround is not to use single topics below other chapters in the TOC.

Click to expand/collapseHow can I call a Winhelp file directly from the command line?

Just execute the winhlp32.exe Winhelp viewer followed by the name of the help file you want to open:

winhlp32 "myhelp.hlp"

The viewer program is located in the Windows directory does not require a path.

Command line parameters:

-Kxxxx
Find a keyword (xxxx)

-Nxxxx
Open a specific topic using the help context number (xxxx)

-Ixxxx
Open a specific topic using the topic ID (nnnn)

-H
Run Winhelp and open Winhelp.hlp (help on help)

Examples:

winhelp32 -N23678 "myhelp.hlp"

Opens the file myhelp.hlp and displays the topic with the context number 23678.

winhelp32 -Iintroduction "myhelp.hlp"

Opens the file myhelp.hlp and displays the topic with the ID introduction.

Click to expand/collapseOur programmers need a list of help context numbers!

Select Context Tool in the Tools tab and then select the option Export Map File. This exports the Topic IDs and corresponding context numbers to a standard map file. See The Help Context Tool for full instructions.

Winhelp is not supported by default in Windows Vista:

Support for Winhelp is disabled by default in Microsoft Windows Vista. Even if your applications run under Vista, any calls to Winhelp help will simply produce an error message. Support for Winhelp can be added by downloading and installing the Vista version of the Winhelp viewer from Microsoft but developers are not permitted to distribute this update with their products. It is also possible that the operating system support for Winhelp may be removed in the future. We thus strongly recommend that you start transitioning to an alternative help format as soon as possible. See here for details

See also:

Winhelp (Help Formats)