Graphics as Jumps in Windows Help Files

ID: Q67884

The information in this article applies to:

Microsoft Windows Software Development Kit (SDK) versions 3.0, 3.1
Microsoft Win32 Software Development Kit (SDK), versions 3.5, 3.51, 4.0

SUMMARY

One of the things that reduces the training required to learn Windows is the presence of consistent graphical help. You can create Help files that use graphic images as context jumps or as glossary pop-ups.

MORE INFORMATION

To use a graphic as a context jump, perform the following steps:

Create the graphic in your favorite graphics editor. The typical Windows developer has at least two tools available for this purpose:


   a. Windows Paintbrush, included with the retail release of Windows

   b. SDKPaint, provided with the Windows SDK

   A Note to Paintbrush Users
   --------------------------

   When an image is saved from Paintbrush, by default, the entire
   "canvas" is saved to disk, not just the image created. To work
   around this potential problem, after the image is complete, use the
   square outline tool (at the upper right of the tool bar) to select
   the image. If the image is not square, select the smallest bounding
   rectangle, leaving a border if desired. From the Edit menu, choose
   Copy To, and fill in the name of the file in which to save the
   selection.

Edit the file that contains the Help text. This is often called the .RTF file.

Place the cursor where the graphic should occur and turn on the strikethrough character format feature of the text editor. Word for Windows users should use double underline character formatting instead.

Insert one of the following text strings:

{bmc <filename>}
-or-
{bml <filename>}
-or-
{bmr <filename>}

This text should be struck through (or double underlined).

Turn off the strikethrough (or double underline) character format and turn on hidden text character formatting.

Type the context string for the jump destination.

Turn off hidden text character formatting.

Save the .RTF file.

Edit the .HPJ file. There must be a [BITMAPS] section in this file, and that section must include the name of the bitmap used above.

When the Help file is built, clicking the graphic with the mouse will cause Help to change to the specified context.

If the graphic has a name or other short text description, we recommend that the text also be coded as a context jump. This way, the user can click on either the graphic or the text to perform the jump. The text also provides a means for users without a mouse to perform the jump.

More information on Windows Help files is in Chapters 15 through 19 of the "Microsoft Windows Software Development Kit Tools" manual. Chapter 17 discusses context jumps, glossary pop-ups, and inserting graphics into the Help file by reference.

Additional query words: 3.00 3.10 3.50 4.00 95 win16sdk

Keywords :
Version :
Platform :
Issue type :