OPS xref#

The worker loads xrefmap.yml (or .yaml / .json) from each repo’s docs root and uses it to resolve <xref:Uid> and [text](xref:Uid) references. Unresolved uids render as a dashed monospace box so the author sees the typo.

Autolink form#

The autolink form <xref:System.Console> renders as Console. Hover the link — it opens in a new tab against the URL declared in xrefmap.yml.

Sample uids defined in the handbook’s xrefmap:

• Vellum Handbook

• OPS Tabs

• OPS Includes

• Console

Link form (custom display text)#

The [text](xref:Uid) form lets the author override the display name. For instance, the .NET console class points at the same target as the autolink above but uses your own anchor text.

A few more:

• Handbook — local repo home.

• Tabs feature

• Includes feature

Unresolved fallback#

A uid that isn’t in the xrefmap renders as a dashed monospace box so the author sees the broken reference: Vellum.Does.Not.Exist.

And the link form: missing uid.

Mixed with prose#

The full sentence form works inline too. When you want to reference OPS Tabs mid-sentence, the inline xref drops in cleanly.