WinHelp

Last updated
WinHelp
Filename extension
.hlp
Internet media type application/winhlp
Magic number 3F 5F 03 00 [1]
Developed by Microsoft
Initial release1990
Extended from RTF
Standard No
Microsoft WinHelp
Developer(s) Microsoft
Operating system Windows Vista, Windows 7, Windows 8, Windows 8.1
Included with Windows 3.0, Windows 95, Windows XP
Successor Microsoft Compiled HTML Help
Type Help system

Microsoft WinHelp is a proprietary format for online help files that can be displayed by the Microsoft Help browser winhelp.exe or winhlp32.exe. The file format is based on Rich Text Format (RTF). It remained a popular Help platform from Windows 3.0 through Windows XP. WinHelp was removed in Windows Vista purportedly to discourage software developers from using the obsolete format and encourage use of newer help formats. Support for WinHelp files would eventually be removed entirely in Windows 10.

Contents

History

File format

A WinHelp file has a ".hlp" suffix. It can be accompanied by an optional table of contents (.cnt) file if the help developer created one. When Windows opens a WinHelp file, it creates a .gid file in the same directory or in "%LOCALAPPDATA%\Help", containing information about the .hlp file such as the window size and location. If the user clicks the "Find" tab and enables keyword indexing, Windows creates an index file with a .fts (full text search) extension. Annotations and bookmarks for each Windows help file have the extension ".ann" and ".bmk".

A number of software tools can decompile a WinHelp file into its source documents: HPJ, CNT, RTF, BMP, and SHG. An HPJ file is the project file that is created and edited in the Help Workshop (or a third party help authoring tool). The HPJ contains information about what RTF files to compile into the help, the MAP IDs and Aliases that provide links from a calling application to the help file, and help file appearance (window size, default buttons, color schemes, etc.). The CNT file provides the table of contents for the help file. An SHG file is a "SHED" graphics file that essentially creates an image map of help calls for a graphic file (e.g., a BMP).

A number of tools can read and explore these files. (See, for example, Help to RTF and winhelpcgi.)

Summary on winHelp files
.hlpDescription
.hpjproject file (plain text?); contains a list of all .rtf files to compile into the .hlp file and some additional information
.cnt Table of Contents (TOC) file.
.rtfactual text content in Rich Text Format-format
.bmp .dib .wmf .shg picture-files in various formats: .bmp or .dib, .wmf .shg
.fts .ftgFull Text Search; used for searching through the text of help documents
.annfile with annotations (plain text?)
.bmkfile with bookmarks (plain text?)

Source files and compilation

Source files required to compile a .hlp file consist of one or more documents in Rich Text Format and a help project file with the extension .hpj, along with any image files (.bmp, .wmf, or .shg) that are used within the Help file. An optional table of contents file with the extension .cnt can also be created for use with the .hlp file.

Within the .rtf files, topics are separated by page breaks. Each topic has a series of footnotes that contain information for the help compiler:

# footnotes contain the topic ID (used to create links to that topic).
$ footnotes contain the topic name as it displays in the table of contents, index, and other locations.
K footnotes contain keywords for the index.
A footnotes contain See Also keywords.
* footnotes contain build tags.
+ footnotes contain browse sequence information.
! footnotes contain topic entry macros.

Only the # footnote is required. All others are optional.

Text in each topic can contain limited formatting, including bold text, italics, and colors. Superscript and subscript are not allowed. Jumps between topics in the same Help file usually appear in the source document as double-underlined text (green by default, though this can be overridden) followed by a topic ID in hidden text. Popup links appear in the source document as text with a single underline (also green by default) followed by a topic ID in hidden text. (In the .hlp file, the jumps show up as green text with a single underline, and popups show up as green text with a dotted underline.)

Images can be added using codes such as {bmc image.bmp}. Supported image formats include .bmp, .wmf, and .shg (used for image maps, which can contain jumps or popups that are triggered by clicking on specific parts of the image).

After the source files have been created, the help file can be compiled using a WinHelp compiler such as HCW.exe or by using a commercial software program such as RoboHelp or HelpBreeze, most of which (included the two cited here) also use hcw.exe as the backend compiler.

WinHelp appearance and features

Depending on how it has launched and what settings the Help author chose, a WinHelp file opens either to its default topic, its table of contents, or its index.

A topic in a WinHelp file opens in a separate window, in a size and initial position that the Help author may choose. Users can resize or reposition the window. The Help author can control whether the Help file stores the user's settings between sessions, or always opens in the default size and position.

When a topic is open, a title bar at the top of the Help window displays the topic title. Below that is a row of menus (File, Edit, Bookmark, Options, and Help), which control various aspects of the file. A row of buttons usually appears below the menus. The Help author controls which buttons, if any, appear. Typical buttons include Contents, Index, Back, and Print, along with << and >> buttons to browse through the file. Help authors can also create custom buttons to jump to specific topics or perform other actions.

Below the buttons is the main text area of the window. Typically, the text begins with a heading, often bold or in a larger font than the rest of the text. This heading may sometimes be in a non-scrolling region—an area of the window that does not move up or down via the scrollbar at the side of the window. Non-scrolling regions can only be used at the beginning of a topic. The Help author can control size and background color of a non-scrolling region.

Help authors can also control the background color of the main text area, where the actual text of the topic appears. This text can be formatted and arranged in many ways. Within the text, jumps appear as green text with a single underline. Single-clicking on a jump opens a different topic. Some jumps may open secondary Help windows to display information. Popups appear in the text as green text with a dotted underline. Single-clicking on a popup opens a small window with no menus, buttons, or scrollbars, sized to fit the text. Often, popups provide short definitions of key terms or other supplemental information about the main text. The popup automatically disappears the next time the user clicks or presses a key.

Many, though not all Help topics have See Also jumps at the end of the text. Depending on the Help author's preference, this feature may be a simple list of jumps under the heading See Also, or it may be a small button that, when clicked, brings up a dialog box displaying all the relevant topics. Clicking on the name of a topic in that dialog box then clicking Display opens that topic.

Most Help files also contain a table of contents and an index to help users locate information. These appear in a separate, tabbed window. Clicking on the Contents tab opens the table of contents, in which users can click on headings to see the topics. Often, headings are marked with icons that look like small books and the topics have icons that look like pages. Double-clicking on a topic (or clicking on a topic then clicking Display) opens that topic. Clicking on the Index tab opens the index, which has a typing field and an alphabetical keyword list. Typing in the typing field automatically scrolls the list of keywords to the closest match. Double-clicking on a keyword (or clicking on a keyword then clicking Display) displays the topic associated with that keyword (if only one) or brings up a list of all topics associated with it. The index is important in helping users locate information. Sometimes Help files also have a Find tab, which lets the user search for any word used in the text of the file, not just for keywords.

WinHelp also supports a feature known as context-sensitive help. Context-sensitive help is assistance that is appropriate to where the user is in the software application, and what they are trying to do.

A rather security critical feature is that one can also include a DLL file containing custom code and associating it with WinHelp topics. Effectively this makes .HLP files equivalent to executables.

End of support

At the 2006 WritersUA conference, Microsoft announced its intentions to phase out WinHelp as a supported platform. Ted Dworkin (Partner Director of WinHelp Experience) stated, "WinHelp does not meet the code standards established for Vista. These standards include security, reliability, and performance." He went on to say that WinHelp is designed in such a way that, "...we would have to rewrite it from the ground up to meet the Vista code standards. And that approach doesn't make sense given that we have two other Help systems in Vista."[ citation needed ]

The updated licensing agreement prohibits application developers from packaging the WinHelp libraries with their installers. This means that WinHelp manuals for legacy applications are not readable on a new Windows Vista (or higher version) installation. To read them, the end-user must obtain the 32-bit WinHelp viewer from Microsoft's website and manually install it. [10]

In Windows 10 and later, Microsoft does not offer a WinHelp viewer for the operating system. The last version of Windows on which it was possible to open and read WinHelp files, using an official downloadable component by Microsoft, is Windows 8.1. The open-source version of winhlp32 from Wine also works on Windows 10. It is included as part of WineVDM. Also on Windows 10 WinHelp works with winhlp32.exe from older version of Windows.

Other documentation file formats

Although documentation can be maintained entirely in a vendor-specific presentation format such as WinHelp, it is more often the case that documentation must be published in multiple presentation formats at once: Microsoft Compiled HTML Help (CHM), WinHelp, HTML pages, Java Help, PDF, etc. It would be very expensive and error-prone to maintain each format separately.

For this reason, authors often maintain documentation in an industry-standard, vendor-neutral authoring format—such as DocBook or FrameMaker—that can be used to generate several different presentation formats (including WinHelp).[ citation needed ] Various presentation files thus produced (with WinHelp or other tools) contain consistent content because they were generated from the same source.

See also

Related Research Articles

The Rich Text Format is a proprietary document file format with published specification developed by Microsoft Corporation from 1987 until 2008 for cross-platform document interchange with Microsoft products. Prior to 2008, Microsoft published updated specifications for RTF with major revisions of Microsoft Word and Office versions.

<span class="mw-page-title-main">File Explorer</span> File manager application that is included with releases of the Microsoft Windows operating system

File Explorer, previously known as Windows Explorer, is a file manager application and default desktop environment that is included with releases of the Microsoft Windows operating system from Windows 95 onwards. It provides a graphical user interface for accessing the file systems, as well as user interface elements such as the taskbar and desktop.

The taskbar is a graphical user interface element that has been part of Microsoft Windows since Windows 95, displaying and facilitating switching between running programs. The taskbar and the associated Start Menu were created and named in 1993 by Daniel Oran, a program manager at Microsoft who had previously collaborated on great ape language research with the behavioral psychologist B.F. Skinner at Harvard.

<span class="mw-page-title-main">WordPad</span> Basic word processor formerly included with Microsoft Windows

WordPad is a word processor included with Windows 95 and later. Similarly to its predecessor Microsoft Write, it is a basic word processor, positioned as more advanced than the Notepad text editor by supporting rich text editing, but with a subset of the functionality of Microsoft Word.

A Help Authoring Tool or HAT is a software program used by technical writers to create online help systems.

The ICO file format is an image file format for computer icons in Microsoft Windows. ICO files contain one or more small images at multiple sizes and color depths, such that they may be scaled appropriately. In Windows, all executables that display an icon to the user, on the desktop, in the Start Menu, or in file Explorer, must carry the icon in ICO format.

In computing, a virtual folder generally denotes an organizing principle for files that is not dependent on location in a hierarchical directory tree. Instead, it consists of software that coalesces results from a data store, which may be a database or a custom index, and presents them visually in the format in which folder views are presented. A virtual folder can be thought of as a view that lists all files tagged with a certain tag, and thus a simulation of a folder whose dynamic contents can be assembled on the fly, when requested. It is related in concept to several other topics in computer science, with names including saved search, saved query, and filtering.

Microsoft Assistance Markup Language is an XML-based markup language developed by the Microsoft User Assistance Platform team to provide user assistance for the Microsoft Windows Vista operating system. It makes up the Assistance Platform on Windows Vista.

Rich Text Format Directory, also known as RTFD, or Rich Text Format with Attachments, is a primary document format of TextEdit, an application native to NeXTSTEP and macOS which has also been ported to other versions of Unix. The file format is based on the Rich Text Format, but can also include "attachments" such as images and animations.

Compared with previous versions of Microsoft Windows, features new to Windows Vista are numerous, covering most aspects of the operating system, including additional management features, new aspects of security and safety, new I/O technologies, new networking features, and new technical features. Windows Vista also removed some others.

The Windows shell is the graphical user interface for the Microsoft Windows operating system. Its readily identifiable elements consist of the desktop, the taskbar, the Start menu, the task switcher and the AutoPlay feature. On some versions of Windows, it also includes Flip 3D and the charms. In Windows 10, the Windows Shell Experience Host interface drives visuals like the Start Menu, Action Center, Taskbar, and Task View/Timeline. However, the Windows shell also implements a shell namespace that enables computer programs running on Windows to access the computer's resources via the hierarchy of shell objects. "Desktop" is the top object of the hierarchy; below it there are a number of files and folders stored on the disk, as well as a number of special folders whose contents are either virtual or dynamically created. Recycle Bin, Libraries, Control Panel, This PC and Network are examples of such shell objects.

Windows Vista contains a range of new technologies and features that are intended to help network administrators and power users better manage their systems. Notable changes include a complete replacement of both the Windows Setup and the Windows startup processes, completely rewritten deployment mechanisms, new diagnostic and health monitoring tools such as random access memory diagnostic program, support for per-application Remote Desktop sessions, a completely new Task Scheduler, and a range of new Group Policy settings covering many of the features new to Windows Vista. Subsystem for UNIX Applications, which provides a POSIX-compatible environment is also introduced.

<span class="mw-page-title-main">ClipBook Viewer</span>

ClipBook Viewer is a discontinued utility included in the Windows NT family of operating system that allows users to view the contents of the local clipboard, clear the clipboard or save copied and cut items. A feature restricted version, called Clipboard Viewer, is available in Windows 9x and earlier.

Windows Resource Protection is a feature first introduced in Windows Vista and Windows Server 2008. It is available in all subsequent Windows operating systems, and replaces Windows File Protection. Windows Resource Protection prevents the replacement of critical system files, registry keys and folders. Protecting these resources prevents system crashes. The way it protects resources differs entirely from the method used by Windows File Protection.

<span class="mw-page-title-main">Windows Search</span> Desktop search platform by Microsoft

Windows Search is a content index and desktop search platform by Microsoft introduced in Windows Vista as a replacement for the previous Indexing Service of Windows 2000, Windows XP, and Windows Server 2003, designed to facilitate local and remote queries for files and non-file items in the Windows Shell and in compatible applications. It was developed after the postponement of WinFS and introduced to Windows several benefits of that platform.

help (command) Command in various command line shells

In computing, help is a command in various command line shells such as COMMAND.COM, cmd.exe, Bash, qshell, 4DOS/4NT, Windows PowerShell, Singularity shell, Python, MATLAB and GNU Octave. It provides online information about available commands and the shell environment.

In computing, ftype is a command-line utility on Microsoft Windows that is used to display or change the link between a file type and an executable program.

Tips is the latest of a series of tutorial hubs in Microsoft Windows that provides information about using features. Information is presented as screenshots, text descriptions, videos, and web links. As Windows upgrades have traditionally been drastic, each version since Windows 95 has had its own tutorial app, and the name has changed frequently. Notably, the feature list shown has tended to expand as newer versions of Windows are released and the most recently released tutorial receives updates through the Microsoft Store, allowing it to receive updates more frequently than Windows itself is upgraded.

References

  1. "HLP File Format". October 2009.
  2. "Download WinHelp Viewer for Windows Vista". Microsoft.
  3. "I cannot open Help files that require the Windows Help (WinHlp32.exe) program". Support. Microsoft. February 26, 2009. Archived from the original on June 28, 2009. Retrieved August 28, 2009.
  4. "Windows Help program (WinHlp32.exe) for Windows Server 2008". Microsoft. January 9, 2009. Retrieved July 30, 2019.
  5. "Windows Help program (WinHlp32.exe) for Windows 7". Microsoft. October 14, 2009. Retrieved October 20, 2009.
  6. "Windows Help program (WinHlp32.exe) for Windows Server 2008 R2". Microsoft. October 14, 2009. Retrieved July 30, 2019.
  7. "Windows Help program (WinHlp32.exe) for Windows 8". Microsoft. October 26, 2012. Retrieved July 30, 2019.
  8. "Windows Help program (WinHlp32.exe) for Windows 8.1". Microsoft. November 5, 2013. Retrieved July 30, 2019.
  9. "Error opening Help in Windows-based programs: "Feature not included" or "Help not supported"". support.microsoft.com. Retrieved 16 August 2021.
  10. "Windows Help program (WinHelp32.exe) is no longer included with Windows". Support. Microsoft. May 24, 2006. Archived from the original on June 12, 2006.