Table of Contents
User Guide
Local Links
Local Links
Local links are links to a location in the topic; they are resolved at publish so they require little maintenance.
Setting Element IDs
Assign unique IDs for elements you want to create local links to.
Inserting Local Links
Insert a local link to an element in the topic.
Local Links

Local links are links to a location in the topic; they are resolved at publish so they require little maintenance.
section
Local links are links to elements within a topic. They are commonly used to link to another section or step in a topic. And because link names are generated at publish, you don’t have to manually enter the link name or maintain it. Let’s look at some examples:
You can create a local link to another section in the topic. At publish, the local link resolves to display the section title. For example:
In Task topics, local links are useful for creating links to other steps. We recommend using local links in situations you would write “Repeat step X to…”. Instead of writing out the step number, you can insert a local link. Then, at publish the step number resolves and displays as the local link name. So if the step order changes, the link name will resolve to the correct number at publish. For example:
To create a local link, you need to first assign an unique ID to the element you’re linking to. Then you can insert a local link to that element. For more information, see Setting Element IDs.
Setting Element IDs

Assign unique IDs for elements you want to create local links to.
  1. In the Content Manager, open a topic and place your cursor in the element you want to create an unique ID for.
  2. Right-click the element, select Make Reuseable (Set ID) and then select the element you want to make reusable.

    Step Information

    Expected Result
    The Set id dialog displays with an automatically generated ID.

  3. In the Id field, enter a unique ID for it. You should use an ID name related to the step so it’s easier to identify later.

    Example
    Set the ID for a Step element as repeatCreateAnother.

result

You set an unique ID for an element you want to link to. Now, you’re ready to start Inserting Local Links.

Inserting Local Links

Insert a local link to an element in the topic.
prereq
You must have an unique ID assigned to the element you want to link to. For more information, see Setting Element IDs.

  1. In the Content Manager, place your cursor where you want to insert a link link.
  2. In the Link Menu , click Insert Xref .

    Step Information

    Expected Result
    A link element is inserted in the topic.

  3. Select the empty link element and click Local Link.

    Expected Result
    The Available elements with IDs dialog displays.

  4. Select the element you want to link to.

    Expected Result
    A local link to the element is created and the Id for the element displays.

result

You inserted a local link to a reusable element in the topic. In easyDITA, the local link displays the element Id. When published, the link will resolve to display the step number: