References

Internal References

There are two types of references: references within your document and references to other documents in the project.

For references within a document, use the syntax <<Target>>:

More on this in the section <<Installation>>.

The reference jumps to the heading "Installation". AsciiDoc automatically generates IDs from headings.

Setting Anchor IDs

Since headings can change over time, we recommend setting your own anchor IDs:

[[installation]]
== Installation

Or shorter:

[#installation]
== Installation

Now you can reliably reference this location:

See <<installation>> for details.
Or with custom text: <<installation,Installation Guide>>
anchor id

The anchor ID is not displayed in the document and remains stable, even if you rename the heading.

External References (xref)

When the text you want to reference is in another document, use xref::

xref:other-file.adoc[Link text]
xref:other-file.adoc#section[To the section]
xref

In adoc Studio, after entering xref:, a window opens with all available documents in the project. Here too, we recommend setting anchor IDs in the target documents.

References are supported by the adoc Coach. Press ESC after << to see all available anchors, or after xref: for all documents in the project.