UNPKG

2.45 kBJSONView Raw
1{
2 "title": "Math",
3 "@id": "stencila:Math",
4 "extends": "Entity",
5 "role": "base",
6 "status": "unstable",
7 "category": "prose",
8 "description": "A mathematical variable or equation.",
9 "$comment": "This is a base type for `MathFragment` and `MathBlock` and should not\nnormally be instantiated.\nThis type has a similar structure and purpose to `Code` which is a base type\nfor `CodeFragment`, `CodeBlock` etc.\n",
10 "properties": {
11 "type": {
12 "@id": "schema:type",
13 "description": "The name of the type.",
14 "type": "string",
15 "enum": [
16 "Math",
17 "MathBlock",
18 "MathFragment"
19 ],
20 "default": "Math",
21 "from": "Entity"
22 },
23 "id": {
24 "@id": "schema:id",
25 "description": "The identifier for this item.",
26 "type": "string",
27 "from": "Entity"
28 },
29 "meta": {
30 "@id": "stencila:meta",
31 "description": "Metadata associated with this item.",
32 "type": "object",
33 "from": "Entity"
34 },
35 "errors": {
36 "@id": "stencila:errors",
37 "description": "Errors that occurred when parsing the math equation.",
38 "$comment": "This property is an array of strings. Compare this to `CodeChunk.errors`\nwhich is an array of `CodeError` nodes. Strings are considered to\nbe sufficient for math parsing errors which usually won't have stack traces,\nline numbers etc.\n",
39 "type": "array",
40 "items": {
41 "type": "string"
42 },
43 "from": "Math",
44 "isArray": true,
45 "isPlural": true,
46 "aliases": [
47 "error"
48 ]
49 },
50 "mathLanguage": {
51 "@id": "stencila:mathLanguage",
52 "description": "The language used for the equation e.g tex, mathml, asciimath.",
53 "type": "string",
54 "default": "tex",
55 "from": "Math"
56 },
57 "text": {
58 "@id": "schema:text",
59 "description": "The text of the equation in the language.",
60 "type": "string",
61 "from": "Math"
62 }
63 },
64 "required": [
65 "type",
66 "text"
67 ],
68 "file": "Math.schema.yaml",
69 "children": [
70 "MathBlock",
71 "MathFragment"
72 ],
73 "descendants": [
74 "MathBlock",
75 "MathFragment"
76 ],
77 "$schema": "http://json-schema.org/draft-07/schema#",
78 "$id": "https://schema.stenci.la/v0/Math.schema.json",
79 "source": "https://github.com/stencila/schema/blob/master/Math.schema.yaml",
80 "type": "object",
81 "propertyAliases": {
82 "error": "errors"
83 },
84 "additionalProperties": false
85}