UNPKG

2.06 kBJSONView Raw
1{
2 "title": "Heading",
3 "@id": "stencila:Heading",
4 "extends": "Entity",
5 "role": "secondary",
6 "status": "stable",
7 "category": "text",
8 "description": "A heading.",
9 "$comment": "Analogues of `Delete` in other schema include:\n - HTML [`<h1>` to `<h6>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h1)\n - JATS XML [`<title>`](https://jats.nlm.nih.gov/archiving/tag-library/1.1/element/title.html)\n - Pandoc [`Header`](https://github.com/jgm/pandoc-types/blob/1.17.5.4/Text/Pandoc/Definition.hs#L233)\n",
10 "properties": {
11 "type": {
12 "@id": "schema:type",
13 "description": "The name of the type.",
14 "type": "string",
15 "enum": [
16 "Heading"
17 ],
18 "default": "Heading",
19 "from": "Entity"
20 },
21 "id": {
22 "@id": "schema:id",
23 "description": "The identifier for this item.",
24 "type": "string",
25 "from": "Entity"
26 },
27 "meta": {
28 "@id": "stencila:meta",
29 "description": "Metadata associated with this item.",
30 "type": "object",
31 "from": "Entity"
32 },
33 "depth": {
34 "@id": "stencila:depth",
35 "description": "The depth of the heading.",
36 "type": "integer",
37 "default": 1,
38 "minimum": 1,
39 "maximum": 6,
40 "from": "Heading"
41 },
42 "content": {
43 "@id": "stencila:content",
44 "description": "Content of the heading.",
45 "type": "array",
46 "items": {
47 "$ref": "InlineContent.schema.json"
48 },
49 "from": "Heading",
50 "isArray": true
51 }
52 },
53 "required": [
54 "type",
55 "content"
56 ],
57 "examples": [
58 {
59 "type": "Heading",
60 "depth": 2,
61 "content": [
62 "Secondary Heading"
63 ]
64 }
65 ],
66 "file": "Heading.schema.yaml",
67 "children": [],
68 "descendants": [],
69 "$schema": "http://json-schema.org/draft-07/schema#",
70 "$id": "https://schema.stenci.la/v1/Heading.schema.json",
71 "source": "https://github.com/stencila/schema/blob/master/schema/Heading.schema.yaml",
72 "type": "object",
73 "additionalProperties": false,
74 "propertyAliases": {}
75}