Properties

The Link type has these properties:

Name	Description	Type	Inherited from	JSON-LD @id	Aliases
id	The identifier for this item.	String	Entity	schema:id	-
content	The textual content of the link.	Inline*	-	stencila:content	-
target	The target of the link.	String	-	schema:target	-
title	A title for the link.	String	-	schema:headline	-
rel	The relation between the target and the current thing.	String	-	schema:linkRelationship	-

Related

The Link type is related to these types:

• Parents: Entity
• Children: none

Formats

The Link type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format	Encoding	Decoding	Support	Notes
DOM HTML	🟢 No loss
HTML	🔷 Low loss		Encoded as <a>
JATS	🔷 Low loss	🔷 Low loss	Encoded as <ext-link>
Markdown	🔷 Low loss	🔷 Low loss	Encoded using implemented function
Stencila Markdown	🔷 Low loss	🔷 Low loss
Quarto Markdown	🔷 Low loss	🔷 Low loss
MyST Markdown	🔷 Low loss	🔷 Low loss
LLM Markdown	🔷 Low loss	🔷 Low loss
LaTeX	🔷 Low loss	🔷 Low loss
PDF	🔷 Low loss
Plain text	⚠️ High loss
IPYNB	🔷 Low loss	🔷 Low loss
Microsoft Word DOCX	🔷 Low loss	🔷 Low loss
OpenDocument ODT	🔷 Low loss	🔷 Low loss
TeX	🔷 Low loss	🔷 Low loss
JSON	🟢 No loss	🟢 No loss
JSON+Zip	🟢 No loss	🟢 No loss
JSON5	🟢 No loss	🟢 No loss
JSON-LD	🟢 No loss	🟢 No loss
CBOR	🟢 No loss	🟢 No loss
CBOR+Zstandard	🟢 No loss	🟢 No loss
YAML	🟢 No loss	🟢 No loss
Lexical JSON	🔷 Low loss	🔷 Low loss
Koenig JSON	🔷 Low loss	🔷 Low loss
Pandoc AST	🔷 Low loss	🔷 Low loss
Directory
Stencila Web Bundle
Debug	🔷 Low loss

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 for each complexity level. Any optional properties that are not in this table are set to None.

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)

Source

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