Home

Link

This is a hyperlink type used in Stencila Schema with analogues in HTML <a>, JATS xref-style links, and Markdown links.

It exists to represent links as structured document nodes that can target internal nodes, sections, files, or external URLs while carrying richer metadata than plain text spans. This supports stable cross-references and portable serialization across formats.

Key properties include the linked content, the target or target node, and any relationship metadata used for navigation or referencing.

Properties

The Link type has these properties:

NameDescriptionTypeInherited from
contentThe textual content of the link.Inline*-
targetThe target of the link.String-
titleA title for the link.String-
relThe relation between the target and the current thing.String-
jatsRefTypeThe value of the ref-type attribute when the link originated as a JATS cross-reference.String-
jatsExtLinkTypeThe value of the ext-link-type attribute when the link originated as a JATS external link.String-
labelOnlyOnly show the label of the internal target (e.g. "2"), rather than both the label type and label (e.g. "Figure 2").Boolean-
compilationMessagesMessages generated while compiling the link (e.g. missing internal link or invalid external link).CompilationMessage*-
idThe identifier for this item.StringEntity

Related

The Link type is related to these types:

Bindings

The Link type is represented in:

Testing

During property-based (a.k.a generative) testing, the properties of the Link type are generated using the following strategies.

PropertyComplexityDescriptionStrategy
contentMin+Generate a single fixed text value.vec![t("text")]
Low+Generate a single arbitrary, non-recursive, inline nodevec_inlines_non_recursive(1)
High+Generate up to two arbitrary, non-recursive, inline nodesvec_inlines_non_recursive(2)
MaxGenerate up to four arbitrary, non-recursive, inline nodesvec_inlines_non_recursive(4)

This documentation was generated from Link.yaml by docs_types.rs.
Edit on GitHub
© 2026 Stencila