Creating Related Topics in FrameMaker
Related topics provide a list of other topics that may be of interest to the user viewing the current topic. For example, you could have a section called Creating Web Pages in your help. You may also have many other topics, such as HTML Tags and Cascading Style Sheets, that related to creating Web pages. Identifying these related topics for users can help them find the information they need and identify additional topics to consider. However, providing these types of links as cross-references within the content itself may not be the most efficient way to present the information. By utilizing related topics links, you combine the capabilities of cross-references with the efficiency of a related topics button.
Related topics and See Also links provide similar capabilities, but there are several important differences:
Related topics can link to headings in a Help system that do not start a new page.
Relate topics links are static and defined in the source documents as links. You must have all the source documents to create the link and generate the output.
If a related topics list contains a broken link in the source document, that link is broken in the generated output. In a See Also link list, the broken link is not included in the output.
The Stationery designer can configure related topics to display in the following ways:
Included as a list in the topic itself.
Displayed in a popup window when the user clicks a button, as show in the following figure.
If a related topic link is broken in the source document, in most cases that link is broken in the generated output. WebWorks Help provides an additional feature by removing broken links from related topics lists that are displayed in a popup window when a user clicks the Related Topics button.
To create related topics links, your Stationery and FrameMaker template must have a Related Topics paragraph style configured. 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 related topics links in Adobe FrameMaker source documents using unstructured Adobe FrameMaker 7.2. Steps for creating related topics links in Adobe FrameMaker may be different in other versions of Adobe FrameMaker.
To create a related topics list in an Adobe FrameMaker source document
Identify the topic in which you would like to insert a related topics list.
Identify the different topics you want to link to from this topic.
Generally, you should only create one related topics list for each section of your source document that corresponds to a help topic. For example, if the Stationery designer specified in your Stationery that there will be a page break at each Heading 1 section, then you should only create one related topics list for each Heading 1 section within your source document.
Create a cross-reference to each topic you want to include in the related topics list by completing the following steps:
Insert your cursor in the location in your Adobe FrameMaker source document where you want to insert the link to the related topic.
On the Special menu, click Cross-Reference.
In the Document field, select the source document that contains the topic to which you want to link.
In the Source Type field, click Paragraphs.
In the Paragraph Tags field click the paragraph tag used by the topic to which you want to link.
In the Paragraphs field, select the topic to which you want to link.
In the Format field, select the format you want to use for the cross-reference.
Apply the Related Topic paragraph format to the cross-references in your related topics list.
If you want to display the list of related topics in only your generated output, apply an OnlineOnly condition to the list of related topics. For more information about applying conditions, refer to “Applying Conditions in FrameMaker” on page 114.
Save your Adobe FrameMaker source document.
Generate output for your project. For more information, see “Generating Output” on page 300.
In Output Explorer, go to the page where you created the related topics list and verify that ePublisher created the related topics and that the related topics list displays the topics you specified. For more information, see “Viewing Output in Output Explorer” on page 305.