jekyll-open-sdg-plugins 1.0.0 → 1.2.0.pre.beta4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.editorconfig +16 -16
- data/.github/workflows/test-pull-requests.yml +17 -0
- data/.gitignore +6 -4
- data/Makefile +33 -0
- data/README.md +7 -7
- data/jekyll-open-sdg-plugins.gemspec +18 -17
- data/lib/jekyll-open-sdg-plugins.rb +16 -13
- data/lib/jekyll-open-sdg-plugins/create_goals.rb +72 -75
- data/lib/jekyll-open-sdg-plugins/create_indicators.rb +117 -67
- data/lib/jekyll-open-sdg-plugins/create_pages.rb +129 -99
- data/lib/jekyll-open-sdg-plugins/fetch_remote_data.rb +187 -167
- data/lib/jekyll-open-sdg-plugins/helpers.rb +132 -66
- data/lib/jekyll-open-sdg-plugins/schema-indicator-config.json +513 -0
- data/lib/jekyll-open-sdg-plugins/schema-site-config.json +1202 -0
- data/lib/jekyll-open-sdg-plugins/sdg_variables.rb +439 -417
- data/lib/jekyll-open-sdg-plugins/search_index.rb +102 -92
- data/lib/jekyll-open-sdg-plugins/site_configuration.rb +43 -0
- data/lib/jekyll-open-sdg-plugins/translate_date.rb +98 -72
- data/lib/jekyll-open-sdg-plugins/translate_key.rb +20 -20
- data/lib/jekyll-open-sdg-plugins/translate_metadata_field.rb +111 -111
- data/lib/jekyll-open-sdg-plugins/validate_indicator_config.rb +52 -0
- data/lib/jekyll-open-sdg-plugins/validate_site_config.rb +34 -0
- data/lib/jekyll-open-sdg-plugins/version.rb +3 -3
- data/tests/Gemfile +7 -0
- data/tests/_config.yml +147 -0
- metadata +28 -6
|
@@ -0,0 +1,1202 @@
|
|
|
1
|
+
{
|
|
2
|
+
"type": "object",
|
|
3
|
+
"title": "Open SDG site configuration",
|
|
4
|
+
"description": "This form will produce the site configuration for your Open SDG implementation.",
|
|
5
|
+
"properties": {
|
|
6
|
+
"accessible_charts": {
|
|
7
|
+
"title": "Accessible charts",
|
|
8
|
+
"type": "boolean",
|
|
9
|
+
"description": "This setting can be set to `true` to enable chart functionality that is intended to increase accessibility by adding support for screenreaders and keyboard navigation.",
|
|
10
|
+
"format": "checkbox",
|
|
11
|
+
"links": [
|
|
12
|
+
{
|
|
13
|
+
"rel": "More information on the accessible charts setting",
|
|
14
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#accessible_charts"
|
|
15
|
+
}
|
|
16
|
+
]
|
|
17
|
+
},
|
|
18
|
+
"accessible_tabs": {
|
|
19
|
+
"title": "Accessible tabs",
|
|
20
|
+
"type": "boolean",
|
|
21
|
+
"description": "This setting can be set to `true` to enable tab functionality that is compliant with the WAI-ARIA best practices. This adds improved keyboard navigation of the tabs.",
|
|
22
|
+
"format": "checkbox",
|
|
23
|
+
"links": [
|
|
24
|
+
{
|
|
25
|
+
"rel": "More information on the accessible tabs setting",
|
|
26
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#accessible_tabs"
|
|
27
|
+
}
|
|
28
|
+
]
|
|
29
|
+
},
|
|
30
|
+
"analytics": {
|
|
31
|
+
"options": {"collapsed": true},
|
|
32
|
+
"type": "object",
|
|
33
|
+
"title": "Analytics",
|
|
34
|
+
"description": "If these settings are used, usage statistics will be sent to Google Analytics.",
|
|
35
|
+
"properties": {
|
|
36
|
+
"ga_prod": {
|
|
37
|
+
"type": "string",
|
|
38
|
+
"title": "Google Analytics tracking ID",
|
|
39
|
+
"description": "The tracking ID (UA code) for your property on Google Analytics."
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"links": [
|
|
43
|
+
{
|
|
44
|
+
"rel": "More information on the analytics setting",
|
|
45
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#analytics"
|
|
46
|
+
}
|
|
47
|
+
]
|
|
48
|
+
},
|
|
49
|
+
"breadcrumbs": {
|
|
50
|
+
"options": {"collapsed": true},
|
|
51
|
+
"type": "object",
|
|
52
|
+
"title": "Breadcrumbs",
|
|
53
|
+
"description": "This can contain breadcrumb settings for each of the supported collection types: goal, indicator, and post. Each should have a list of label/path objects.",
|
|
54
|
+
"properties": {
|
|
55
|
+
"goal": {
|
|
56
|
+
"options": {"collapsed": true},
|
|
57
|
+
"format": "table",
|
|
58
|
+
"type": "array",
|
|
59
|
+
"title": "Goal breadcrumbs",
|
|
60
|
+
"description": "The breadcrumb items for goal pages.",
|
|
61
|
+
"items": {
|
|
62
|
+
"$ref": "#/definitions/breadcrumb_item"
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
"indicator": {
|
|
66
|
+
"options": {"collapsed": true},
|
|
67
|
+
"format": "table",
|
|
68
|
+
"type": "array",
|
|
69
|
+
"title": "Indicator breadcrumbs",
|
|
70
|
+
"description": "The breadcrumb items for indicator pages. Note that there will automatically be a final item, which is a link to the goal that the indicator belongs to. You do not need to specify this, since it is done dynamically and automatically.",
|
|
71
|
+
"items": {
|
|
72
|
+
"$ref": "#/definitions/breadcrumb_item"
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
"post": {
|
|
76
|
+
"options": {"collapsed": true},
|
|
77
|
+
"format": "table",
|
|
78
|
+
"type": "array",
|
|
79
|
+
"title": "Post breadcrumbs",
|
|
80
|
+
"description": "The breadcrumb items for post pages.",
|
|
81
|
+
"items": {
|
|
82
|
+
"$ref": "#/definitions/breadcrumb_item"
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
},
|
|
86
|
+
"links": [
|
|
87
|
+
{
|
|
88
|
+
"rel": "More information on the breadcrumbs setting",
|
|
89
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#breadcrumbs"
|
|
90
|
+
}
|
|
91
|
+
]
|
|
92
|
+
},
|
|
93
|
+
"country": {
|
|
94
|
+
"options": {"collapsed": true},
|
|
95
|
+
"type": "object",
|
|
96
|
+
"title": "Country information",
|
|
97
|
+
"description": "Information about your country (or region, locality, etc.)",
|
|
98
|
+
"properties": {
|
|
99
|
+
"name": {
|
|
100
|
+
"type": "string",
|
|
101
|
+
"title": "Name",
|
|
102
|
+
"description": "The name of your country/region/locality/etc.",
|
|
103
|
+
"minLength": 1
|
|
104
|
+
},
|
|
105
|
+
"adjective": {
|
|
106
|
+
"type": "string",
|
|
107
|
+
"title": "Adjective",
|
|
108
|
+
"description": "Adjective form of your country/region/locality/etc.",
|
|
109
|
+
"minLength": 1
|
|
110
|
+
}
|
|
111
|
+
},
|
|
112
|
+
"links": [
|
|
113
|
+
{
|
|
114
|
+
"rel": "More information on the country setting",
|
|
115
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#country"
|
|
116
|
+
}
|
|
117
|
+
]
|
|
118
|
+
},
|
|
119
|
+
"create_config_forms": {
|
|
120
|
+
"options": {"collapsed": true},
|
|
121
|
+
"type": "object",
|
|
122
|
+
"title": "Create configuration forms",
|
|
123
|
+
"description": "This setting can be used to automatically create the configuration form pages.",
|
|
124
|
+
"properties": {
|
|
125
|
+
"layout": {
|
|
126
|
+
"type": "string",
|
|
127
|
+
"title": "Layout",
|
|
128
|
+
"enum": [
|
|
129
|
+
"",
|
|
130
|
+
"config-builder"
|
|
131
|
+
],
|
|
132
|
+
"options": {
|
|
133
|
+
"enum_titles": [
|
|
134
|
+
"Do not automatically create config forms",
|
|
135
|
+
"config-builder"
|
|
136
|
+
]
|
|
137
|
+
},
|
|
138
|
+
"description": "The layout to use for the configuration form pages."
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
"links": [
|
|
142
|
+
{
|
|
143
|
+
"rel": "More information on the create config forms setting",
|
|
144
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_config_forms"
|
|
145
|
+
}
|
|
146
|
+
]
|
|
147
|
+
},
|
|
148
|
+
"create_goals": {
|
|
149
|
+
"options": {"collapsed": true},
|
|
150
|
+
"type": "object",
|
|
151
|
+
"title": "Create goals",
|
|
152
|
+
"description": "This setting can be used to automatically create the goal pages.",
|
|
153
|
+
"properties": {
|
|
154
|
+
"layout": {
|
|
155
|
+
"type": "string",
|
|
156
|
+
"title": "Layout",
|
|
157
|
+
"enum": [
|
|
158
|
+
"",
|
|
159
|
+
"goal",
|
|
160
|
+
"goal-by-target",
|
|
161
|
+
"goal-by-target-vertical"
|
|
162
|
+
],
|
|
163
|
+
"options": {
|
|
164
|
+
"enum_titles": [
|
|
165
|
+
"Do not automatically create goals",
|
|
166
|
+
"goal",
|
|
167
|
+
"goal-by-target",
|
|
168
|
+
"goal-by-target-vertical"
|
|
169
|
+
]
|
|
170
|
+
},
|
|
171
|
+
"description": "The layout to use for the goal pages."
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
"links": [
|
|
175
|
+
{
|
|
176
|
+
"rel": "More information on the create goals setting",
|
|
177
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_goals"
|
|
178
|
+
}
|
|
179
|
+
]
|
|
180
|
+
},
|
|
181
|
+
"create_indicators": {
|
|
182
|
+
"options": {"collapsed": true},
|
|
183
|
+
"type": "object",
|
|
184
|
+
"title": "Create indicators",
|
|
185
|
+
"description": "This setting can be used to automatically create the indicator pages.",
|
|
186
|
+
"properties": {
|
|
187
|
+
"layout": {
|
|
188
|
+
"type": "string",
|
|
189
|
+
"title": "Layout",
|
|
190
|
+
"enum": [
|
|
191
|
+
"",
|
|
192
|
+
"indicator"
|
|
193
|
+
],
|
|
194
|
+
"options": {
|
|
195
|
+
"enum_titles": [
|
|
196
|
+
"Do not automatically create indicators",
|
|
197
|
+
"indicator"
|
|
198
|
+
]
|
|
199
|
+
},
|
|
200
|
+
"description": "The layout to use for the indicator pages."
|
|
201
|
+
}
|
|
202
|
+
},
|
|
203
|
+
"links": [
|
|
204
|
+
{
|
|
205
|
+
"rel": "More information on the create indicators setting",
|
|
206
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_indicators"
|
|
207
|
+
}
|
|
208
|
+
]
|
|
209
|
+
},
|
|
210
|
+
"create_pages": {
|
|
211
|
+
"options": {"collapsed": true},
|
|
212
|
+
"format": "table",
|
|
213
|
+
"type": "array",
|
|
214
|
+
"title": "Create pages",
|
|
215
|
+
"description": "This setting can be used to automatically create the pages.",
|
|
216
|
+
"items": {
|
|
217
|
+
"type": "object",
|
|
218
|
+
"title": "Page",
|
|
219
|
+
"properties": {
|
|
220
|
+
"filename": {
|
|
221
|
+
"type": "string",
|
|
222
|
+
"title": "Filename",
|
|
223
|
+
"description": "The filename for the page - usually 'index.html'."
|
|
224
|
+
},
|
|
225
|
+
"folder": {
|
|
226
|
+
"type": "string",
|
|
227
|
+
"minLength": 1,
|
|
228
|
+
"title": "Folder",
|
|
229
|
+
"description": "The folder path for the page."
|
|
230
|
+
},
|
|
231
|
+
"layout": {
|
|
232
|
+
"type": "string",
|
|
233
|
+
"minLength": 1,
|
|
234
|
+
"title": "Layout",
|
|
235
|
+
"description": "The layout to use for the page."
|
|
236
|
+
},
|
|
237
|
+
"title": {
|
|
238
|
+
"type": "string",
|
|
239
|
+
"title": "Title",
|
|
240
|
+
"description": "The page title for the page."
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
},
|
|
244
|
+
"links": [
|
|
245
|
+
{
|
|
246
|
+
"rel": "More information on the create pages setting",
|
|
247
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_pages"
|
|
248
|
+
}
|
|
249
|
+
]
|
|
250
|
+
},
|
|
251
|
+
"custom_css": {
|
|
252
|
+
"options": {"collapsed": true},
|
|
253
|
+
"format": "table",
|
|
254
|
+
"type": "array",
|
|
255
|
+
"title": "Custom CSS files",
|
|
256
|
+
"description": "Deprecated: instead of using this, it is recommended to put custom CSS in a _sass/custom.scss file.",
|
|
257
|
+
"items": {
|
|
258
|
+
"type": "string",
|
|
259
|
+
"title": "Custom CSS file"
|
|
260
|
+
},
|
|
261
|
+
"links": [
|
|
262
|
+
{
|
|
263
|
+
"rel": "More information on the custom CSS setting",
|
|
264
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_css"
|
|
265
|
+
}
|
|
266
|
+
]
|
|
267
|
+
},
|
|
268
|
+
"custom_js": {
|
|
269
|
+
"options": {"collapsed": true},
|
|
270
|
+
"format": "table",
|
|
271
|
+
"type": "array",
|
|
272
|
+
"title": "Custom JavaScript files",
|
|
273
|
+
"description": "This setting can be used to load additional JavaScript files on each page.",
|
|
274
|
+
"items": {
|
|
275
|
+
"type": "string",
|
|
276
|
+
"title": "Custom JavaScript file"
|
|
277
|
+
},
|
|
278
|
+
"links": [
|
|
279
|
+
{
|
|
280
|
+
"rel": "More information on the custom JS setting",
|
|
281
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_js"
|
|
282
|
+
}
|
|
283
|
+
]
|
|
284
|
+
},
|
|
285
|
+
"data_edit_url": {
|
|
286
|
+
"type": "string",
|
|
287
|
+
"minLength": 1,
|
|
288
|
+
"title": "Data edit URL",
|
|
289
|
+
"description": "This setting controls the URL of the 'Edit Data' buttons that appear on the staging site's indicator pages.",
|
|
290
|
+
"links": [
|
|
291
|
+
{
|
|
292
|
+
"rel": "More information on the data edit URL setting",
|
|
293
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_edit_url"
|
|
294
|
+
}
|
|
295
|
+
]
|
|
296
|
+
},
|
|
297
|
+
"date_formats": {
|
|
298
|
+
"options": {"collapsed": true},
|
|
299
|
+
"format": "table",
|
|
300
|
+
"type": "array",
|
|
301
|
+
"title": "Date formats",
|
|
302
|
+
"description": "This setting can be used to control date formats for use in the site, such as in the news/category/post layouts. Any number date formats can be entered, and each must have an arbitrary type, such as `standard`. Make sure that each type has a variant for each of your languages.",
|
|
303
|
+
"items": {
|
|
304
|
+
"type": "object",
|
|
305
|
+
"title": "Date format",
|
|
306
|
+
"properties": {
|
|
307
|
+
"type": {
|
|
308
|
+
"type": "string",
|
|
309
|
+
"minLength": 1,
|
|
310
|
+
"title": "Type",
|
|
311
|
+
"description": "Use `standard` for news/post dates."
|
|
312
|
+
},
|
|
313
|
+
"language": {
|
|
314
|
+
"type": "string",
|
|
315
|
+
"minLength": 1,
|
|
316
|
+
"title": "Language",
|
|
317
|
+
"description": "Language code the format applies to."
|
|
318
|
+
},
|
|
319
|
+
"format": {
|
|
320
|
+
"type": "string",
|
|
321
|
+
"minLength": 1,
|
|
322
|
+
"title": "Format",
|
|
323
|
+
"description": "Ruby DateTime date format."
|
|
324
|
+
}
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
"links": [
|
|
328
|
+
{
|
|
329
|
+
"rel": "More information on the date formats setting",
|
|
330
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#date_formats"
|
|
331
|
+
}
|
|
332
|
+
]
|
|
333
|
+
},
|
|
334
|
+
"disclaimer": {
|
|
335
|
+
"options": {"collapsed": true},
|
|
336
|
+
"type": "object",
|
|
337
|
+
"title": "Disclaimer",
|
|
338
|
+
"description": "This setting controls the content of the disclaimer that appears at the top of each page.",
|
|
339
|
+
"properties": {
|
|
340
|
+
"phase": {
|
|
341
|
+
"type": "string",
|
|
342
|
+
"title": "Phase",
|
|
343
|
+
"description": "The development phase of your platform (alpha, beta, etc.)"
|
|
344
|
+
},
|
|
345
|
+
"message": {
|
|
346
|
+
"type": "string",
|
|
347
|
+
"title": "Message",
|
|
348
|
+
"description": "A short disclaimer message."
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
"links": [
|
|
352
|
+
{
|
|
353
|
+
"rel": "More information on the disclaimer setting",
|
|
354
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#disclaimer"
|
|
355
|
+
}
|
|
356
|
+
]
|
|
357
|
+
},
|
|
358
|
+
"email_contacts": {
|
|
359
|
+
"options": {"collapsed": true},
|
|
360
|
+
"type": "object",
|
|
361
|
+
"title": "Email addresses",
|
|
362
|
+
"description": "Email addresses to publish on your platform.",
|
|
363
|
+
"properties": {
|
|
364
|
+
"questions": {
|
|
365
|
+
"type": "string",
|
|
366
|
+
"minLength": 1,
|
|
367
|
+
"format": "email",
|
|
368
|
+
"title": "Questions",
|
|
369
|
+
"description": "Inbox for questions about your platform."
|
|
370
|
+
},
|
|
371
|
+
"suggestions": {
|
|
372
|
+
"type": "string",
|
|
373
|
+
"minLength": 1,
|
|
374
|
+
"format": "email",
|
|
375
|
+
"title": "Suggestions",
|
|
376
|
+
"description": "Inbox for suggestions for your platform."
|
|
377
|
+
},
|
|
378
|
+
"functional": {
|
|
379
|
+
"type": "string",
|
|
380
|
+
"minLength": 1,
|
|
381
|
+
"format": "email",
|
|
382
|
+
"title": "Functional",
|
|
383
|
+
"description": "Inbox for bug reports for your platform."
|
|
384
|
+
}
|
|
385
|
+
},
|
|
386
|
+
"links": [
|
|
387
|
+
{
|
|
388
|
+
"rel": "More information on the email contacts setting",
|
|
389
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#email_contacts"
|
|
390
|
+
}
|
|
391
|
+
]
|
|
392
|
+
},
|
|
393
|
+
"environment": {
|
|
394
|
+
"type": "string",
|
|
395
|
+
"minLength": 1,
|
|
396
|
+
"title": "Environment",
|
|
397
|
+
"description": "Which environment (staging or production) this configuration is for.",
|
|
398
|
+
"enum": ["staging", "production"],
|
|
399
|
+
"links": [
|
|
400
|
+
{
|
|
401
|
+
"rel": "More information on the environment setting",
|
|
402
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#environment"
|
|
403
|
+
}
|
|
404
|
+
]
|
|
405
|
+
},
|
|
406
|
+
"footer_language_toggle": {
|
|
407
|
+
"type": "string",
|
|
408
|
+
"title": "Footer language toggle",
|
|
409
|
+
"description": "This setting controls the type of language toggle to be used in the footer.",
|
|
410
|
+
"enum": ["none", "dropdown", "links"],
|
|
411
|
+
"links": [
|
|
412
|
+
{
|
|
413
|
+
"rel": "More information on the footer language toggle setting",
|
|
414
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_language_toggle"
|
|
415
|
+
}
|
|
416
|
+
]
|
|
417
|
+
},
|
|
418
|
+
"footer_menu": {
|
|
419
|
+
"options": {"collapsed": true},
|
|
420
|
+
"format": "table",
|
|
421
|
+
"type": "array",
|
|
422
|
+
"title": "Footer menu",
|
|
423
|
+
"description": "The links to display in the footer menu.",
|
|
424
|
+
"items": {
|
|
425
|
+
"$ref": "#/definitions/menu_item"
|
|
426
|
+
},
|
|
427
|
+
"links": [
|
|
428
|
+
{
|
|
429
|
+
"rel": "More information on the footer menu setting",
|
|
430
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_menu"
|
|
431
|
+
}
|
|
432
|
+
]
|
|
433
|
+
},
|
|
434
|
+
"frontpage_cards": {
|
|
435
|
+
"options": {"collapsed": true},
|
|
436
|
+
"type": "array",
|
|
437
|
+
"title": "Frontpage cards",
|
|
438
|
+
"description": "This setting is only used in the frontpage-alt layout. It can display any number of 'cards' in 3-column rows, beneath the grid of goal tiles.",
|
|
439
|
+
"items": {
|
|
440
|
+
"type": "object",
|
|
441
|
+
"title": "Frontpage card",
|
|
442
|
+
"properties": {
|
|
443
|
+
"title": {
|
|
444
|
+
"type": "string",
|
|
445
|
+
"minLength": 1,
|
|
446
|
+
"title": "Title",
|
|
447
|
+
"description": "The card's title."
|
|
448
|
+
},
|
|
449
|
+
"content": {
|
|
450
|
+
"type": "string",
|
|
451
|
+
"title": "Content",
|
|
452
|
+
"description": "The card's content.",
|
|
453
|
+
"format": "markdown"
|
|
454
|
+
},
|
|
455
|
+
"include": {
|
|
456
|
+
"type": "string",
|
|
457
|
+
"title": "Include file",
|
|
458
|
+
"description": "A Jekyll include file to place inside the card."
|
|
459
|
+
},
|
|
460
|
+
"button_label": {
|
|
461
|
+
"type": "string",
|
|
462
|
+
"title": "Button label",
|
|
463
|
+
"description": "A label for a button to display at the bottom of the card."
|
|
464
|
+
},
|
|
465
|
+
"button_link": {
|
|
466
|
+
"type": "string",
|
|
467
|
+
"title": "Button link",
|
|
468
|
+
"description": "A path or URL for the card's button to link to."
|
|
469
|
+
},
|
|
470
|
+
"rule_color": {
|
|
471
|
+
"type": "string",
|
|
472
|
+
"title": "Rule color",
|
|
473
|
+
"description": "The color of the horizontal line appearing above the card."
|
|
474
|
+
}
|
|
475
|
+
}
|
|
476
|
+
},
|
|
477
|
+
"links": [
|
|
478
|
+
{
|
|
479
|
+
"rel": "More information on the frontpage cards setting",
|
|
480
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_cards"
|
|
481
|
+
}
|
|
482
|
+
]
|
|
483
|
+
},
|
|
484
|
+
"frontpage_goals_grid": {
|
|
485
|
+
"options": {"collapsed": true},
|
|
486
|
+
"type": "object",
|
|
487
|
+
"title": "Frontpage goals grid",
|
|
488
|
+
"description": "This setting is only used in the frontpage-alt layout. It can display a title and description above the grid of goal tiles.",
|
|
489
|
+
"$ref": "#/definitions/title_and_description",
|
|
490
|
+
"links": [
|
|
491
|
+
{
|
|
492
|
+
"rel": "More information on the frontpage goals grid setting",
|
|
493
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_goals_grid"
|
|
494
|
+
}
|
|
495
|
+
]
|
|
496
|
+
},
|
|
497
|
+
"frontpage_heading": {
|
|
498
|
+
"type": "string",
|
|
499
|
+
"title": "Frontpage heading",
|
|
500
|
+
"description": "This setting can control the heading that appears on the front page. This setting is only used in the frontpage layout.",
|
|
501
|
+
"links": [
|
|
502
|
+
{
|
|
503
|
+
"rel": "More information on the frontpage heading setting",
|
|
504
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_heading"
|
|
505
|
+
}
|
|
506
|
+
]
|
|
507
|
+
},
|
|
508
|
+
"frontpage_instructions": {
|
|
509
|
+
"type": "string",
|
|
510
|
+
"title": "Frontpage instructions",
|
|
511
|
+
"description": "This setting can control the instructions that appear on the front page. This setting is only used in the frontpage layout.",
|
|
512
|
+
"links": [
|
|
513
|
+
{
|
|
514
|
+
"rel": "More information on the frontpage instructions setting",
|
|
515
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_instructions"
|
|
516
|
+
}
|
|
517
|
+
]
|
|
518
|
+
},
|
|
519
|
+
"frontpage_introduction_banner": {
|
|
520
|
+
"options": {"collapsed": true},
|
|
521
|
+
"type": "object",
|
|
522
|
+
"title": "Frontpage introduction banner",
|
|
523
|
+
"description": "This setting is only used in the frontpage-alt layout. It can display a title and description in a banner at the top of the frontpage.",
|
|
524
|
+
"$ref": "#/definitions/title_and_description",
|
|
525
|
+
"links": [
|
|
526
|
+
{
|
|
527
|
+
"rel": "More information on the frontpage introduction banner setting",
|
|
528
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_introduction_banner"
|
|
529
|
+
}
|
|
530
|
+
]
|
|
531
|
+
},
|
|
532
|
+
"goal_image_base": {
|
|
533
|
+
"type": "string",
|
|
534
|
+
"minLength": 1,
|
|
535
|
+
"title": "Goal image base URL",
|
|
536
|
+
"description": "This setting controls the base URL for downloading the imagery for the goals.",
|
|
537
|
+
"links": [
|
|
538
|
+
{
|
|
539
|
+
"rel": "More information on the goal image base setting",
|
|
540
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_base"
|
|
541
|
+
}
|
|
542
|
+
]
|
|
543
|
+
},
|
|
544
|
+
"goal_image_extension": {
|
|
545
|
+
"type": "string",
|
|
546
|
+
"title": "Goal image extension",
|
|
547
|
+
"description": "This setting controls the type of file (the file extension) that will be used for the goal images.",
|
|
548
|
+
"links": [
|
|
549
|
+
{
|
|
550
|
+
"rel": "More information on the goal image extension setting",
|
|
551
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_extension"
|
|
552
|
+
}
|
|
553
|
+
]
|
|
554
|
+
},
|
|
555
|
+
"goals_page": {
|
|
556
|
+
"options": {"collapsed": true},
|
|
557
|
+
"type": "object",
|
|
558
|
+
"title": "Goals page",
|
|
559
|
+
"description": "This setting is used in the 'goals' layout. It can display a title and description above the grid of goal tiles.",
|
|
560
|
+
"$ref": "#/definitions/title_and_description",
|
|
561
|
+
"links": [
|
|
562
|
+
{
|
|
563
|
+
"rel": "More information on the goals page setting",
|
|
564
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goals_page"
|
|
565
|
+
}
|
|
566
|
+
]
|
|
567
|
+
},
|
|
568
|
+
"graph_color_set": {
|
|
569
|
+
"type": "string",
|
|
570
|
+
"title": "Graph color set",
|
|
571
|
+
"description": "This setting can be used to customize the color set used in the charts.",
|
|
572
|
+
"examples": [],
|
|
573
|
+
"enum": ["default", "sdg", "goal", "custom"],
|
|
574
|
+
"links": [
|
|
575
|
+
{
|
|
576
|
+
"rel": "More information on the graph color set setting",
|
|
577
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_set"
|
|
578
|
+
}
|
|
579
|
+
]
|
|
580
|
+
},
|
|
581
|
+
"graph_color_list": {
|
|
582
|
+
"options": {"collapsed": true},
|
|
583
|
+
"format": "table",
|
|
584
|
+
"type": "array",
|
|
585
|
+
"title": "Graph color list",
|
|
586
|
+
"description": "This setting can be used to define a set of colors to be used in the charts. This is only used when graph_color_set is 'custom'.",
|
|
587
|
+
"items": {
|
|
588
|
+
"type": "string",
|
|
589
|
+
"format": "color",
|
|
590
|
+
"title": "Color",
|
|
591
|
+
"description": "Hexadecimal color code"
|
|
592
|
+
},
|
|
593
|
+
"links": [
|
|
594
|
+
{
|
|
595
|
+
"rel": "More information on the graph color list setting",
|
|
596
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_list"
|
|
597
|
+
}
|
|
598
|
+
]
|
|
599
|
+
},
|
|
600
|
+
"graph_color_number": {
|
|
601
|
+
"title": "Graph color number",
|
|
602
|
+
"type": "integer",
|
|
603
|
+
"description": "This setting can be used to limit the length of the list of colors selected via graph_color_set.",
|
|
604
|
+
"links": [
|
|
605
|
+
{
|
|
606
|
+
"rel": "More information on the graph color number setting",
|
|
607
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_number"
|
|
608
|
+
}
|
|
609
|
+
]
|
|
610
|
+
},
|
|
611
|
+
"header_language_toggle": {
|
|
612
|
+
"type": "string",
|
|
613
|
+
"title": "Header language toggle",
|
|
614
|
+
"description": "This setting controls the type of language toggle to be used in the header.",
|
|
615
|
+
"enum": ["none", "dropdown", "links"],
|
|
616
|
+
"links": [
|
|
617
|
+
{
|
|
618
|
+
"rel": "More information on the header language toggle setting",
|
|
619
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header_language_toggle"
|
|
620
|
+
}
|
|
621
|
+
]
|
|
622
|
+
},
|
|
623
|
+
"hide_empty_metadata": {
|
|
624
|
+
"title": "Hide empty metadata",
|
|
625
|
+
"type": "boolean",
|
|
626
|
+
"description": "This setting can be used to hide any metadata fields that are empty.",
|
|
627
|
+
"format": "checkbox",
|
|
628
|
+
"links": [
|
|
629
|
+
{
|
|
630
|
+
"rel": "More information on the hide empty metadata setting",
|
|
631
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_empty_metadata"
|
|
632
|
+
}
|
|
633
|
+
]
|
|
634
|
+
},
|
|
635
|
+
"indicator_config_form": {
|
|
636
|
+
"options": {"collapsed": true},
|
|
637
|
+
"type": "object",
|
|
638
|
+
"title": "Indicator configuration form",
|
|
639
|
+
"description": "Configuration of the indicator configuration form.",
|
|
640
|
+
"$ref": "#/definitions/config_form_options"
|
|
641
|
+
},
|
|
642
|
+
"languages": {
|
|
643
|
+
"options": {"collapsed": true},
|
|
644
|
+
"format": "table",
|
|
645
|
+
"type": "array",
|
|
646
|
+
"minItems": 1,
|
|
647
|
+
"title": "Languages",
|
|
648
|
+
"description": "This setting controls the languages to be used on the site.",
|
|
649
|
+
"items": {
|
|
650
|
+
"type": "string",
|
|
651
|
+
"minLength": 1,
|
|
652
|
+
"title": "Language"
|
|
653
|
+
},
|
|
654
|
+
"links": [
|
|
655
|
+
{
|
|
656
|
+
"rel": "More information on the languages setting",
|
|
657
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages"
|
|
658
|
+
}
|
|
659
|
+
]
|
|
660
|
+
},
|
|
661
|
+
"languages_public": {
|
|
662
|
+
"options": {"collapsed": true},
|
|
663
|
+
"format": "table",
|
|
664
|
+
"type": "array",
|
|
665
|
+
"title": "Language code overrides",
|
|
666
|
+
"description": "This setting can be used if you are not happy with any of the standard language codes.",
|
|
667
|
+
"items": {
|
|
668
|
+
"type": "object",
|
|
669
|
+
"title": "Language override",
|
|
670
|
+
"properties": {
|
|
671
|
+
"language": {
|
|
672
|
+
"type": "string",
|
|
673
|
+
"minLength": 1,
|
|
674
|
+
"title": "Language",
|
|
675
|
+
"description": "The (standard) language code that you would like to override."
|
|
676
|
+
},
|
|
677
|
+
"language_public": {
|
|
678
|
+
"type": "string",
|
|
679
|
+
"minLength": 1,
|
|
680
|
+
"title": "Language override",
|
|
681
|
+
"description": "The (non-standard) language code that you would like show the public instead."
|
|
682
|
+
}
|
|
683
|
+
}
|
|
684
|
+
},
|
|
685
|
+
"links": [
|
|
686
|
+
{
|
|
687
|
+
"rel": "More information on the language override setting",
|
|
688
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages_public"
|
|
689
|
+
}
|
|
690
|
+
]
|
|
691
|
+
},
|
|
692
|
+
"map_layers": {
|
|
693
|
+
"options": {"collapsed": true},
|
|
694
|
+
"format": "table",
|
|
695
|
+
"type": "array",
|
|
696
|
+
"title": "Map layers",
|
|
697
|
+
"description": "Configure any number of layers to display on all indicator maps. A minimum of one layer is required to display maps.",
|
|
698
|
+
"items": {
|
|
699
|
+
"type": "object",
|
|
700
|
+
"title": "Map layer",
|
|
701
|
+
"properties": {
|
|
702
|
+
"subfolder": {
|
|
703
|
+
"type": "string",
|
|
704
|
+
"title": "Subfolder",
|
|
705
|
+
"description": "The subfolder under 'geojson' in the data repository holding the GeoJSON file for this layer."
|
|
706
|
+
},
|
|
707
|
+
"label": {
|
|
708
|
+
"type": "string",
|
|
709
|
+
"title": "Download button label",
|
|
710
|
+
"description": "The label to use in the 'Download GeoJSON' button for this layer."
|
|
711
|
+
},
|
|
712
|
+
"min_zoom": {
|
|
713
|
+
"type": "integer",
|
|
714
|
+
"title": "Minimum zoom",
|
|
715
|
+
"description": "This layer will only be visible when the map is zoomed to at least this number."
|
|
716
|
+
},
|
|
717
|
+
"max_zoom": {
|
|
718
|
+
"type": "integer",
|
|
719
|
+
"title": "Maximum zoom",
|
|
720
|
+
"description": "The layer will not be visible when the map is zoomed beyond this number."
|
|
721
|
+
},
|
|
722
|
+
"staticBorders": {
|
|
723
|
+
"type": "boolean",
|
|
724
|
+
"format": "checkbox",
|
|
725
|
+
"title": "Static borders",
|
|
726
|
+
"description": "Whether the borders on this layer should remain visible when the map is zoomed past the maximum."
|
|
727
|
+
}
|
|
728
|
+
}
|
|
729
|
+
},
|
|
730
|
+
"links": [
|
|
731
|
+
{
|
|
732
|
+
"rel": "More information on the map layers setting",
|
|
733
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_layers"
|
|
734
|
+
}
|
|
735
|
+
]
|
|
736
|
+
},
|
|
737
|
+
"map_options": {
|
|
738
|
+
"options": {"collapsed": true},
|
|
739
|
+
"type": "object",
|
|
740
|
+
"title": "Map options",
|
|
741
|
+
"description": "Site-wide configuration of map behavior and style.",
|
|
742
|
+
"default": {
|
|
743
|
+
"minZoom": 5,
|
|
744
|
+
"maxZoom": 10,
|
|
745
|
+
"colorRange": "chroma.brewer.BuGn",
|
|
746
|
+
"noValueColor": "#f0f0f0",
|
|
747
|
+
"styleNormal": {
|
|
748
|
+
"weight": 1,
|
|
749
|
+
"opacity": 1,
|
|
750
|
+
"fillOpacity": 0.7,
|
|
751
|
+
"color": "#888888"
|
|
752
|
+
},
|
|
753
|
+
"styleHighlighted": {
|
|
754
|
+
"weight": 1,
|
|
755
|
+
"opacity": 1,
|
|
756
|
+
"fillOpacity": 0.7,
|
|
757
|
+
"color": "#111111"
|
|
758
|
+
},
|
|
759
|
+
"styleStatic": {
|
|
760
|
+
"weight": 2,
|
|
761
|
+
"opacity": 1,
|
|
762
|
+
"fillOpacity": 0,
|
|
763
|
+
"color": "#172d44",
|
|
764
|
+
"dashArray": "5,5"
|
|
765
|
+
}
|
|
766
|
+
},
|
|
767
|
+
"properties": {
|
|
768
|
+
"minZoom": {
|
|
769
|
+
"title": "Minimum zoom",
|
|
770
|
+
"type": "integer",
|
|
771
|
+
"description": "The lowest amount of 'zoom' possible for users."
|
|
772
|
+
},
|
|
773
|
+
"maxZoom": {
|
|
774
|
+
"title": "Maximum zoom",
|
|
775
|
+
"type": "integer",
|
|
776
|
+
"description": "The highest amount of 'zoom' possible for users."
|
|
777
|
+
},
|
|
778
|
+
"tileURL": {
|
|
779
|
+
"title": "Tile URL",
|
|
780
|
+
"type": "string",
|
|
781
|
+
"format": "url",
|
|
782
|
+
"description": "If you would like the maps to show tile imagery, add the URL here."
|
|
783
|
+
},
|
|
784
|
+
"tileOptions": {
|
|
785
|
+
"title": "Tile options",
|
|
786
|
+
"type": "object",
|
|
787
|
+
"options": {"collapsed": true},
|
|
788
|
+
"description": "Additional options for map tile imagery.",
|
|
789
|
+
"properties": {
|
|
790
|
+
"id": {
|
|
791
|
+
"type": "string",
|
|
792
|
+
"title": "Tile ID"
|
|
793
|
+
},
|
|
794
|
+
"accessToken": {
|
|
795
|
+
"type": "string",
|
|
796
|
+
"title": "Access token"
|
|
797
|
+
},
|
|
798
|
+
"attribution": {
|
|
799
|
+
"type": "string",
|
|
800
|
+
"title": "Attribution"
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
},
|
|
804
|
+
"colorRange": {
|
|
805
|
+
"type": "string",
|
|
806
|
+
"title": "Color range",
|
|
807
|
+
"description": "The color range for the choropleth map.",
|
|
808
|
+
"links": [
|
|
809
|
+
{
|
|
810
|
+
"ref": "More information on the color range setting",
|
|
811
|
+
"href": "https://gka.github.io/chroma.js/#chroma-brewer"
|
|
812
|
+
}
|
|
813
|
+
]
|
|
814
|
+
},
|
|
815
|
+
"noValueColor": {
|
|
816
|
+
"type": "string",
|
|
817
|
+
"format": "color",
|
|
818
|
+
"title": "No-value color",
|
|
819
|
+
"description": "Color for boundaries that have no data."
|
|
820
|
+
},
|
|
821
|
+
"styleNormal": {
|
|
822
|
+
"type": "object",
|
|
823
|
+
"format": "table",
|
|
824
|
+
"title": "Style (normal)",
|
|
825
|
+
"description": "Style for boundaries in normal state",
|
|
826
|
+
"$ref": "#/definitions/map_style"
|
|
827
|
+
},
|
|
828
|
+
"styleHighlighted": {
|
|
829
|
+
"type": "object",
|
|
830
|
+
"format": "table",
|
|
831
|
+
"title": "Style (highlighted)",
|
|
832
|
+
"description": "Style for boundaries in highlighted state",
|
|
833
|
+
"$ref": "#/definitions/map_style"
|
|
834
|
+
},
|
|
835
|
+
"styleStatic": {
|
|
836
|
+
"type": "object",
|
|
837
|
+
"format": "table",
|
|
838
|
+
"title": "Style (static)",
|
|
839
|
+
"description": "Style for boundaries in static state (map layers using the 'static boundaries' option).",
|
|
840
|
+
"$ref": "#/definitions/map_style"
|
|
841
|
+
}
|
|
842
|
+
},
|
|
843
|
+
"links": [
|
|
844
|
+
{
|
|
845
|
+
"rel": "More information on the map options setting",
|
|
846
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_options"
|
|
847
|
+
}
|
|
848
|
+
]
|
|
849
|
+
},
|
|
850
|
+
"menu": {
|
|
851
|
+
"options": {"collapsed": true},
|
|
852
|
+
"format": "table",
|
|
853
|
+
"type": "array",
|
|
854
|
+
"minItems": 1,
|
|
855
|
+
"title": "Main menu",
|
|
856
|
+
"description": "The links to display in the main menu.",
|
|
857
|
+
"items": {
|
|
858
|
+
"$ref": "#/definitions/menu_item"
|
|
859
|
+
},
|
|
860
|
+
"links": [
|
|
861
|
+
{
|
|
862
|
+
"rel": "More information on the menu setting",
|
|
863
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#menu"
|
|
864
|
+
}
|
|
865
|
+
]
|
|
866
|
+
},
|
|
867
|
+
"metadata_edit_url": {
|
|
868
|
+
"type": "string",
|
|
869
|
+
"minLength": 1,
|
|
870
|
+
"title": "Metadata edit URL",
|
|
871
|
+
"description": "This setting controls the URL of the 'Edit Metadata' buttons that appear on the staging site's indicator pages.",
|
|
872
|
+
"links": [
|
|
873
|
+
{
|
|
874
|
+
"rel": "More information on the metadata edit URL setting",
|
|
875
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_edit_url"
|
|
876
|
+
}
|
|
877
|
+
]
|
|
878
|
+
},
|
|
879
|
+
"metadata_tabs": {
|
|
880
|
+
"options": {"collapsed": true},
|
|
881
|
+
"format": "table",
|
|
882
|
+
"type": "array",
|
|
883
|
+
"title": "Metadata tabs",
|
|
884
|
+
"description": "This setting can control the metadata tabs which appear on the indicator pages.",
|
|
885
|
+
"items": {
|
|
886
|
+
"type": "object",
|
|
887
|
+
"title": "Metadata tab",
|
|
888
|
+
"properties": {
|
|
889
|
+
"scope": {
|
|
890
|
+
"type": "string",
|
|
891
|
+
"minLength": 1,
|
|
892
|
+
"title": "Scope",
|
|
893
|
+
"description": "This tab will contain fields in the specific `scope` in your data repository's metadata schema file (eg, `_prose.yml`)."
|
|
894
|
+
},
|
|
895
|
+
"title": {
|
|
896
|
+
"type": "string",
|
|
897
|
+
"minLength": 1,
|
|
898
|
+
"title": "Title",
|
|
899
|
+
"description": "The title of the metadata tab."
|
|
900
|
+
},
|
|
901
|
+
"description": {
|
|
902
|
+
"type": "string",
|
|
903
|
+
"title": "Description",
|
|
904
|
+
"description": "A descriptive blurb to show at the top of the tab content.",
|
|
905
|
+
"format": "markdown"
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
"links": [
|
|
910
|
+
{
|
|
911
|
+
"rel": "More information on the metadata tabs setting",
|
|
912
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_tabs"
|
|
913
|
+
}
|
|
914
|
+
]
|
|
915
|
+
},
|
|
916
|
+
"news": {
|
|
917
|
+
"options": {"collapsed": true},
|
|
918
|
+
"type": "object",
|
|
919
|
+
"title": "News",
|
|
920
|
+
"description": "Configuration related to news updates and posts.",
|
|
921
|
+
"properties": {
|
|
922
|
+
"category_links": {
|
|
923
|
+
"title": "Category links",
|
|
924
|
+
"type": "boolean",
|
|
925
|
+
"description": "Whether you would like the 'categories' of posts to generate links to dedicated category pages.",
|
|
926
|
+
"format": "checkbox"
|
|
927
|
+
}
|
|
928
|
+
},
|
|
929
|
+
"links": [
|
|
930
|
+
{
|
|
931
|
+
"rel": "More information on the news setting",
|
|
932
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#news"
|
|
933
|
+
}
|
|
934
|
+
]
|
|
935
|
+
},
|
|
936
|
+
"non_global_metadata": {
|
|
937
|
+
"type": "string",
|
|
938
|
+
"title": "Non-global metadata",
|
|
939
|
+
"description": "This setting can be used to control the text of the tab containing non-global metadata.",
|
|
940
|
+
"links": [
|
|
941
|
+
{
|
|
942
|
+
"rel": "More information on the non-global metadata setting",
|
|
943
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#non_global_metadata"
|
|
944
|
+
}
|
|
945
|
+
]
|
|
946
|
+
},
|
|
947
|
+
"remote_data_prefix": {
|
|
948
|
+
"type": "string",
|
|
949
|
+
"minLength": 1,
|
|
950
|
+
"title": "Remote data repository URL",
|
|
951
|
+
"description": "Specify the URL of your published data repository.",
|
|
952
|
+
"links": [
|
|
953
|
+
{
|
|
954
|
+
"rel": "More information on the remote data prefix setting",
|
|
955
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#remote_data_prefix"
|
|
956
|
+
}
|
|
957
|
+
]
|
|
958
|
+
},
|
|
959
|
+
"reporting_status": {
|
|
960
|
+
"options": {"collapsed": true},
|
|
961
|
+
"type": "object",
|
|
962
|
+
"title": "Reporting status",
|
|
963
|
+
"description": "This setting is used in the 'reportingstatus' layout. It can display a title and description above the reporting status page.",
|
|
964
|
+
"$ref": "#/definitions/title_and_description",
|
|
965
|
+
"links": [
|
|
966
|
+
{
|
|
967
|
+
"rel": "More information on the reporting status setting",
|
|
968
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#reporting_status"
|
|
969
|
+
}
|
|
970
|
+
]
|
|
971
|
+
},
|
|
972
|
+
"search_index_boost": {
|
|
973
|
+
"options": {"collapsed": true},
|
|
974
|
+
"format": "table",
|
|
975
|
+
"type": "array",
|
|
976
|
+
"title": "Search index boost",
|
|
977
|
+
"description": "This setting can be used to give a boost to one or more fields in the search index.",
|
|
978
|
+
"items": {
|
|
979
|
+
"type": "object",
|
|
980
|
+
"title": "Boost",
|
|
981
|
+
"properties": {
|
|
982
|
+
"field": {
|
|
983
|
+
"type": "string",
|
|
984
|
+
"minLength": 1,
|
|
985
|
+
"title": "Field",
|
|
986
|
+
"description": "Field to boost ('title', 'content', etc.)"
|
|
987
|
+
},
|
|
988
|
+
"boost": {
|
|
989
|
+
"type": "integer",
|
|
990
|
+
"minLength": 1,
|
|
991
|
+
"title": "Boost",
|
|
992
|
+
"description": "Higher boost means higher search ranking."
|
|
993
|
+
}
|
|
994
|
+
}
|
|
995
|
+
},
|
|
996
|
+
"links": [
|
|
997
|
+
{
|
|
998
|
+
"rel": "More information on the search index boost setting",
|
|
999
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_boost"
|
|
1000
|
+
}
|
|
1001
|
+
]
|
|
1002
|
+
},
|
|
1003
|
+
"search_index_extra_fields": {
|
|
1004
|
+
"options": {"collapsed": true},
|
|
1005
|
+
"format": "table",
|
|
1006
|
+
"type": "array",
|
|
1007
|
+
"title": "Search index extra fields",
|
|
1008
|
+
"description": "This setting can be used to index additional metadata fields in your indicators, for the purposes of affecting the site-wide search.",
|
|
1009
|
+
"items": {
|
|
1010
|
+
"type": "string",
|
|
1011
|
+
"title": "Extra field"
|
|
1012
|
+
},
|
|
1013
|
+
"links": [
|
|
1014
|
+
{
|
|
1015
|
+
"rel": "More information on the search index extra fields setting",
|
|
1016
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_extra_fields"
|
|
1017
|
+
}
|
|
1018
|
+
]
|
|
1019
|
+
},
|
|
1020
|
+
"series_toggle": {
|
|
1021
|
+
"title": "Series toggle",
|
|
1022
|
+
"type": "boolean",
|
|
1023
|
+
"description": "This setting enables the special treatment of the 'Series' column in the data. If set to true, when an indicator's data includes a 'Series' column, it will be displayed above 'Units' as radio buttons.",
|
|
1024
|
+
"format": "checkbox",
|
|
1025
|
+
"links": [
|
|
1026
|
+
{
|
|
1027
|
+
"rel": "More information on the series toggle setting",
|
|
1028
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#series_toggle"
|
|
1029
|
+
}
|
|
1030
|
+
]
|
|
1031
|
+
},
|
|
1032
|
+
"sharethis_property": {
|
|
1033
|
+
"type": "string",
|
|
1034
|
+
"title": "ShareThis property",
|
|
1035
|
+
"description": "This setting creates a ShareThis widget along the left side of every page. It should be the property id for your ShareThis account.",
|
|
1036
|
+
"links": [
|
|
1037
|
+
{
|
|
1038
|
+
"rel": "More information on the sharethis setting",
|
|
1039
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#sharethis_property"
|
|
1040
|
+
}
|
|
1041
|
+
]
|
|
1042
|
+
},
|
|
1043
|
+
"site_config_form": {
|
|
1044
|
+
"options": {"collapsed": true},
|
|
1045
|
+
"type": "object",
|
|
1046
|
+
"title": "Site configuration form",
|
|
1047
|
+
"description": "Configuration of the site configuration form.",
|
|
1048
|
+
"$ref": "#/definitions/config_form_options"
|
|
1049
|
+
},
|
|
1050
|
+
"validate_indicator_config": {
|
|
1051
|
+
"title": "Validate indicator config",
|
|
1052
|
+
"type": "boolean",
|
|
1053
|
+
"description": "If checked, this will require that all indicators have valid Open SDG indicator configuration.",
|
|
1054
|
+
"format": "checkbox",
|
|
1055
|
+
"links": [
|
|
1056
|
+
{
|
|
1057
|
+
"rel": "More information on the validate indicator config setting",
|
|
1058
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_indicator_config"
|
|
1059
|
+
}
|
|
1060
|
+
]
|
|
1061
|
+
},
|
|
1062
|
+
"validate_site_config": {
|
|
1063
|
+
"title": "Validate site config",
|
|
1064
|
+
"type": "boolean",
|
|
1065
|
+
"description": "If checked, this will require valid site configuration.",
|
|
1066
|
+
"format": "checkbox",
|
|
1067
|
+
"links": [
|
|
1068
|
+
{
|
|
1069
|
+
"rel": "More information on the validate site config setting",
|
|
1070
|
+
"href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_site_config"
|
|
1071
|
+
}
|
|
1072
|
+
]
|
|
1073
|
+
}
|
|
1074
|
+
},
|
|
1075
|
+
"additionalProperties": true,
|
|
1076
|
+
"definitions": {
|
|
1077
|
+
"menu_item": {
|
|
1078
|
+
"type": "object",
|
|
1079
|
+
"title": "Menu item",
|
|
1080
|
+
"properties": {
|
|
1081
|
+
"path": {
|
|
1082
|
+
"type": "string",
|
|
1083
|
+
"minLength": 1,
|
|
1084
|
+
"title": "Path",
|
|
1085
|
+
"description": "Path or URL that the menu item should link to."
|
|
1086
|
+
},
|
|
1087
|
+
"translation_key": {
|
|
1088
|
+
"type": "string",
|
|
1089
|
+
"minLength": 1,
|
|
1090
|
+
"title": "Label",
|
|
1091
|
+
"description": "Label (or translation key) for the link."
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"breadcrumb_item": {
|
|
1096
|
+
"type": "object",
|
|
1097
|
+
"title": "Breadcrumb item",
|
|
1098
|
+
"properties": {
|
|
1099
|
+
"path": {
|
|
1100
|
+
"type": "string",
|
|
1101
|
+
"minLength": 1,
|
|
1102
|
+
"title": "Path",
|
|
1103
|
+
"description": "Path or URL that the breadcrumb item should link to."
|
|
1104
|
+
},
|
|
1105
|
+
"label": {
|
|
1106
|
+
"type": "string",
|
|
1107
|
+
"minLength": 1,
|
|
1108
|
+
"title": "Label",
|
|
1109
|
+
"description": "Label (or translation key) for the breadcrumb item."
|
|
1110
|
+
}
|
|
1111
|
+
}
|
|
1112
|
+
},
|
|
1113
|
+
"title_and_description": {
|
|
1114
|
+
"type": "object",
|
|
1115
|
+
"properties": {
|
|
1116
|
+
"title": {
|
|
1117
|
+
"type": "string",
|
|
1118
|
+
"minLength": 1,
|
|
1119
|
+
"title": "Title"
|
|
1120
|
+
},
|
|
1121
|
+
"description": {
|
|
1122
|
+
"type": "string",
|
|
1123
|
+
"minLength": 1,
|
|
1124
|
+
"title": "Description",
|
|
1125
|
+
"format": "markdown"
|
|
1126
|
+
}
|
|
1127
|
+
}
|
|
1128
|
+
},
|
|
1129
|
+
"map_style": {
|
|
1130
|
+
"properties": {
|
|
1131
|
+
"weight": {
|
|
1132
|
+
"type": "number",
|
|
1133
|
+
"title": "Weight",
|
|
1134
|
+
"description": "The weight (boldness) of boundary borders."
|
|
1135
|
+
},
|
|
1136
|
+
"opacity": {
|
|
1137
|
+
"type": "number",
|
|
1138
|
+
"title": "Opacity",
|
|
1139
|
+
"description": "The opacity of the boundary borders (between 0 and 1)."
|
|
1140
|
+
},
|
|
1141
|
+
"fillOpacity": {
|
|
1142
|
+
"type": "number",
|
|
1143
|
+
"title": "Fill opacity",
|
|
1144
|
+
"description": "The opacity of the boundaries' background color (between 0 and 1)."
|
|
1145
|
+
},
|
|
1146
|
+
"color": {
|
|
1147
|
+
"type": "string",
|
|
1148
|
+
"format": "color",
|
|
1149
|
+
"title": "Color",
|
|
1150
|
+
"description": "The color of the boundary borders."
|
|
1151
|
+
},
|
|
1152
|
+
"dashArray": {
|
|
1153
|
+
"type": "string",
|
|
1154
|
+
"title": "Dash array",
|
|
1155
|
+
"description": "A 'dash array' describing the boundary as dashed lines."
|
|
1156
|
+
}
|
|
1157
|
+
}
|
|
1158
|
+
},
|
|
1159
|
+
"config_form_options": {
|
|
1160
|
+
"type": "object",
|
|
1161
|
+
"properties": {
|
|
1162
|
+
"dropdowns": {
|
|
1163
|
+
"type": "array",
|
|
1164
|
+
"title": "Dropdown lists",
|
|
1165
|
+
"description": "Set options for any dropdown lists.",
|
|
1166
|
+
"items": {
|
|
1167
|
+
"type": "object",
|
|
1168
|
+
"format": "table",
|
|
1169
|
+
"title": "Dropdown list",
|
|
1170
|
+
"properties": {
|
|
1171
|
+
"jsonschema": {
|
|
1172
|
+
"type": "string",
|
|
1173
|
+
"title": "JSONSchema path",
|
|
1174
|
+
"description": "The jsonschema path to the dropdown field."
|
|
1175
|
+
},
|
|
1176
|
+
"values": {
|
|
1177
|
+
"type": "array",
|
|
1178
|
+
"format": "table",
|
|
1179
|
+
"title": "Values",
|
|
1180
|
+
"description": "List of dropdown option values",
|
|
1181
|
+
"items": {
|
|
1182
|
+
"type": "string",
|
|
1183
|
+
"title": "Value"
|
|
1184
|
+
}
|
|
1185
|
+
},
|
|
1186
|
+
"labels": {
|
|
1187
|
+
"type": "array",
|
|
1188
|
+
"format": "table",
|
|
1189
|
+
"title": "Labels",
|
|
1190
|
+
"description": "Optional list of dropdown option labels. Should correspond to the values above.",
|
|
1191
|
+
"items": {
|
|
1192
|
+
"type": "string",
|
|
1193
|
+
"title": "Label"
|
|
1194
|
+
}
|
|
1195
|
+
}
|
|
1196
|
+
}
|
|
1197
|
+
}
|
|
1198
|
+
}
|
|
1199
|
+
}
|
|
1200
|
+
}
|
|
1201
|
+
}
|
|
1202
|
+
}
|