Links
Link between components
You can adding link between two components or between versions of the same component. To do it, you must use the xref syntax.
The general form of a xref is xref:<version>@<component_name>:<module>:<page>#anchor and some elements are optional (version, module and anchor).
Some example for you:
| Code Synthax | Comments |
|---|---|
|
a page in same component and same version |
|
a page in same version |
|
a page in same version |
|
a page of a given version in the ROOT module (implicit) |
|
a page of a given version in the version-update module targeting an anchor |
You can find more details in our contributing documentation guide.
Anchors to navigate inside the same document
Internal cross references can be defined using My Anchor Name. To define an anchor, use [#anchor-id] at the location you want to navigate.