Adding a hyperlink element

This section describes the hyperlink template element, which can be used to design your document.

Before you begin

If you are using an internal link, create a bookmark.

About this task

There are two types of hyperlinks:
  • Internal hyperlinks: Resolve to a bookmark defined in the document template.
  • External hyperlinks: Resolve to an external URL.

The type of hyperlink is defined by the Internal property. The link location is defined in the content of the hyperlink. The text displayed by the hyperlink is defined by the Display property and has the default value of link.

By design, only the first line of content entered for elements that use the Content property display in the template content editor. Subsequent lines of text are hidden so that the template designer can focus on the structure of the template at a given time rather than the content of individual elements.

Rich text, for example <span>, <i>, or <sub> tags, is now supported inside links with the following considerations:
  • All the tags inside the <a> tag are rendered.
  • Images act as hyperlinks and there are no "link" strings displayed beside an image.
  • If the image is not available, its alternative text is used inside the hyperlink. If the alt text is also not available then a "link" string is used in place of the image inside the hyperlink.
Table 1. Types of internal links within a document
Link type Word/PDF HTML
XHTML<a> tag link to a Bookmark Works (independent of EnsureUnique Field in Bookmark field) Works (independent of EnsureUnique Field in Bookmark field)
Hyperlink link to a Bookmark Works (independent of EnsureUnique Field in Bookmark field) Works (independent of EnsureUnique Field in Bookmark field)
Hyperlink link to a XHTML<a> tag Works Works
XHTML<a> tag link to a XHTML<a> tag Works Works

Procedure

  1. In the Palette view, select the Hyperlink icon Hyperlink element and drag it into the template content editor.
  2. Double-click the hyperlink element to enter a link to the Content field.
  3. In the Simple Value tab, enter the link content. For an external link, the link content is the URL. For an internal link, the link content is the bookmark.
    Note: For internal links to resolve correctly, the content property for the link must be identical to the content property for the bookmark, even if the two values are data or calculated values.
  4. Click OK.
  5. Select the hyperlink element.
  6. In the Properties view, select the Specific tab.
  7. Decide if your link is internal or external.
    • If the link is internal:
      1. For the internal property, select true.
      2. For the local property, select true.
    • If the link is external:
      1. For the internal property, select false.
      2. For the local property, select false.
  8. For the display property, enter the link text for the link.
  9. Click the Save icon to save your changes.

Feedback