Home

Link

Properties

The Link type has these properties:

NameDescriptionTypeInherited from
idThe identifier for this item.StringEntity
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-
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*-

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.

© 2026 Stencila