Описание тега html-help

Описание тега Вопросы с тегом
Microsoft HTML Help is a help system to use compiled HTML web content (in ".chm" files) for help topics. Use this tag for questions about using the "HTMLHelp" API and for general questions about designing and using the system. Questions about building HTML Help content with the "HTML Help Workshop" program should use the [html-help-workshop] tag.

HTML Help was Microsoft first help system to use HTML web content for help topics and was first shipped with IE4 and Windows 95 many years ago. Microsoft have created other help systems since WinHelp (.hlp) and HTML Help (.chm) but they are tied to various systems:

  • MS Help 2.0 for Visual Studio 2002/2003/2005/2008 & Office help.
  • AP Help for Windows Vista OS/OEM help (based on MS Help 2)
  • MS Help Viewer 1.0 for Visual Studio 2010 help.
  • MS Help Viewer 2.0 for Visual Studio 2012 & Windows 8 OS/OEM help.

So for offline (local) help, HTML Help is the only Microsoft help platform available for general application help unless you turn to 3rd party solutions or use web pages.

HTML Help is in maintenance mode, which means no new features are expected for either the runtime or the compiler. Only critical updates will occur from here on. All mainstream development on HTML Help has stopped.

HTML Help Workshop is used to compile the content to a.chm compressed help file. The Table of Contents file (.hhc) and Index file (.hhk) are authored using Microsoft's free HTML Help Workshop tool or other 3rd party solutions. The HTML Help viewer (part of Windows Operating System) can then open and display the contents of the.chm help file using hyperlinks and standard TOC/Index/Search tabs to navigate the help content.

The HTML Help runtime files (needed to view a.chm help file) are part of the Operating System (Windows 95 and higher). When you double click a.chm help file the HTML Help Viewer (hh.exe) runs and displays your help file.

HTML Help is an older ANSI technology. This means when compiling foreign language help you must be on a foreign language machine or have Windows regional settings set correctly in Control Panel. To neglect this will cause problems with sorting etc. Using Unicode HTML topics will also cause problems. Always make sure your translators work in ANSI format.