yomichan/ext/data/schemas/dictionary-term-bank-v3-schema.json
toasted-nutbread 7ae964c830
Structured content updates (#1733)
* Add support for imageRendering

* Make crisp-edges appearance on Firefox more similar to Chrome

* Refactor

* Add background option

* Move data-image-rendering attribute

* Restructure

* Organize

* Add support for appearance

* Update test dictionary

* Update tests
2021-06-06 14:47:48 -04:00

283 lines
15 KiB
JSON

{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"structuredContent": {
"oneOf": [
{
"type": "string",
"description": "Represents a text node."
},
{
"type": "array",
"items": {
"$ref": "#/definitions/structuredContent",
"description": "An array of child content."
}
},
{
"type": "object",
"oneOf": [
{
"type": "object",
"description": "Generic container tags.",
"required": [
"tag"
],
"additionalProperties": false,
"properties": {
"tag": {
"type": "string",
"enum": ["ruby", "rt", "rp"]
},
"content": {
"$ref": "#/definitions/structuredContent"
}
}
},
{
"type": "object",
"description": "Image tag.",
"required": [
"tag",
"path"
],
"additionalProperties": false,
"properties": {
"tag": {
"type": "string",
"const": "img"
},
"path": {
"type": "string",
"description": "Path to the image file in the archive."
},
"width": {
"type": "number",
"description": "Preferred width of the image.",
"minimum": 0
},
"height": {
"type": "number",
"description": "Preferred width of the image.",
"minimum": 0
},
"title": {
"type": "string",
"description": "Hover text for the image."
},
"pixelated": {
"type": "boolean",
"description": "Whether or not the image should appear pixelated at sizes larger than the image's native resolution.",
"default": false
},
"imageRendering": {
"type": "string",
"description": "Controls how the image is rendered. The value of this field supersedes the pixelated field.",
"enum": ["auto", "pixelated", "crisp-edges"],
"default": "auto"
},
"appearance": {
"type": "string",
"description": "Controls the appearance of the image. The \"monochrome\" value will mask the opaque parts of the image using the current text color.",
"enum": ["auto", "monochrome"],
"default": "auto"
},
"background": {
"type": "boolean",
"description": "Whether or not a background color is displayed behind the image.",
"default": true
},
"collapsed": {
"type": "boolean",
"description": "Whether or not the image is collapsed by default.",
"default": false
},
"collapsible": {
"type": "boolean",
"description": "Whether or not the image can be collapsed.",
"default": false
},
"verticalAlign": {
"type": "string",
"description": "The vertical alignment of the image.",
"enum": ["baseline", "sub", "super", "text-top", "text-bottom", "middle", "top", "bottom"]
},
"sizeUnits": {
"type": "string",
"description": "The units for the width and height.",
"enum": ["px", "em"]
}
}
}
]
}
]
}
},
"type": "array",
"description": "Data file containing term information.",
"additionalItems": {
"type": "array",
"description": "Information about a single term.",
"minItems": 8,
"items": [
{
"type": "string",
"description": "The text for the term."
},
{
"type": "string",
"description": "Reading of the term, or an empty string if the reading is the same as the term."
},
{
"type": ["string", "null"],
"description": "String of space-separated tags for the definition. An empty string is treated as no tags."
},
{
"type": "string",
"description": "String of space-separated rule identifiers for the definition which is used to validate delinflection. Valid rule identifiers are: v1: ichidan verb; v5: godan verb; vs: suru verb; vk: kuru verb; adj-i: i-adjective. An empty string corresponds to words which aren't inflected, such as nouns."
},
{
"type": "number",
"description": "Score used to determine popularity. Negative values are more rare and positive values are more frequent. This score is also used to sort search results."
},
{
"type": "array",
"description": "Array of definitions for the term.",
"items": {
"oneOf": [
{
"type": "string",
"description": "Single definition for the term."
},
{
"type": "object",
"description": "Single detailed definition for the term.",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"description": "The type of the data for this definition.",
"enum": ["text", "image", "structured-content"]
}
},
"oneOf": [
{
"required": [
"type",
"text"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": ["text"]
},
"text": {
"type": "string",
"description": "Single definition for the term."
}
}
},
{
"required": [
"type",
"content"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": ["structured-content"]
},
"content": {
"$ref": "#/definitions/structuredContent",
"description": "Single definition for the term using a structured content object."
}
}
},
{
"required": [
"type",
"path"
],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": ["image"]
},
"path": {
"type": "string",
"description": "Path to the image file in the archive."
},
"width": {
"type": "integer",
"description": "Preferred width of the image.",
"minimum": 1
},
"height": {
"type": "integer",
"description": "Preferred width of the image.",
"minimum": 1
},
"title": {
"type": "string",
"description": "Hover text for the image."
},
"description": {
"type": "string",
"description": "Description of the image."
},
"pixelated": {
"type": "boolean",
"description": "Whether or not the image should appear pixelated at sizes larger than the image's native resolution.",
"default": false
},
"imageRendering": {
"type": "string",
"description": "Controls how the image is rendered. The value of this field supersedes the pixelated field.",
"enum": ["auto", "pixelated", "crisp-edges"],
"default": "auto"
},
"appearance": {
"type": "string",
"description": "Controls the appearance of the image. The \"monochrome\" value will mask the opaque parts of the image using the current text color.",
"enum": ["auto", "monochrome"],
"default": "auto"
},
"background": {
"type": "boolean",
"description": "Whether or not a background color is displayed behind the image.",
"default": true
},
"collapsed": {
"type": "boolean",
"description": "Whether or not the image is collapsed by default.",
"default": false
},
"collapsible": {
"type": "boolean",
"description": "Whether or not the image can be collapsed.",
"default": true
}
}
}
]
}
]
}
},
{
"type": "integer",
"description": "Sequence number for the term. Terms with the same sequence number can be shown together when the \"resultOutputMode\" option is set to \"merge\"."
},
{
"type": "string",
"description": "String of space-separated tags for the term. An empty string is treated as no tags."
}
]
}
}