|
|
|
Specifying Context-Sensitive Help Links in Word
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 Microsoft Word source documents using Microsoft Word 2003. Steps for creating context-sensitive help links in Microsoft Word may be different in other versions of Microsoft Word.
To create a context-sensitive help link in a Microsoft Word source document
Open the Microsoft Word 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 to which you want to link.
On the WebWorks menu, click Insert TopicAlias Marker.
In the TopicAlias field, type the topic ID you want to specify for the topic.
Click OK.
Save your Microsoft Word 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.