Skip to content
Snippets Groups Projects
Verified Commit bb8cef6c authored by Dan Allen's avatar Dan Allen
Browse files

clarify how a dot is handled in an xref target by the shorthand xref and the xref macro

parent a1e7951c
No related branches found
No related tags found
No related merge requests found
......@@ -11,6 +11,7 @@ Added::
Changed::
* Clarify that an open block can only masquarade as other paragraph or delimited blocks
* Clarify how a dot is handled in an xref target by the shorthand xref and the xref macro
== Published Q2 2023
......
......@@ -79,6 +79,8 @@ After the ID, add a comma and then enter the custom text you want the cross refe
include::example$xref.adoc[tag=text]
----
In this case, the target will be assumed to be an ID within the same document even if it contains a dot (`.`).
You can also use the inline xref macro as an alternative to the xref shorthand.
.Inline xref macro
......@@ -89,6 +91,9 @@ include::example$xref.adoc[tag=xref-macro]
However, it's best to reserve the use of the xref macro for creating interdocument cross references.
When using the xref macro, if the target contains a dot (`.`), it will be treated as a reference to another document, not an ID within the same document.
If the intention is to link to an ID within the same document, the target must be proceeded by a hash (`#`).
=== Natural cross reference
You can also create a reference to a block or section using its title rather than its ID.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment