Creating What’s This (Field-Level) Help in FrameMaker
If you generate Microsoft HTML Help output, you can implement What’s This help for product dialog boxes and windows. What’s This help is also known as field-level help. Only Microsoft HTML Help supports field-level help. In addition, not all products are designed to support field-level help for product dialog boxes and windows. Before you begin implementing field-level help, consult your product team to determine if field-level help part of the product design. If field-level help is part of the product design, you will also need to obtain the appropriate ID from your product team for each field-level help topic you need.
Users can view the field-level help you create using one of following methods:
Users click on the question mark icon in the upper right corner of the dialog box or window.
When users click on the question mark icon, their cursor changes to a question mark. Users can then move the question mark cursor over the fields on the dialog box or window, and Windows displays the field-level help you created in a popup window when they hover over a specific field.
Users right-click a field on a dialog box or window and then select the What’s This? option from the single option menu Windows displays.
After users select this option, Windows displays the field-level help you specify in in a popup window.
Users close the popup window that provides the field-level help by pressing the Esc key on the keyboard. When users press the Esc key, their cursor returns to the regular cursor shape for the user.
To create What’s This help, your Stationery and template must have the following items configured:
What Is This help paragraph style
Your output format must also support this feature. For more information about output formats that support this feature, see “Features Available in Each Output Format” on page 8.
The following procedure provides an example of how to create What’s This help in Adobe FrameMaker source documents using unstructured Adobe FrameMaker 7.2. Steps for creating What’s This help in Adobe FrameMaker may be different in other versions of Adobe FrameMaker.
To create What’s This help in an Adobe FrameMaker source document
Identify a topic that contains field-level help.
Apply the What Is This paragraph format to the text that contains the field-level help.
Insert your cursor into the field-level help text.
On the Special menu, click Marker.
In the Marker Type field, select WhatIsThisID from the drop-down list.
If the WhatIsThisID marker type is not on the list, check with the Stationery designer to obtain the name of the marker type the Stationery designer created to support this functionality and then use the marker type specified by the Stationery designer. For more information, refer to “Implementing Online Features in FrameMaker” on page 81.
In the Marker Text field, type the appropriate ID for the field-level description. Obtain appropriate IDs for each field-level description from your product team.
Click New Marker.
Save your Adobe FrameMaker source document.
Generate output for your project. For more information, see “Generating Output” on page 300.
In Output Explorer, verify ePublisher created the What’s This help you specified by completing the following steps:
On the View menu, click Output Directory.
Open the ProjectName folder, where ProjectName is the name of your project.
Open the whatisthis.txt file and verify that the field-level help you created is associated with the correct ID you received from your product development team.
Open the whatisthis.h file and verify that each new string you added is listed in the file.