2. Components

Since Microsoft introduced Windows 3.1 in the market, help files such as WinHelp 3 (for Windows 3.1 and Windows NT 3.x operating systems) and WinHelp 4 (for Windows 9x and Windows NT 4 operating systems) have been developed.

Windows help files (HLP) in general consist of several different files, such as: HPJ, CNT, RTF, and BMP/SHG (or other graphic files). To create a HLP file, a HPJ file is used by a compiler (Microsoft Help Compiler) to compile one or more RTF files and image files (BMP or SHG) to generate a HLP file.

• HPJ (Help Project): This is a text file format containing essential information for the Microsoft Help-Compiler, used for putting all single help files together in one. HPJ files can be edited with text editors; however it is preferable to use localisation tools for adjusting the translated help files. HPJ files consist of the following sections:
  • Options: for zipping, error protocol, language, copyright, table of contents, index, table of images, etc.
  • Files: a list of all files that should be integrated in the help
  • Map: in this section, help topics are assigned with a context-ID for the context-sensitive help
  • Windows: This section contains information about the size, colour, title and position of the windows where help texts are displayed
  • Config: This section contains macros – e.g. for creating additional buttons

When localising Windows help files and particularly HPJ files, it is important to know that, generally, the translatable elements are: the title of the help, the copyright information, the title of windows and the button designations contained in macros.

• CNT (Contents file): This type of file format is used by the Microsoft Help Compiler to create the table of contents that will be used for help files. It is a text file format which contains the titles of every help topic. Every time users access help, the table of contents is generated based on CNT file. When localising CNT files, translators/localisers should consider: a) help titles and structure of the table of contents; and b) Text before the equals symbol (e.g. "2 Creating a new document=WRIPAD_CREATE_DOCUMENT"). In a .cnt file, each line starts with a level number followed by an equal symbol, which divides the translatable text (on the left of the equal symbol) from the codes which are help topic IDs (on the right of the equal symbol).
• RTF (Rich Text Format): This file actually contains the help text and can be edited with a common word processing editor or a translation memory system. Among the translatable elements in a RTF file are: the body text (hidden text for context IDs, codes for representing symbols and graphics, simple-underlined text for the pop-ups, and double-underlined text for the links); foot notes – some begin with "$" (for the titles of help topics) and others with "K" (for the index and keyword index).
• BMP/SHG files: Most of the graphics in help files are bitmap files with the extension BMP or SHG. Graphics are integrated during compilation of files
• The HLP file resulting from compilation represents the final help file.

(Adapted from Esselink, 2000, and Whale 2000b)

The main difference between Microsoft's WinHelp and HTML Help files are the source files used to create the online help files. WinHelp files are created from Rich Text Format (*.rtf) files and HTML Help files from HTML and graphic files such as *.jpg and/or *.gif.

HTML-based Compiled Help Files (CHM) in general consist of several different files, such as: HTML, HHC, HHK and image files (GIF or JPG). A HHP file containing all help settings is used by a help compiler (such as Micrososft's HTML Help Workshop compiler) to compile one or more HTML and image files to generate a CHM file.

• HTML files: HTML files used in help projects are edited like regular HTML files using a TM system or a HTML editor. Since the HTML files contain tags with formatting information and plain text, tags should be protected and text translated.
• HHP files: These text-only files contain all settings used to compile the HTML Help file. They can be edited using the text editor. Translatable elements in these files are, for example: the title of the HTML Help file which is displayed in the title bar of the help file; windows titles; button names; text in pop-ups, etc.
• HHC files: These files, also referred as sitemap files, contain the table of contents for HTML Help files. For localising these files a text editor or a HTML editor can be used.
• HHK files: These files replace the keywords and footnotes from RTF files used in WinHelp projects. They contain the search keywords list that is included in the HTML Help files. HHK files can be translated in a text editor or using translation memory systems.

HTML as well as HTML Help formats are thought to become the most commonly-used file formats for Help projects in the future.

(Adapted from Esselink, 2000)

Readme files are usually text files (*.txt) free of formatting information that usually comes with application setup disks. These files contain information which was probably not available when the manuals were created or printed – such as corrections, additions, etc. Readme files can be edited with a text editor like Notepad or with Microsoft Word if they are *.doc files.