Aspects of HTMLHelp

by Jan Verhoeven, 11 November 2001

HTMLHelp files have the chm extension and where introduced with Windows 98.

Like with the old WinHelp files, you can use HTMLHelp for much more then just help files for programs. HTMLHelp can be used to create E-books with full free text search capablility, DHTML, scripting etc.

HTMLHelp or WinHelp

When you want to create help files that can be used in all the windows versions then you shoud use WinHelp, but when you are targeting Windows 98 and up only, you should use HTMLHelp. HTMLHelp supports much more graphics formats than WinHelp and allows you to easily create on-line help, plus the option of using script and DHTML in your HTMLHelp files.

HTMLHelp Workshop

Before you start with HTMLHelp you need to download a free copy of the HTMLHelp Workshop. You can download it from the Microsoft web site:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp

Full-text search

HTMLHelp allows you to include full-text search.

• Click Change Project Options on the Project tab.
• On the Compiler tab check Compile full-text search information.
• Click Add/Modify Window Definitions on the Project tab.
• Add window Main if this is the first window you define.
• Check Search tab and Advanced Search on the Navigation pane tab.
• And while you are here, check the Favorites tab so that your users can add their favourite topics.

Now when you compile your help file, users can do a full-text search, retrieve a list of maching topics and have the matching words highlighted in the topic page.

Writing Topic Files

The HTMLHelp Workshop only provides a plain text editor for authoring topic files. You are better of using a proper HTML Editor. Of course you could use my BackEdit program that provides you with WYSIWYG HTML editing.