Preparing DITA Source Documents : Creating Related Topics in DITA Source Documents : Understanding Related Topics
Understanding Related Topics
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:
*Display in a popup window when the user clicks a button,
*Included in a list in the topic itself and then displayed in a popup window when the user clicks a button.
Note: 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 popups window when a user clicks the Related Topics button.