Open any topic . Place the cursor at the appropriate location where you want to insert a reference.
Use cross-references to link your information within the topic or across multiple topics, or to a section in a topic.
Cross-references are references to information located in a topic or across multiple topics. They appear as links that take the reader to the referenced items. If you are writing a reference topic, you may want to include references from one topic to another that are automatically updated and display the correct references in the generated output. You can specify whether cross-references are derived from a bookmark, description, figure, heading, paragraph, table, or from a title you’ve created. You can also determine the cross-references format, such as Page number, Chapter number, and more.
Cross-references can dynamically change based on the output types. For an online output, cross-references look like normal hyperlinks, while for print-based outputs, the cross-references can be used to convert online links to page number references. For example, "See on Page 15."
To insert a cross-reference, follow these steps:
Open any topic . Place the cursor at the appropriate location where you want to insert a reference.
In the standard toolbar, click the Insert Link icon and select cross-reference
or alternatively, press CTRL+R. The Cross-reference dialog box opens.
You can select the settings that you want to insert from the following options:
Type |
Format |
Bookmark A bookmark is an incremental link within a topic. This helps to create links which, when clicked, take the reader to a bookmarked section of the topic. |
|
Description The Description shows the topic description as entered in the topic properties. |
|
Figure The HTML <figure> element contains an image, that is referenced in the topic and is specified using the <figcaption> element. |
|
Heading The HTML <h1> to <h6> elements represents six levels of headings. The heading elements are H1, H2, H3, H4, H5, and H6. |
|
Paragraph The HTML <p> element represents a paragraph. |
|
Table Creates a cross-reference to the table and is represented by caption. You can define the caption in the Author view. |
|
Title The title of the selected topic comes from the topic properties. You can edit the topic title from the topic properties. |
|
Click Insert.
The cross-reference is added to the topic.
The Screen Tip and Display In options are also available for cross-references.
Every cross-reference is dynamically linked to its target. This means that if anything is updated in the target, the cross-references are automatically updated.
For example, if a reference points to a heading on page 5 (i.e. See "Project Reviews" on page 5), and if the heading page number changes due to some text being added or deleted, the cross-reference number will update automatically (i.e., See "Project Reviews" on page 8).
This automatic and dynamic management of references enables you to add a reference once without worrying about having to update it whenever something changes in the topic.
Sign in to your account