| 1 | {
|
| 2 | "title": "Include",
|
| 3 | "@id": "stencila:Include",
|
| 4 | "category": "metadata",
|
| 5 | "description": "A directive to include content from an external source (e.g. file, URL) or content.\n",
|
| 6 | "role": "secondary",
|
| 7 | "status": "unstable",
|
| 8 | "extends": "Entity",
|
| 9 | "properties": {
|
| 10 | "type": {
|
| 11 | "@id": "schema:type",
|
| 12 | "description": "The name of the type.",
|
| 13 | "type": "string",
|
| 14 | "enum": [
|
| 15 | "Include"
|
| 16 | ],
|
| 17 | "default": "Include",
|
| 18 | "from": "Entity"
|
| 19 | },
|
| 20 | "id": {
|
| 21 | "@id": "schema:id",
|
| 22 | "description": "The identifier for this item.",
|
| 23 | "type": "string",
|
| 24 | "from": "Entity"
|
| 25 | },
|
| 26 | "meta": {
|
| 27 | "@id": "stencila:meta",
|
| 28 | "description": "Metadata associated with this item.",
|
| 29 | "type": "object",
|
| 30 | "from": "Entity"
|
| 31 | },
|
| 32 | "source": {
|
| 33 | "@id": "stencila:source",
|
| 34 | "description": "The source of the content, a URL or file path, or the content itself.",
|
| 35 | "type": "string",
|
| 36 | "from": "Include"
|
| 37 | },
|
| 38 | "format": {
|
| 39 | "@id": "schema:encodingFormat",
|
| 40 | "aliases": [
|
| 41 | "encoding",
|
| 42 | "encodingFormat"
|
| 43 | ],
|
| 44 | "description": "Media type, typically expressed using a MIME format, of the source content.",
|
| 45 | "type": "string",
|
| 46 | "from": "Include"
|
| 47 | },
|
| 48 | "content": {
|
| 49 | "@id": "stencila:content",
|
| 50 | "description": "The content to be included.",
|
| 51 | "$comment": "Currently assumes that included content will be block content.\nThis presumes that there will be limited instance where a user would\nwant to use an `Include` node to transclude inline content.\n",
|
| 52 | "type": "array",
|
| 53 | "items": {
|
| 54 | "$ref": "BlockContent.schema.json"
|
| 55 | },
|
| 56 | "from": "Include",
|
| 57 | "isArray": true
|
| 58 | }
|
| 59 | },
|
| 60 | "required": [
|
| 61 | "type",
|
| 62 | "source"
|
| 63 | ],
|
| 64 | "file": "Include.schema.yaml",
|
| 65 | "children": [],
|
| 66 | "descendants": [],
|
| 67 | "$schema": "http://json-schema.org/draft-07/schema#",
|
| 68 | "$id": "https://schema.stenci.la/v0/Include.schema.json",
|
| 69 | "source": "https://github.com/stencila/schema/blob/master/Include.schema.yaml",
|
| 70 | "type": "object",
|
| 71 | "propertyAliases": {
|
| 72 | "encoding": "format",
|
| 73 | "encodingFormat": "format"
|
| 74 | },
|
| 75 | "additionalProperties": false
|
| 76 | }
|