Local links are links to a specific location in a topic; they are resolved at publish so they require little maintenance.
Local links are links to other elements within a topic or other topics. They are commonly used to link to another section or step in a topic.
In Task topics, local links are useful for creating links to other steps. We recommend using local links in situations where you would write something like “Repeat step X”. Instead of writing out the step number, you can insert a local link. Then, at publish the step number resolves and displays as the link name. So if the step order changes, the link name will resolve to the correct number at publish.
Here’s an example of a local link used to reference another section in a topic:
Here’s an example of a local link used in a task topic to reference another step number:
Local links require very little maintenance because their names automatically resolve when publishing. If you use local links to reference material in the same topic, your only maintenance concern is the deletion of the linked content.
If you use local links to reference material in another topic, you must make sure any content you link to is included in the map you’re publishing. You also need to check this whenever you reuse that topic.
If the resource you’re linking to is not included in your map, the link will be unable to resolve at publish. You also may want to take into consideration that local links often reference a page number when you publish a PDF.