Specifying Context-Sensitive Help Links in FrameMaker
You can use TopicAlias markers that contain topic IDs or Filename markers that specify file names to create context-sensitive help. If your output format supports the use of mapping files and topic IDs, typically you use TopicAlias markers to create context-sensitive help. If your output format does not support the use of mapping files and topic IDs, typically you use Filename markers to create context-sensitive help.
To specify a context-sensitive help link, your Stationery and template must have a TopicAlias or Filename marker type configured. Consult with the Stationery designer to determine which marker type you should use to create context-sensitive help links in your source documents. 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 context-sensitive help links in Adobe FrameMaker source documents using unstructured Adobe FrameMaker 7.2. Steps for creating context-sensitive help links in Adobe FrameMaker may be different in other versions of Adobe FrameMaker.
To create a context-sensitive help link in an Adobe FrameMaker source document
Open the Adobe FrameMaker source document that contains the context-sensitive topic you want to link to when users click a help button or help icon from within an application.
Insert your cursor at the beginning of the topic or paragraph in which you want to link.
On the Special menu, click Marker.
In the Marker Type field, select the marker type the Stationery designer configured your Stationery to support from the drop-down list. For example, select TopicAlias or Filename.
If the TopicAlias or Filename 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 topic ID or file name you want to use for the context-sensitive help link. Specify topic IDs or file names that met the following guidelines:
Must be unique
Must begin with an alphabetical character
May contain alphanumeric characters
May not contain special characters or spaces, with the exception of underscores ( _ )
Click New Marker.
Save your source Adobe FrameMaker source document.
Generate output for your project. For more information, see “Generating Output” on page 300.
In Output Explorer, complete the following steps:
Verify that ePublisher inserted the topic ID into the map file when it generated output.
Test the generated output using the application and verify that the application links to the appropriate context-sensitive help topic. This testing ensures the context-sensitive help link you created displays correctly within the application.