Custom Aliases
Use a Custom Alias to give an element a unique pointer for linking to in other places in the publication. The Custom Alias is a powerful tool that can simplify link management and speed up authoring and editing.
Syntax
Create a Custom Alias by starting with a single # character, followed any alphanumeric characters, -, or _. Space characters cannot be used in an alias; the Alias will cut off before the space.
Basics
A basic Custom Alias applied to a Heading 1.
<!--#custom-alias-->
# Custom Aliased Heading
Inline syntax can be given an Alias as well.
This <!--#bold-keyword-->**bold text** has a custom alias.
Mix with Other Commands
Custom Aliases can be in the same comment tag with other commands. Separate them with a
; character. A
Custom Style and Custom Alias are written in the same tag below.
<!-- style:CustomStyle ; #custom-alias -->
Custom Alias Behavior
Custom Aliases create an entry in the document's WIF that enable linking to the element it was created with.
Using a Custom Alias
The first step in using a Custom Alias is to create one by adding the Alias tag to the location that will be linked to. Below, the Custom Alias #my-alias is created, associated with a Heading 1.
<!--#my-alias-->
# A Topic Heading
After that, the Alias
#my-alias can be used in the path value for
Links and
Link References. Once the link is clicked, it will take readers to the location the Alias was created.
Refer to the linked sections for detailed instructions on using these elements.
Some quick examples for Links:
[link text](#my-alias)
[link text](my_doc.md#my-alias)
Some quick examples for Link References:
[link text][link_key]
[link_key]: #my-alias
[link text][link_key]
[link_key]: my_doc.md#my-alias