Add links to related content

DITA Link dialog

Use the DITA Link dialog to insert direct and indirect link to DITA content.

Figure 1. Dita Link dialog

Use the DITA Link dialog to:

A (DITA Element):

Choose the link element to use.

By default, the element is <link>.

See the DITA specification on link.

B (Target > File):

Check this option to create a link using direct referencing.

C (Target > Key):

Check this option to create a link using indirect referencing and choose a key from the Key Settings drop-down list.

D (Target > Both):

Check this option to create a link using direct or indirect referencing.

E (File/Key Settings):

If the target is set to File, select a DITA topic from the list of currently opened topics for direct references. You can also browse to select a topic that is not currently opened.

If the target is set to Key, select a key for indirect reference. You can also open the DITA Keyspace Manager dialog. In this dialog, you create a keyspace and set the default keyspace for the current topic.

F (Filter Text):

Search for the required topic or key that you want to create a link to. This smart search filters the elements as you start typing in the Filter Text box. You can filter content on the basis of the element, ID, or text (content).

Once you have found the required topic, select an element to include as a link. The link element defines a relationship to another topic.

G (Display Using):

Choose the element that provides the literal label or line of text for a link.

By default, the element is <linktext>.

See the DITA specification on linktext.

H (Display Using):

Choose the element that provides the literal label or line of text for a link.

By default, the element is <linktext>.

See the DITA specifications on linktext.

H (Text)

Specify the link text to display as literal text.

I (Format)

Choose Format and select a link format from the drop-down list:

DITA Default Format

Display the title of the reference topic.

See_Title_and_Page

Display See <topic title> on <page number>.

Title_and_Page

Display <topic title> on <page>.

J (External Link)

Insert a link to an external (non-DITA) resource. In the DITA External Xref dialog, provide the source for the external link (Refer to Key or Xref Target (href)).

Optionally, you can specify a link text. Else, the link entered in the Xref Target (href) field is used for the link text. You can also insert an external link through the main menu Insert > External Reference or the context menu.

Create a DITA link

1. If you are inserting the first link in the related-links element, place the insertion point to the right of the related-links element.

   Figure 2. Place insertion point to the right of related-links element
   

   

   
   

2. Choose View > Panels > Element Catalog to open the Elements panel. From the Elements panel, insert the <link> element.

   The DITA Link dialog is displayed.

3. Choose the DITA element link.

4. Choose a link target.

   You can choose to add a link as a direct or indirect reference to the target content.

   To add a direct link, you choose the DITA topic (.xml file) to which you want to create the link:

   1. Select the File option for the Target and choose the file containing the reference topic.

      You can select a reference topic from the current topic, any currently opened topic, or use the browse button to select an unopened topic.

   2. In the element list, select the topic to reference.

   To add an indirect link, you need to use DITA key-references.

   1. Select the Key option for the Target and click Keyspace Manager.

   2. In the DITA Keyspace Manager dialog, select the key in the defined keys list and click OK.

5. In the Display Using drop-down, choose the element to display the link text.

6. Specify the text or format to display in the link.

7. Click Insert.