summaryrefslogtreecommitdiff
path: root/ext/data/schemas/dictionary-term-bank-v3-schema.json
blob: 8243f2a7f5788e2fe8134edc6e80f7756d7ff094 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
{
    "$id": "dictionaryTermBankV3",
    "$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": "Empty tags.",
                            "required": [
                                "tag"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "const": "br"
                                },
                                "data": {
                                    "$ref": "#/definitions/structuredContentData"
                                }
                            }
                        },
                        {
                            "type": "object",
                            "description": "Generic container tags.",
                            "required": [
                                "tag"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "enum": ["ruby", "rt", "rp", "table", "thead", "tbody", "tfoot", "tr"]
                                },
                                "content": {
                                    "$ref": "#/definitions/structuredContent"
                                },
                                "data": {
                                    "$ref": "#/definitions/structuredContentData"
                                },
                                "lang": {
                                    "type": "string",
                                    "description": "Defines the language of an element in the format defined by RFC 5646."
                                }
                            }
                        },
                        {
                            "type": "object",
                            "description": "Table tags.",
                            "required": [
                                "tag"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "enum": ["td", "th"]
                                },
                                "content": {
                                    "$ref": "#/definitions/structuredContent"
                                },
                                "data": {
                                    "$ref": "#/definitions/structuredContentData"
                                },
                                "colSpan": {
                                    "type": "integer",
                                    "minimum": 1
                                },
                                "rowSpan": {
                                    "type": "integer",
                                    "minimum": 1
                                },
                                "style": {
                                    "$ref": "#/definitions/structuredContentStyle"
                                },
                                "lang": {
                                    "type": "string",
                                    "description": "Defines the language of an element in the format defined by RFC 5646."
                                }
                            }
                        },
                        {
                            "type": "object",
                            "description": "Container tags supporting configurable styles.",
                            "required": [
                                "tag"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "enum": ["span", "div", "ol", "ul", "li"]
                                },
                                "content": {
                                    "$ref": "#/definitions/structuredContent"
                                },
                                "data": {
                                    "$ref": "#/definitions/structuredContentData"
                                },
                                "style": {
                                    "$ref": "#/definitions/structuredContentStyle"
                                },
                                "title": {
                                    "type": "string",
                                    "description": "Hover text for the element."
                                },
                                "lang": {
                                    "type": "string",
                                    "description": "Defines the language of an element in the format defined by RFC 5646."
                                }
                            }
                        },
                        {
                            "type": "object",
                            "description": "Image tag.",
                            "required": [
                                "tag",
                                "path"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "const": "img"
                                },
                                "data": {
                                    "$ref": "#/definitions/structuredContentData"
                                },
                                "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."
                                },
                                "alt": {
                                    "type": "string",
                                    "description": "Alt 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": 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": "object",
                            "description": "Link tag.",
                            "required": [
                                "tag",
                                "href"
                            ],
                            "additionalProperties": false,
                            "properties": {
                                "tag": {
                                    "type": "string",
                                    "const": "a"
                                },
                                "content": {
                                    "$ref": "#/definitions/structuredContent"
                                },
                                "href": {
                                    "type": "string",
                                    "description": "The URL for the link. URLs starting with a ? are treated as internal links to other dictionary content.",
                                    "pattern": "^(?:https?:|\\?)[\\w\\W]*"
                                },
                                "lang": {
                                    "type": "string",
                                    "description": "Defines the language of an element in the format defined by RFC 5646."
                                }
                            }
                        }
                    ]
                }
            ]
        },
        "structuredContentData": {
            "type": "object",
            "description": "Generic data attributes that should be added to the element.",
            "additionalProperties": {
                "type": "string"
            }
        },
        "structuredContentStyle": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "fontStyle": {
                    "type": "string",
                    "enum": ["normal", "italic"],
                    "default": "normal"
                },
                "fontWeight": {
                    "type": "string",
                    "enum": ["normal", "bold"],
                    "default": "normal"
                },
                "fontSize": {
                    "type": "string",
                    "default": "medium"
                },
                "color": {
                    "type": "string"
                },
                "backgroundColor": {
                    "type": "string"
                },
                "textDecorationLine": {
                    "oneOf": [
                        {
                            "type": "string",
                            "enum": ["none", "underline", "overline", "line-through"],
                            "default": "none"
                        },
                        {
                            "type": "array",
                            "items": {
                                "type": "string",
                                "enum": ["underline", "overline", "line-through"],
                                "default": "none"
                            }
                        }
                    ]
                },
                "textDecorationStyle": {
                    "type": "string",
                    "enum": ["solid", "double", "dotted", "dashed", "wavy"],
                    "default": "solid"
                },
                "textDecorationColor": {
                    "type": "string"
                },
                "borderColor": {
                    "type": "string"
                },
                "borderStyle": {
                    "type": "string"
                },
                "borderRadius": {
                    "type": "string"
                },
                "borderWidth": {
                    "type": "string"
                },
                "verticalAlign": {
                    "type": "string",
                    "enum": ["baseline", "sub", "super", "text-top", "text-bottom", "middle", "top", "bottom"],
                    "default": "baseline"
                },
                "textAlign": {
                    "type": "string",
                    "enum": ["start", "end", "left", "right", "center", "justify", "justify-all", "match-parent"],
                    "default": "start"
                },
                "textShadow": {
                    "type": "string"
                },
                "margin": {
                    "type": "string"
                },
                "marginTop": {
                    "type": ["number", "string"],
                    "default": 0
                },
                "marginLeft": {
                    "type": ["number", "string"],
                    "default": 0
                },
                "marginRight": {
                    "type": ["number", "string"],
                    "default": 0
                },
                "marginBottom": {
                    "type": ["number", "string"],
                    "default": 0
                },
                "padding": {
                    "type": "string"
                },
                "paddingTop": {
                    "type": "string"
                },
                "paddingLeft": {
                    "type": "string"
                },
                "paddingRight": {
                    "type": "string"
                },
                "paddingBottom": {
                    "type": "string"
                },
                "wordBreak": {
                    "type": "string",
                    "enum": ["normal", "break-all", "keep-all"],
                    "default": "normal"
                },
                "whiteSpace": {
                    "type": "string",
                    "default": "normal"
                },
                "cursor": {
                    "type": "string",
                    "default": "auto"
                },
                "listStyleType": {
                    "type": "string",
                    "default": "disc"
                }
            }
        }
    },
    "type": "array",
    "description": "Data file containing term information.",
    "items": {
        "type": "array",
        "description": "Information about a single term.",
        "minItems": 8,
        "maxItems": 8,
        "additionalItems": false,
        "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",
                                            "const": "text"
                                        },
                                        "text": {
                                            "type": "string",
                                            "description": "Single definition for the term."
                                        }
                                    }
                                },
                                {
                                    "required": [
                                        "type",
                                        "content"
                                    ],
                                    "additionalProperties": false,
                                    "properties": {
                                        "type": {
                                            "type": "string",
                                            "const": "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",
                                            "const": "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."
                                        },
                                        "alt": {
                                            "type": "string",
                                            "description": "Alt 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."
            }
        ]
    }
}