References

There are two types of references. You can either refer to another location within your document or refer to other documents contained in the project.

Internal References

For the first case, for example for references within a collective document, use <<reference>>. You can also simply write “ref” in the text and complete the syntax using adoc Coach.

In any case, you need a reference point for the link. Unless otherwise selected, this is the heading. However, as this often changes over time, we have a tip for you here:

Create an anchor ID above the heading and refer to the ID instead of the heading. The ID is not displayed in the document and can therefore remain the same.

External References

As soon as the text you want to refer to is not contained in your document, you need an external reference (also known as a cross-reference). This is inserted with xref:.

A window opens with all available documents that you can refer to. Again, we advise you to set an anchor ID.