This is a type used in Stencila Schema for in-text citations of creative works.

It exists to represent a citation as a structured inline node that can be resolved, rendered according to a document's citation style, and enriched with rhetorical intent and pagination metadata. Unlike a plain text reference, it can preserve both the citation target and its rendered form.

Key properties include target, cites, citationMode, citationIntent, content, and any page or suffix metadata.

Analogues

The following external types, elements, or nodes are similar to a Citation:

JATS <xref>: Closest JATS cross-reference analogue for in-text citations, though Stencila citations carry richer citation-specific metadata and resolved reference data.

Pandoc Citation: Closest Pandoc analogue for inline citations, with similar support for grouped items and prefixes or suffixes.

MyST role cite: Close MyST analogue for citation syntax in authoring, though Stencila stores the citation as a resolved inline node with additional metadata.

Properties

The Citation type has these properties:

Name	Description	Type	Inherited from
`target`	The target of the citation (URL or reference ID).	`String`	-
`compilationMessages`	Messages generated while resolving the target if the citation.	`CompilationMessage`*	-
`cites`	The `Reference` being cited, resolved from the `target`.	`Reference`	-
`citationMode`	Determines how the citation is shown within the surrounding text.	`CitationMode`	-
`citationIntent`	The type/s of the citation, both factually and rhetorically.	`CitationIntent`*	-
`content`	A rendering of the citation using the citation style of the document.	`Inline`*	-
`pageStart`	The page on which the work starts; for example "135" or "xiii".	`Integer` \| `String`	-
`pageEnd`	The page on which the work ends; for example "138" or "xvi".	`Integer` \| `String`	-
`pagination`	Any description of pages that is not separated into pageStart and pageEnd; for example, "1-6, 9, 55".	`String`	-
`citationPrefix`	Text to show before the citation.	`String`	-
`citationSuffix`	Text to show after the citation.	`String`	-
`id`	The identifier for this item.	`String`	`Entity`

The Citation type is related to these types:

Parents: Entity

Children: none

Bindings

The Citation type is represented in:

JSON-LD

JSON Schema

Python class Citation

Rust struct Citation

TypeScript class Citation

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

Analogues

Properties

Related

Bindings