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:

Name	Description	Type	Inherited from
`content`	The textual content of the link.	`Inline`*	-
`target`	The target of the link.	`String`	-
`title`	A title for the link.	`String`	-
`rel`	The relation between the target and the current thing.	`String`	-
`labelOnly`	Only show the label of the internal target (e.g. "2"), rather than both the label type and label (e.g. "Figure 2").	`Boolean`	-
`compilationMessages`	Messages generated while compiling the link (e.g. missing internal link or invalid external link).	`CompilationMessage`*	-
`id`	The identifier for this item.	`String`	`Entity`

The Link type is related to these types:

Parents: Entity

Children: none

Bindings

The Link type is represented in:

JSON-LD

JSON Schema

Python class Link

Rust struct Link

TypeScript class Link

Testing

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

Property	Complexity	Description	Strategy
`content`	Min+	Generate a single fixed text value.	`vec![t("text")]`
	Low+	Generate a single arbitrary, non-recursive, inline node	`vec_inlines_non_recursive(1)`
	High+	Generate up to two arbitrary, non-recursive, inline nodes	`vec_inlines_non_recursive(2)`
	Max	Generate up to four arbitrary, non-recursive, inline nodes	`vec_inlines_non_recursive(4)`

This documentation was generated from Link.yaml by docs_types.rs.

Properties

Related

Bindings

Testing