Home

Supplement

This is a Stencila-native type corresponding closely to the JATS <supplementary-material> element.

It is used to attach supplementary works to a document while still allowing them to appear as block content near the material they support, such as within a figure caption or a dedicated supplementary materials section. This lets Stencila model supplements as document content rather than only as distant metadata attachments.

Key properties include workType, label, caption, and target.

Analogues

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

Properties

The Supplement type has these properties:

NameDescriptionTypeInherited from
workTypeThe CreativeWork type of the supplement.CreativeWorkType-
labelA short identifier or title for the supplement (e.g., "S1").String-
labelAutomaticallyWhether the supplement label should be automatically generated and updated.Boolean-
captionA brief caption or description for the supplement.Block*-
targetA reference to the supplement.String-
compilationMessagesAny messages generated while embedding the supplement.CompilationMessage*-
workThe CreativeWork that constitutes the supplement.CreativeWorkVariant-
idThe identifier for this item.StringEntity

Related

The Supplement type is related to these types:

Bindings

The Supplement type is represented in:


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

© 2026 Stencila