1 | {
|
2 | "title": "Note",
|
3 | "@id": "stencila:Note",
|
4 | "extends": "Entity",
|
5 | "category": "text",
|
6 | "role": "secondary",
|
7 | "status": "unstable",
|
8 | "description": "Additional content which is not part of the main content of a document.",
|
9 | "$comment": "A note is usually associated with a word or paragraph using a number or other symbol. \nIt can be displayed as a footnote, endnote, or side note, or in interactive elements.\nFor analogues, see \n- [JATS `<fn>`](https://jats.nlm.nih.gov/publishing/tag-library/1.2/element/fn.html)\n- [Pandoc footnotes](https://pandoc.org/MANUAL.html#footnotes)\n- [HTML `<aside>`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/aside)\n",
|
10 | "properties": {
|
11 | "type": {
|
12 | "@id": "schema:type",
|
13 | "description": "The name of the type.",
|
14 | "type": "string",
|
15 | "enum": [
|
16 | "Note"
|
17 | ],
|
18 | "default": "Note",
|
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 | "noteType": {
|
34 | "@id": "stencila:noteType",
|
35 | "description": "Determines where the note content is displayed within the document.",
|
36 | "type": "string",
|
37 | "enum": [
|
38 | "Footnote",
|
39 | "Endnote",
|
40 | "Sidenote"
|
41 | ],
|
42 | "from": "Note"
|
43 | },
|
44 | "content": {
|
45 | "@id": "stencila:content",
|
46 | "description": "Content of the note, usually a paragraph.",
|
47 | "type": "array",
|
48 | "items": {
|
49 | "$ref": "BlockContent.schema.json"
|
50 | },
|
51 | "$comment": "Most notes will have a single paragraph but could have multiple\nparagraphs, tables and even figures.\n",
|
52 | "from": "Note",
|
53 | "isArray": true
|
54 | }
|
55 | },
|
56 | "required": [
|
57 | "type",
|
58 | "content"
|
59 | ],
|
60 | "file": "Note.schema.yaml",
|
61 | "children": [],
|
62 | "descendants": [],
|
63 | "$schema": "http://json-schema.org/draft-07/schema#",
|
64 | "$id": "https://schema.stenci.la/v1/Note.schema.json",
|
65 | "source": "https://github.com/stencila/schema/blob/master/schema/Note.schema.yaml",
|
66 | "type": "object",
|
67 | "additionalProperties": false,
|
68 | "propertyAliases": {}
|
69 | }
|