Include
A directive to include content from an external source (e.g. file, URL) or content.
This schema type is marked as unstable ⚠️ and is subject to change.
Properties#
| Name | @id | Type | Description | Inherited from |
|---|---|---|---|---|
| source | stencila:source | string | The source of the content, a URL or file path, or the content itself. | Include |
| content | stencila:content | Array of BlockContent | The content to be included. See note 1. | Include |
| format | schema:encodingFormat | string | Media type, typically expressed using a MIME format, of the source content. | Include |
| id | schema:id | string | The identifier for this item. | Entity |
| meta | stencila:meta | object | Metadata associated with this item. | Entity |
Notes#
- content : !array('Currently assumes that included content will be block content. This presumes that there will be limited instance where a user would want to use an ')
Include!array(' node to transclude inline content.')
Related#
- Parent: Entity
- Descendants: None
Available as#
- JSON-LD
- JSON Schema
- Python
class Include - TypeScript
interface Include - R
class Include - Rust
struct Include
Source#
This documentation was generated from Include.schema.yaml.