-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy pathproperties.schema
262 lines (262 loc) · 9 KB
/
properties.schema
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
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"required": false,
"globals": {
"glossary": {
"type": "string",
"required": true,
"default": "Glossary",
"inputType": "Text",
"validators": [],
"translatable": true
},
"labelLink": {
"type": "string",
"required": false,
"default": "Terms beginning with",
"title": "Link aria label",
"inputType": "Text",
"validators": [],
"help": "Aria label for each link in the index header",
"translatable": true
},
"labelNavigation": {
"type": "string",
"required": false,
"default": "Glossary navigation",
"title": "Glossary navigation aria label",
"inputType": "Text",
"validators": [],
"help": "Aria label for the glossary index navigation area",
"translatable": true
}
},
"properties": {
"pluginLocations": {
"type": "object",
"required": true,
"properties": {
"config": {
"type": "object"
},
"course": {
"type": "object",
"properties": {
"_glossary": {
"type": "object",
"required": true,
"legend": "Glossary",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"title": "Enable Glossary",
"default": false,
"inputType": {
"type": "Boolean",
"options": [
false,
true
]
},
"validators": [],
"help": "If set to 'true', the glossary extension will be enabled"
},
"_drawerOrder": {
"type": "number",
"required": false,
"title": "Drawer order",
"inputType": "Number",
"default": 0,
"help": "The order in which this extension should appear as a drawer item",
"validators": [
"number"
]
},
"title": {
"type": "string",
"required": true,
"default": "Glossary",
"title": "Glossary title",
"inputType": "Text",
"validators": [],
"help": "The title text which will appear in the glossary",
"translatable": true
},
"description": {
"type": "string",
"required": true,
"default": "Select here to view the glossary for this course",
"title": "Glossary description",
"inputType": "Text",
"validators": [],
"help": "Some text to describe the glossary",
"translatable": true
},
"clearSearch": {
"type": "string",
"required": true,
"default": "Clear search",
"title": "Clear search text",
"inputType": "Text",
"validators": [],
"help": "Aria label for the clear search button",
"translatable": true
},
"searchItemsAlert": {
"type": "string",
"required": true,
"default": "{{filteredItems.length}} found",
"title": "Search result alert",
"inputType": "Text",
"validators": [],
"help": "Aria label for search result alert",
"translatable": true
},
"searchPlaceholder": {
"type": "string",
"required": true,
"default": "Search",
"title": "Search placeholder text",
"inputType": "Text",
"validators": [],
"help": "Placeholder text for the search box",
"translatable": true
},
"searchWithInDescriptionLabel": {
"type": "string",
"required": true,
"default": "Search within Description",
"title": "Search within description text",
"inputType": "Text",
"validators": [],
"help": "Label text for the option to search within the description",
"translatable": true
},
"itemNotFoundMessage": {
"type": "string",
"required": true,
"default": "No results found",
"title": "No results message",
"inputType": "Text",
"validators": [
"required"
],
"help": "Text which will be displayed when the search produces no results",
"translatable": true
},
"_isSearchEnabled": {
"type": "boolean",
"required": false,
"title": "Enable Search",
"default": true,
"inputType": {
"type": "Boolean",
"options": [
false,
true
]
},
"validators": [],
"help": "If set to 'true', the glossary extension will be enabled"
},
"_isIndexEnabled": {
"type": "boolean",
"required": false,
"title": "Enable Index",
"default": false,
"inputType": {
"type": "Boolean",
"options": [
false,
true
]
},
"validators": [],
"help": "If set to 'true', the Index linked to group headings will be enabled."
},
"_isGroupHeadersEnabled": {
"type": "boolean",
"required": false,
"title": "Enable Group Headers",
"default": false,
"inputType": {
"type": "Boolean",
"options": [
false,
true
]
},
"validators": [],
"help": "If set to 'true', the headers will group the terms. Whenever the Index is enabled, headers will be enabled regardless of this value."
},
"_glossaryItems": {
"type": "array",
"required": true,
"title": "Glossary items",
"minItems": 1,
"items": {
"type": "object",
"required": true,
"properties": {
"description": {
"type": "string",
"required": true,
"default": "",
"title": "Description",
"inputType": "TextArea",
"validators": [
"required"
],
"help": "Some text to explain or define the term",
"translatable": true
},
"term": {
"type": "string",
"required": true,
"default": "",
"title": "Term",
"inputType": "Text",
"validators": [
"required"
],
"help": "The glossary item/term",
"translatable": true
},
"termAriaLabel": {
"type": "string",
"required": false,
"default": "",
"title": "Term ARIA label",
"inputType": "Text",
"validators": [
"required"
],
"help": "Optional, alternative label override for glossary item/term text",
"translatable": true
}
}
}
}
}
}
}
},
"contentobject": {
"type": "object"
},
"article": {
"type": "object"
},
"block": {
"type": "object"
},
"component": {
"type": "object"
}
}
}
}
}