SUMMARY
Microsoft has developed an internal tool called the Windows
Help Authoring Toolkit for Microsoft Word version 6.0 for Windows (WHAT6). This
tool is used within Microsoft to help create Help files. Microsoft is now
providing this internal tool to our customers.
Please refer all your
questions on WHAT6 to the WHAT6 Help menu.
How to Obtain WHAT6 and Related Files
WHAT6.EXE contains WHAT6.DOT and related files.
The following
file is available for download from the Microsoft Download
Center:
For
additional information about how to download Microsoft Support files, click the
following article number to view the article in the Microsoft Knowledge Base:
119591 How to Obtain Microsoft Support Files from Online Services
Microsoft scanned this file for viruses. Microsoft used the most
current virus-detection software that was available on the date that the file
was posted. The file is stored on security-enhanced servers that help to
prevent any unauthorized changes to the file.
After downloading it, run WHAT6.EXE in an empty
directory to obtain the files it contains.
MORE INFORMATION
Introduction to WHAT6
The Windows Help Authoring Toolkit for Microsoft Word version 6.0
for Windows (WHAT6) consists of a Microsoft Word version 6.0 template file
(WHAT6.DOT), Help files to assist you in using WHAT6.DOT, and Windows programs
for creating bitmap hotspots and managing your Help project.
WHAT6
helps you create and edit Help topics. WHAT6 makes creating Help files easier
by providing dialog boxes to add Help features that would otherwise need to be
created using specialized Help coding and word- processing functions. For
example, instead of entering footnotes for a topic's context string and title,
you can type the information into a dialog box.
The Help Authoring
Template (WHAT6.DOT) makes it easier for you to:
- Create and edit topic files.
- Insert and edit topics, graphics, and hot spots.
- Format topic text and graphics.
- Save topic files in RTF format.
- View partial or complete builds of the topic file in
Windows Help.
- Insert bitmaps into your help file.
- Apply help styles.
- Format Lists.
How the WHAT6.DOT Template Works
The Help Authoring Template is similar to other Word for Windows
templates. It contains a set of specialized macros and styles that become
available when you open a document based on the template. The template modifies
existing commands and adds new commands to the Word for Windows menus. The
result is a version of Word for Windows that has all the word-processing
functionality and yet is optimized for creating Help files.
Requirements
The WHAT6.DOT template requires Microsoft Word version 6.0 for
Windows and Windows Help version 3.10.505, which is fully compatible with Word
for Windows 6.0 Rich Text Format (RTF).
WHAT6 Includes 32 Files and Uses 2.72 Megabytes of Space
The following lists give the files names and directory locations
for all files that are a part of the WHAT6 utility. There is no SETUP utility
for this tool, so you will need to copy the files to the indicated directory.
The directory choices are as follows:
\WINDOWS The Windows directory (for example, C:\WINDOWS)
\WINDOWS\SYSTEM The System directory (for example, C:\WINDOWS\SYSTEM)
\WINWORD Where WINWORD.EXE is located (for example, C:\WINWORD)
\WINWORD\TEMPLATE Where you have your Word for Windows templates (.DOT
files) are located (for example, C:\WINWORD\TEMPLATE)
\HELP The Help file working directory. You can place
this directory anywhere you want and name it anything
you want (for example, C:\WINWORD\HELP). You will need
to create this directory.
\HELP\SAMPLE Where the Help file samples will be placed. It is
usually set up as a directory off of your Help working
directory (for example, C:\WINWORD\HELP\SAMPLE). You
will need to create this directory.
WHAT6 Template Files
WHAT6.DOT WHAT6 template used by Microsoft Word version 6.0. Copy to
your \WINWORD\TEMPLATE directory.
WHAT6.STY Style sheet used by the WHAT6 template. Copy to your
\WINWORD\TEMPLATE directory
WHAT6.INI Initialization file for WHAT6. Copy to your \WINDOWS
directory.
STYLES.DLL Collection of functions used by the WHAT6 template. Copy to
the \WINDOWS\SYSTEM directory
WHAT6 Help Tools
WHPE.EXE Help Project Editor. Copy to your \HELP directory.
HCPARSE.DLL Parses the HPJ file into a format used by WHPE.EXE
SHED.EXE HotSpot Editor. Copy to your \HELP directory.
MRBC.EXE Multiple Resolution Bitmap Compiler. Copy to your \HELP
directory.
WHAT6 Help Authoring Help Files
WHPE.HLP Project Editor Help. Copy to your \HELP directory.
WHAT6.HLP Help on WHAT6.DOT. Preferably, copy it to the place
where your template is stored in your \WINWORD\TEMPLATE
directory.
BLDERROR.HLP Help Compiler Errors. Copy to your \HELP directory.
HAG.HLP Help Authoring Guide. Copy to your \HELP directory.
Help Compiler Files
HC.EXE Version 3.10.505. Copy to your \HELP directory
NOTE: 32 bit applications will need to use HCW.EXE
which is included with Professional and
Enterprise Editions of the Microsoft Visual
Basic Programming System for Windows,
Version 4.0
HC.ERR Help Compiler Error file. Copy to the \HELP directory.
HCP.EXE Protect Mode Version 3.10.505. Copy to your \HELP
directory.
HCP.ERR Help Compiler Error file. Copy to your \HELP
directory.
Sample Files
HELPEX.HPJ Copy to your \HELP\SAMPLE directory.
HELPEX.RTF Copy to your \HELP\SAMPLE directory.
Help Bitmaps
BIGBUT.BMP Copy to your \HELP\SAMPLE directory.
BOOK.BMP Copy to your \HELP\SAMPLE directory.
BULLET.BMP Copy to your \HELP\SAMPLE directory.
CHICLET.BMP Copy to your \HELP\SAMPLE directory.
CLOSED.BMP Copy to your \HELP\SAMPLE directory.
DOC.BMP Copy to your \HELP\SAMPLE directory.
EMDASH.BMP Copy to your \HELP\SAMPLE directory.
LEAF.BMP Copy to your \HELP\SAMPLE directory.
MINUS.BMP Copy to your \HELP\SAMPLE directory.
NEXT.BMP Copy to your \HELP\SAMPLE directory.
OPEN.BMP Copy to your \HELP\SAMPLE directory.
PLUS.BMP Copy to your \HELP\SAMPLE directory.
Other Files
WHAT6.ICO Icon for use with Program Manager. Copy to your \HELP
directory.
HAG.ICO Icon for the Help Authoring Guide. Copy to your \Help
directory.
CMDIALOG.VBX Common Dialog Custom control used by WHPE.EXE.
Copy to your \WINDOWS\SYSTEM directory.
WHAT6.TXT A readme file similar to this article.
WHAT6.HLP Help File
After you copy the WHAT6.HLP file to your computer, note which
directory it is in. Then modify the macro called HelpOnWhat to point to this
location by following these steps:
- From within Word version 6.0, choose New... from the File
Menu.
- From the New dialog, select the Document radio button in
the lower left and then select WHAT6 from the Template Combo Box.
- Choose Macro from the Tools menu.
- Select HelpOnWhat from the Macro Name Combo Box, and choose
Edit.
- Find the line of code that reads:
t = WinHelp(hwnd,"\\merlin\winhelp\what\help\what6.hlp", hlpINDEX, 0)
- Edit the command line so that it matches the location of
the help file (for example, replace "\\merlin\winhelp\what\help\what6.hlp" with
"C:\WINWORD\TEMPLATE\WHAT6.HLP").
- From the File menu, choose Close, and save the macro.
- Close your document. When you're asked if you want to save
changes to the .DOT template, choose Yes.
Setting up Icons in Program Manager
When you finish copying all the files to their correct locations,
you may want to set up icons for some of the files and place them in a group in
Program Manager. To do this, follow these steps:
- Select an existing group or create a new group in Program
Manager. To create a new group, choose New form the File menu in Program
Manager. Select Program Group, and choose OK. Then type in a description for
the new group and choose OK.
- Once you have a program group selected, choose New form the
File menu in Program Manager. Select Program Item, and choose OK. Then type in
a description, command line, and working directory, and choose OK. Repeat this
process for each of these items:
Description: Help Project Editor
Command Line: C:\WINWORD\HELP\WHPE.EXE
Working Directory: C:\WINWORD\HELP
Description: HotSpot Editor
Command Line: C:\WINWORD\HELP\SHED.EXE
Working Directory: C:\WINWORD\HELP
Description: Help Compiler Errors
Command Line: C:\WINWORD\HELP\BLDERROR.HLP
Working Directory: C:\WINWORD\HELP
Description: Help Authoring Guide
Command Line: C:\WINWORD\HELP\HAG.HLP
Working Directory: C:\WINWORD\HELP
For this last item (HAG.EXE), an icon file is provided. To use
it, click the icon that you just created in the program group in Program
Manager to select it. Then choose Properties from the File menu, and select
Change Icon. In the File Name field, type the path and file name of the desired
icon (for example, C:\WINWORD\HELP\HAG.ICO), and choose OK.
Getting Started
Follow these steps to get started learning to use the Project
Editor and the WHAT6 template to create a new Windows Help File.
- Assuming you have set up icons for the installed components
as described above, double click the Help Project Editor.
- Choose Project from the Edit menu in the Project Editor.
- In the Project Dialog box, create the Title and Contents
description for your project. Use 3.1 as your help version, or the WHAT6
template won't be used. Choose OK when finished.
- From the Edit menu, choose Add New or Existing File.
- When the dialog box appears, type in a new file name with
an .RTF extension. Choose OK.
Choose Cancel if a dialog box appears
with this message:
"<filename>.RTF does not exist. Create it,
based on WHAT30.DOT?"
Return to Step 2. The project editor has not
been set up correctly. Make sure you selected 3.1 as the help version.
Everything is fine if a dialog appears with this message:
"<filename>.RTF does not exist. Create it, based on WHAT6.DOT?"
Choose OK. The file will then be added to the project list.
- Select the file in the project list. Then from the Edit
menu, choose Edit File. This will load Word version 6.0 for Windows and open
your file using the WHAT6 template.
- For further instruction on how to use the Help Project
Editor or the WHAT6 template, please see the Help file provided for each of
these tools by using the Help menu.
Multiple Resolution Graphics
In addition to the .DOT and .HLP files, the WHAT6.EXE
self-extracting file also contains tools (SHED.EXE and MRBC.EXE) to help you
compile multi-resolution bitmaps (MRBMs) into your help file. You can use these
tools to make your graphics look good on monitors of various resolutions.
To create MRBMs, first take screen dumps of your graphic in each of
the resolutions you need (EGA, VGA, and 8514). Then create three separate .SHG
files using SHED.EXE (hotspot editor). Even if you don't have hotspots in your
graphic, create the separate *.SHG files. Then combine the three .SHG graphics
into one .MRB using MRBC.EXE.
When making this kind of file, be sure
to archive the original .BMP and .SHG files in case you need to modify anything
later.
It is useful to use SHED even if you're not putting hotspots
in the graphic. SHED interprets graphics the same way WINHELP.EXE does. You can
be reasonably sure that once the graphics are saved in SHED, they will look
good in your Help file.