Hyperlink types

Add & manage content

Platform_KC
Cloud

You can choose from the following link types for your published outputs:

Publishing to Print outputs

  • Cross-reference creates a page number cross-reference if the destination topic is found in the book being published. The target topic must be included in the published output for the link to be created.
  • Footnote inserts the unformatted text of the destination topic as a footnote. The target topic does not need to be included in the published output.

    Note: Footnotes are limited to a maximum of 500 characters and cannot contain multiple paragraphs or special formatting. If the destination topic contains more than 500 characters, only the first 500 characters are used.

  • Endnote creates a reference in a topic at the end of your book.
  • Embedded inline replaces the anchor text with the text of the destination topic. The target topic does not need to be included in the published output.

    Note: If a hyperlink links to a topic that contains multiple paragraphs, the embedded inline setting within the hyperlink template should not be used. Use either the embedded block or footnote when publishing to Word.

  • Embedded block inserts the fully formatted text of the destination topic as an embedded topic. If the hyperlink occupies the entire paragraph, it is replaced; otherwise, a new paragraph is created following the one containing the hyperlink. The target topic does not need to be included in the published output.

Publishing to Windows Help

  • Jump opens the destination topic in the same window. The target topic must be included in the published output for the link to be created.
  • Pop-up displays the destination topic in a pop-up window. Clicking the link opens the pop-up, clicking it again (or clicking outside the pop-up window) closes it. The target topic must be included in the published output for the link to be created.

Publishing to HTML-based outputs

  • Same window uses standard HTML <
  • New window uses standard HTML <
  • Standard pop-up in HTML, XHTML, and HTML Help, a standard pop-up uses the HTML Help ActiveX control to display the destination topic in a pop-up window. In JavaHelp and Oracle Help for Java, it uses the native pop-up functionality of those technologies. The target topic does not need to be included in the published output.

    Note: Standard pop-ups are text-only and do not display character formatting, tables, or images.

  • Expanding block uses Dynamic HTML (DHTML) to show and hide (or "expand" and "collapse") the fully formatted text of the destination topic. Clicking the link will make the topic expand and appear in a block below the paragraph containing the anchor text, and clicking it once more will make it disappear again. The target topic does not need to be included in the published output.
  • Expanding inline uses Dynamic HTML (DHTML) to show and hide (or "expand" and "collapse") the fully formatted text of the destination topic. Clicking the link will make the topic appear inline and in the same paragraph immediately following the anchor text, and clicking it once more will make it disappear again. The target topic does not need to be included in the published output.

    Note: If the destination topic contains multiple paragraphs, only the first paragraph is used.

  • Pop-up on click uses Dynamic HTML (DHTML) to display the fully formatted text of the destination topic in a pop-up window. The pop-up is activated on clicking, and remains open until closed. It can be closed by either clicking the link again, or by clicking the close button in the top-right corner. The target topic does not need to be included in the published output.
  • Pop-up on hover uses Dynamic HTML (DHTML) to display the fully formatted text of the destination topic in a pop-up window. The pop-up is displayed when the mouse is hovered over the anchor text, and disappears when the mouse is moved away. The target topic does not need to be included in the published output.

JavaHelp and expanding hyperlinks

When publishing to HTML-based outputs, the expanding links use JavaScript to expand or collapse the block of target text. In JavaHelp, which does not support JavaScript, the expanding links are handled differently than other HTML outputs. In JavaHelp the expanding link functionality is removed from the hyperlink text and the target topic is displayed in the page (directly following the hyperlink text).