-
Notifications
You must be signed in to change notification settings - Fork 29
/
properties.schema
330 lines (330 loc) · 11.8 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
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
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema",
"id": "http://jsonschema.net",
"required": false,
"globals": {
"pageLevelProgress": {
"type": "string",
"required": true,
"default": "List of page sections and completion status. Select incomplete sections to jump directly to the content.",
"inputType": "Text",
"validators": [],
"translatable": true
},
"pageLevelProgressIndicatorBar": {
"type": "string",
"required": true,
"default": "Page progress. {{percentageComplete}}%. Open page sections.",
"inputType": "Text",
"validators": [],
"translatable": true
},
"pageLevelProgressMenuBar": {
"type": "string",
"required": true,
"default": "Page completion {{percentageComplete}}%",
"inputType": "Text",
"validators": [],
"translatable": true
},
"optionalContent": {
"type": "string",
"required": true,
"default": "Optional content",
"inputType": "Text",
"validators": [],
"translatable": true
},
"_navOrder": {
"type": "number",
"required": true,
"title": "Navigation bar order",
"help": "Determines the order in which the page level progress is displayed in the navigation bar. Negative numbers (e.g. -100) are left-aligned. Positive numbers (e.g. 100) are right-aligned.",
"default": 90,
"inputType": "Text",
"validators": []
},
"_navTooltip": {
"type": "object",
"title": "Page Level Progress navigation tooltip",
"properties": {
"_isEnabled": {
"type": "boolean",
"default": true,
"title": "Enable tooltip for navigation button",
"inputType": "Checkbox",
"validators": []
},
"text": {
"type": "string",
"title": "",
"default": "Page progress",
"help": "The tooltip text to display on hover over this item",
"inputType": "Text",
"validators": [],
"translatable": true
}
}
},
"_showLabel": {
"type": "boolean",
"required": true,
"default": true,
"title": "Enable navigation bar button label",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether a label is shown on the navigation bar button."
},
"navLabel": {
"type": "string",
"required": true,
"default": "Page progress",
"title": "Navigation bar button label",
"inputType": "Text",
"validators": [],
"translatable": true
},
"_drawerPosition": {
"type": "string",
"required": true,
"default": "auto",
"title": "Drawer position",
"help": "Determines the starting position of the drawer to open.",
"inputType": {
"type": "Select",
"options": [
"auto",
"left",
"right"
]
},
"validators": []
}
},
"properties": {
"pluginLocations": {
"type": "object",
"required": true,
"properties": {
"config": {
"type": "object"
},
"course": {
"type": "object",
"properties": {
"_pageLevelProgress": {
"type": "object",
"required": false,
"legend": "Page Level Progress",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": true,
"title": "Is enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the Page Level Progress extension is enabled or disabled."
},
"title": {
"type": "string",
"required": true,
"default": "",
"title": "Alternate title",
"help": "Alternate title to display for the course",
"inputType": "Text",
"validators": [],
"translatable": true
},
"_showPageCompletion": {
"type": "boolean",
"required": true,
"default": true,
"title": "Show page completion",
"inputType": "Checkbox",
"validators": [],
"help": "When enabled, the overall course progress will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled."
},
"_isCompletionIndicatorEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show course completion indicator",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows next to the course title."
},
"_isShownInNavigationBar": {
"type": "boolean",
"required": true,
"default": true,
"title": "Show progress in the navigation bar",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows in the navigation bar"
},
"_showAtCourseLevel": {
"type": "boolean",
"required": true,
"default": false,
"title": "Display all content objects and the current page components",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether to display all content objects and the current page components together, or just the current page components."
},
"_useCourseProgressInNavigationButton": {
"type": "boolean",
"required": true,
"default": false,
"title": "Use course-level progress on navigation button",
"inputType": "Checkbox",
"validators": [],
"help": "When enabled, the navigation button will show course-level progress rather than page-level progress. Defaults to disabled."
}
}
}
}
},
"contentobject": {
"type": "object",
"properties": {
"_pageLevelProgress": {
"type": "object",
"required": false,
"legend": "Page Level Progress",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": true,
"title": "Is enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the Page Level Progress extension is enabled or disabled for this page."
},
"_showPageCompletion": {
"type": "boolean",
"required": true,
"default": true,
"title": "Show page completion",
"inputType": "Checkbox",
"validators": [],
"help": "When enabled, the overall progress for this page will be calculated for all components. When disabled, only components that are set to be displayed in Page Level Progress will be included in the calculations. Defaults to enabled."
},
"_isCompletionIndicatorEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show page completion indicator",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows next to the page title."
},
"_excludeAssessments": {
"type": "boolean",
"required": false,
"default": false,
"title": "Exclude assessments.",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the progress calculations will include assessments."
}
}
}
}
},
"article": {
"type": "object",
"properties": {
"_pageLevelProgress": {
"type": "object",
"required": false,
"legend": "Page Level Progress",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Is enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the Page Level Progress extension is used on this article."
},
"_isCompletionIndicatorEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show article completion indicator",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows next to the article title."
}
}
}
}
},
"block": {
"type": "object",
"properties": {
"_pageLevelProgress": {
"type": "object",
"required": false,
"legend": "Page Level Progress",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Is enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the Page Level Progress extension is used on this block."
},
"_isCompletionIndicatorEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show block completion indicator",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows next to the block title."
}
}
}
}
},
"component": {
"type": "object",
"properties": {
"_pageLevelProgress": {
"type": "object",
"required": false,
"legend": "Page Level Progress",
"properties": {
"_isEnabled": {
"type": "boolean",
"required": true,
"default": true,
"title": "Is enabled",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether this component should be displayed in the Page Level Progress extension or not."
},
"_isCompletionIndicatorEnabled": {
"type": "boolean",
"required": true,
"default": false,
"title": "Show component completion indicator",
"inputType": "Checkbox",
"validators": [],
"help": "Controls whether the completion indicator shows next to the component title."
}
}
}
}
}
}
}
}
}