jekyll-open-sdg-plugins 1.6.1 → 1.8.0.pre.beta1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (30) hide show
  1. checksums.yaml +4 -4
  2. data/.editorconfig +16 -16
  3. data/.github/workflows/test-pull-requests.yml +17 -17
  4. data/.gitignore +6 -6
  5. data/LICENSE +21 -21
  6. data/Makefile +33 -33
  7. data/README.md +7 -7
  8. data/jekyll-open-sdg-plugins.gemspec +18 -18
  9. data/lib/jekyll-open-sdg-plugins/backwards_compatibility.rb +97 -64
  10. data/lib/jekyll-open-sdg-plugins/create_goals.rb +88 -85
  11. data/lib/jekyll-open-sdg-plugins/create_indicators.rb +209 -206
  12. data/lib/jekyll-open-sdg-plugins/create_pages.rb +150 -135
  13. data/lib/jekyll-open-sdg-plugins/fetch_remote_data.rb +188 -188
  14. data/lib/jekyll-open-sdg-plugins/helpers.rb +132 -132
  15. data/lib/jekyll-open-sdg-plugins/metadata_schema_to_config.rb +72 -72
  16. data/lib/jekyll-open-sdg-plugins/schema-indicator-config.json +787 -709
  17. data/lib/jekyll-open-sdg-plugins/schema-site-config.json +1712 -1607
  18. data/lib/jekyll-open-sdg-plugins/sdg_variables.rb +614 -549
  19. data/lib/jekyll-open-sdg-plugins/search_index.rb +102 -102
  20. data/lib/jekyll-open-sdg-plugins/site_configuration.rb +87 -73
  21. data/lib/jekyll-open-sdg-plugins/translate_date.rb +122 -122
  22. data/lib/jekyll-open-sdg-plugins/translate_key.rb +20 -20
  23. data/lib/jekyll-open-sdg-plugins/translate_metadata_field.rb +111 -111
  24. data/lib/jekyll-open-sdg-plugins/validate_indicator_config.rb +52 -52
  25. data/lib/jekyll-open-sdg-plugins/validate_site_config.rb +34 -34
  26. data/lib/jekyll-open-sdg-plugins/version.rb +3 -3
  27. data/lib/jekyll-open-sdg-plugins.rb +18 -18
  28. data/tests/Gemfile +7 -7
  29. data/tests/_config.yml +168 -168
  30. metadata +5 -5
data/lib/jekyll-open-sdg-plugins/schema-site-config.json CHANGED
@@ -1,1607 +1,1712 @@
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. These are optional, and you don't have to use all of them. Typically you would just use one, such as the 'ua' option.",
35
- "properties": {
36
- "ua": {
37
- "type": "string",
38
- "title": "Universal Analytics (ua) tracking ID",
39
- "description": "The tracking ID for the analytics.js approach, for your property on Google Analytics. Typically starts with 'UA-'."
40
- },
41
- "gtag": {
42
- "type": "string",
43
- "title": "gtag.js (gtag) tracking ID",
44
- "description": "The tracking ID for the gtag.js approach, for your property on Google Analytics. Typically starts with 'G-'."
45
- },
46
- "gtm": {
47
- "type": "string",
48
- "title": "Google Tag Manager (gtm) tracking ID",
49
- "description": "Your tracking ID for Google Tag Manager. Typically starts with 'GTM-'. Though this is included as an analytics approach, it requires additional configuration within Google Tag Manager in order to capture analytics."
50
- }
51
- },
52
- "links": [
53
- {
54
- "rel": "More information on the analytics setting",
55
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#analytics"
56
- }
57
- ]
58
- },
59
- "breadcrumbs": {
60
- "options": {"collapsed": true},
61
- "type": "object",
62
- "title": "Breadcrumbs",
63
- "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.",
64
- "properties": {
65
- "goal": {
66
- "options": {"collapsed": true},
67
- "type": "array",
68
- "title": "Goal breadcrumbs",
69
- "description": "The breadcrumb items for goal pages.",
70
- "items": {
71
- "$ref": "#/definitions/breadcrumb_item"
72
- }
73
- },
74
- "indicator": {
75
- "options": {"collapsed": true},
76
- "type": "array",
77
- "title": "Indicator breadcrumbs",
78
- "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.",
79
- "items": {
80
- "$ref": "#/definitions/breadcrumb_item"
81
- }
82
- },
83
- "post": {
84
- "options": {"collapsed": true},
85
- "type": "array",
86
- "title": "Post breadcrumbs",
87
- "description": "The breadcrumb items for post pages.",
88
- "items": {
89
- "$ref": "#/definitions/breadcrumb_item"
90
- }
91
- }
92
- },
93
- "links": [
94
- {
95
- "rel": "More information on the breadcrumbs setting",
96
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#breadcrumbs"
97
- }
98
- ]
99
- },
100
- "contrast_type": {
101
- "type": "string",
102
- "title": "Contrast type",
103
- "description": "The type of high-contrast toggle to use.",
104
- "enum": ["default", "single", "long"],
105
- "options": {
106
- "enum_titles": [
107
- "Default - two 'A' buttons side-by-side",
108
- "Single - one 'A' button which toggles on/off",
109
- "Long - text toggling between 'High contrast' and 'Default contrast'"
110
- ]
111
- },
112
- "links": [
113
- {
114
- "rel": "More information on the contrast type setting",
115
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#contrast_type"
116
- }
117
- ]
118
- },
119
- "cookie_consent_form": {
120
- "options": {"collapsed": true},
121
- "type": "object",
122
- "title": "Cookie consent form",
123
- "description": "A cookie consent form for users",
124
- "properties": {
125
- "enabled": {
126
- "type": "boolean",
127
- "title": "Enabled",
128
- "description": "Whether the cookie consent form will be enabled",
129
- "format": "checkbox"
130
- }
131
- },
132
- "links": [
133
- {
134
- "rel": "More information on the cookie_consent_form setting",
135
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#cookie_consent_form"
136
- }
137
- ]
138
- },
139
- "country": {
140
- "options": {"collapsed": true},
141
- "type": "object",
142
- "title": "Country information",
143
- "description": "Information about your country (or region, locality, etc.)",
144
- "properties": {
145
- "name": {
146
- "type": "string",
147
- "title": "Name",
148
- "description": "The name of your country/region/locality/etc.",
149
- "minLength": 1
150
- },
151
- "adjective": {
152
- "type": "string",
153
- "title": "Adjective",
154
- "description": "Adjective form of your country/region/locality/etc.",
155
- "minLength": 1
156
- }
157
- },
158
- "links": [
159
- {
160
- "rel": "More information on the country setting",
161
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#country"
162
- }
163
- ]
164
- },
165
- "create_goals": {
166
- "options": {"collapsed": true},
167
- "type": "object",
168
- "title": "Create goals",
169
- "description": "This setting can be used to automatically create the goal pages.",
170
- "properties": {
171
- "layout": {
172
- "type": "string",
173
- "title": "Layout",
174
- "enum": [
175
- "",
176
- "goal",
177
- "goal-by-target",
178
- "goal-by-target-vertical",
179
- "goal-with-progress"
180
- ],
181
- "options": {
182
- "enum_titles": [
183
- "Do not automatically create goals",
184
- "goal",
185
- "goal-by-target",
186
- "goal-by-target-vertical",
187
- "goal-with-progress"
188
- ]
189
- },
190
- "description": "The layout to use for the goal pages."
191
- },
192
- "previous_next_links": {
193
- "title": "Previous/next links",
194
- "type": "boolean",
195
- "description": "This setting can be used to show navigation links to the previous/next goals.",
196
- "format": "checkbox"
197
- },
198
- "goals": {
199
- "options": {"collapsed": true},
200
- "type": "array",
201
- "title": "Content per goal",
202
- "description": "This setting can be used to enter details for each goal.",
203
- "items": {
204
- "type": "object",
205
- "title": "Goal",
206
- "properties": {
207
- "content": {
208
- "type": "string",
209
- "title": "Content",
210
- "format": "markdown",
211
- "description": "Markdown content or a translation key for this goal."
212
- }
213
- }
214
- }
215
- }
216
- },
217
- "links": [
218
- {
219
- "rel": "More information on the create goals setting",
220
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_goals"
221
- }
222
- ]
223
- },
224
- "create_indicators": {
225
- "options": {"collapsed": true},
226
- "type": "object",
227
- "title": "Create indicators",
228
- "description": "This setting can be used to automatically create the indicator pages.",
229
- "properties": {
230
- "layout": {
231
- "type": "string",
232
- "title": "Layout",
233
- "enum": [
234
- "",
235
- "indicator"
236
- ],
237
- "options": {
238
- "enum_titles": [
239
- "Do not automatically create indicators",
240
- "indicator"
241
- ]
242
- },
243
- "description": "The layout to use for the indicator pages."
244
- },
245
- "previous_next_links": {
246
- "title": "Previous/next links",
247
- "type": "boolean",
248
- "description": "This setting can be used to show navigation links to the previous/next indicators.",
249
- "format": "checkbox"
250
- }
251
- },
252
- "links": [
253
- {
254
- "rel": "More information on the create indicators setting",
255
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_indicators"
256
- }
257
- ]
258
- },
259
- "create_pages": {
260
- "options": {"collapsed": true},
261
- "type": "array",
262
- "title": "Create pages",
263
- "description": "This setting can be used to automatically create the pages.",
264
- "items": {
265
- "type": "object",
266
- "title": "Page",
267
- "properties": {
268
- "filename": {
269
- "type": "string",
270
- "title": "Filename",
271
- "description": "The filename for the page - usually 'index.html'."
272
- },
273
- "folder": {
274
- "type": "string",
275
- "minLength": 1,
276
- "title": "Folder",
277
- "description": "The folder path for the page."
278
- },
279
- "layout": {
280
- "type": "string",
281
- "minLength": 1,
282
- "title": "Layout",
283
- "description": "The layout to use for the page."
284
- },
285
- "title": {
286
- "type": "string",
287
- "title": "Title",
288
- "description": "The page title for the page."
289
- }
290
- }
291
- },
292
- "links": [
293
- {
294
- "rel": "More information on the create pages setting",
295
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_pages"
296
- }
297
- ]
298
- },
299
- "custom_css": {
300
- "options": {"collapsed": true},
301
- "type": "array",
302
- "title": "Custom CSS files",
303
- "description": "Deprecated: instead of using this, it is recommended to put custom CSS in a _sass/custom.scss file.",
304
- "items": {
305
- "type": "string",
306
- "title": "Custom CSS file"
307
- },
308
- "links": [
309
- {
310
- "rel": "More information on the custom CSS setting",
311
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_css"
312
- }
313
- ]
314
- },
315
- "custom_js": {
316
- "options": {"collapsed": true},
317
- "type": "array",
318
- "title": "Custom JavaScript files",
319
- "description": "This setting can be used to load additional JavaScript files on each page.",
320
- "items": {
321
- "type": "string",
322
- "title": "Custom JavaScript file"
323
- },
324
- "links": [
325
- {
326
- "rel": "More information on the custom JS setting",
327
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_js"
328
- }
329
- ]
330
- },
331
- "data_edit_url": {
332
- "type": "string",
333
- "title": "Data edit URL",
334
- "description": "This setting controls the URL of the 'Edit Data' buttons that appear on the staging site's indicator pages.",
335
- "links": [
336
- {
337
- "rel": "More information on the data edit URL setting",
338
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_edit_url"
339
- }
340
- ]
341
- },
342
- "data_fields": {
343
- "options": {"collapsed": true},
344
- "type": "object",
345
- "title": "Data fields",
346
- "description": "Control the names of fields used for special purposes in data.",
347
- "properties": {
348
- "units": {
349
- "type": "string",
350
- "title": "Units",
351
- "description": "Field to reserve for units of measurement. Defaults to 'Units'."
352
- },
353
- "series": {
354
- "type": "string",
355
- "title": "Series",
356
- "description": "Field to reserve for the SDG series. Defaults to 'Series'."
357
- }
358
- },
359
- "links": [
360
- {
361
- "rel": "More information on the data fields setting",
362
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_fields"
363
- }
364
- ]
365
- },
366
- "date_formats": {
367
- "options": {"collapsed": true},
368
- "type": "array",
369
- "title": "Date formats",
370
- "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.",
371
- "items": {
372
- "type": "object",
373
- "title": "Date format",
374
- "properties": {
375
- "type": {
376
- "type": "string",
377
- "minLength": 1,
378
- "title": "Type",
379
- "description": "Use `standard` for news/post dates."
380
- },
381
- "language": {
382
- "type": "string",
383
- "minLength": 1,
384
- "title": "Language",
385
- "description": "Language code the format applies to."
386
- },
387
- "format": {
388
- "type": "string",
389
- "minLength": 1,
390
- "title": "Format",
391
- "description": "Ruby DateTime date format."
392
- }
393
- }
394
- },
395
- "links": [
396
- {
397
- "rel": "More information on the date formats setting",
398
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#date_formats"
399
- }
400
- ]
401
- },
402
- "disclaimer": {
403
- "options": {"collapsed": true},
404
- "type": "object",
405
- "title": "Disclaimer",
406
- "description": "This setting controls the content of the disclaimer that appears at the top of each page.",
407
- "properties": {
408
- "phase": {
409
- "type": "string",
410
- "title": "Phase",
411
- "description": "The development phase of your platform (alpha, beta, etc.)"
412
- },
413
- "message": {
414
- "type": "string",
415
- "title": "Message",
416
- "description": "A short disclaimer message."
417
- }
418
- },
419
- "links": [
420
- {
421
- "rel": "More information on the disclaimer setting",
422
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#disclaimer"
423
- }
424
- ]
425
- },
426
- "email_contacts": {
427
- "options": {"collapsed": true},
428
- "type": "object",
429
- "title": "Email addresses",
430
- "description": "Email addresses to publish on your platform.",
431
- "properties": {
432
- "questions": {
433
- "type": "string",
434
- "minLength": 1,
435
- "format": "email",
436
- "title": "Questions",
437
- "description": "Inbox for questions about your platform."
438
- },
439
- "suggestions": {
440
- "type": "string",
441
- "minLength": 1,
442
- "format": "email",
443
- "title": "Suggestions",
444
- "description": "Inbox for suggestions for your platform."
445
- },
446
- "functional": {
447
- "type": "string",
448
- "minLength": 1,
449
- "format": "email",
450
- "title": "Functional",
451
- "description": "Inbox for bug reports for your platform."
452
- }
453
- },
454
- "links": [
455
- {
456
- "rel": "More information on the email contacts setting",
457
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#email_contacts"
458
- }
459
- ]
460
- },
461
- "environment": {
462
- "type": "string",
463
- "minLength": 1,
464
- "title": "Environment",
465
- "description": "Which environment (staging or production) this configuration is for.",
466
- "enum": ["staging", "production"],
467
- "links": [
468
- {
469
- "rel": "More information on the environment setting",
470
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#environment"
471
- }
472
- ]
473
- },
474
- "favicons": {
475
- "type": "string",
476
- "title": "Favicons",
477
- "description": "The type of favicons to use.",
478
- "enum": ["legacy", "favicon.io"],
479
- "options": {
480
- "enum_titles": [
481
- "Legacy",
482
- "Favicon.io (recommended)"
483
- ]
484
- },
485
- "links": [
486
- {
487
- "rel": "More information on the favicons setting",
488
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#favicons"
489
- }
490
- ]
491
- },
492
- "footer_language_toggle": {
493
- "type": "string",
494
- "title": "Footer language toggle",
495
- "description": "This setting controls the type of language toggle to be used in the footer.",
496
- "enum": ["none", "dropdown", "links"],
497
- "links": [
498
- {
499
- "rel": "More information on the footer language toggle setting",
500
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_language_toggle"
501
- }
502
- ]
503
- },
504
- "footer_menu": {
505
- "options": {"collapsed": true},
506
- "type": "array",
507
- "title": "Footer menu",
508
- "description": "The links to display in the footer menu.",
509
- "items": {
510
- "$ref": "#/definitions/menu_item"
511
- },
512
- "links": [
513
- {
514
- "rel": "More information on the footer menu setting",
515
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_menu"
516
- }
517
- ]
518
- },
519
- "frontpage_cards": {
520
- "options": {"collapsed": true},
521
- "type": "array",
522
- "title": "Frontpage cards",
523
- "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.",
524
- "items": {
525
- "type": "object",
526
- "title": "Frontpage card",
527
- "properties": {
528
- "title": {
529
- "type": "string",
530
- "minLength": 1,
531
- "title": "Title",
532
- "description": "The card's title."
533
- },
534
- "content": {
535
- "type": "string",
536
- "title": "Content",
537
- "description": "The card's content.",
538
- "format": "markdown"
539
- },
540
- "include": {
541
- "type": "string",
542
- "title": "Include file",
543
- "description": "A Jekyll include file to place inside the card."
544
- },
545
- "button_label": {
546
- "type": "string",
547
- "title": "Button label",
548
- "description": "A label for a button to display at the bottom of the card."
549
- },
550
- "button_link": {
551
- "type": "string",
552
- "title": "Button link",
553
- "description": "A path or URL for the card's button to link to."
554
- },
555
- "rule_color": {
556
- "type": "string",
557
- "title": "Rule color",
558
- "description": "The color of the horizontal line appearing above the card."
559
- }
560
- }
561
- },
562
- "links": [
563
- {
564
- "rel": "More information on the frontpage cards setting",
565
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_cards"
566
- }
567
- ]
568
- },
569
- "frontpage_goals_grid": {
570
- "options": {"collapsed": true},
571
- "type": "object",
572
- "title": "Frontpage goals grid",
573
- "description": "This setting is only used in the frontpage-alt layout. It can display a title and description above the grid of goal tiles.",
574
- "$ref": "#/definitions/title_and_description",
575
- "links": [
576
- {
577
- "rel": "More information on the frontpage goals grid setting",
578
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_goals_grid"
579
- }
580
- ]
581
- },
582
- "frontpage_heading": {
583
- "type": "string",
584
- "title": "Frontpage heading",
585
- "description": "This setting can control the heading that appears on the front page. This setting is only used in the frontpage layout.",
586
- "links": [
587
- {
588
- "rel": "More information on the frontpage heading setting",
589
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_heading"
590
- }
591
- ]
592
- },
593
- "frontpage_instructions": {
594
- "type": "string",
595
- "title": "Frontpage instructions",
596
- "description": "This setting can control the instructions that appear on the front page. This setting is only used in the frontpage layout.",
597
- "links": [
598
- {
599
- "rel": "More information on the frontpage instructions setting",
600
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_instructions"
601
- }
602
- ]
603
- },
604
- "frontpage_introduction_banner": {
605
- "options": {"collapsed": true},
606
- "type": "object",
607
- "title": "Frontpage introduction banner",
608
- "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.",
609
- "$ref": "#/definitions/title_and_description",
610
- "links": [
611
- {
612
- "rel": "More information on the frontpage introduction banner setting",
613
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_introduction_banner"
614
- }
615
- ]
616
- },
617
- "goal_image_base": {
618
- "type": "string",
619
- "minLength": 1,
620
- "title": "Goal image base URL",
621
- "description": "This setting controls the base URL for downloading the imagery for the goals.",
622
- "links": [
623
- {
624
- "rel": "More information on the goal image base setting",
625
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_base"
626
- }
627
- ]
628
- },
629
- "goal_image_extension": {
630
- "type": "string",
631
- "title": "Goal image extension",
632
- "description": "This setting controls the type of file (the file extension) that will be used for the goal images.",
633
- "links": [
634
- {
635
- "rel": "More information on the goal image extension setting",
636
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_extension"
637
- }
638
- ]
639
- },
640
- "goals_page": {
641
- "options": {"collapsed": true},
642
- "type": "object",
643
- "title": "Goals page",
644
- "description": "This setting is used in the 'goals' layout. It can display a title and description above the grid of goal tiles.",
645
- "$ref": "#/definitions/title_and_description",
646
- "links": [
647
- {
648
- "rel": "More information on the goals page setting",
649
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goals_page"
650
- }
651
- ]
652
- },
653
- "graph_color_headline": {
654
- "type": "string",
655
- "format": "color",
656
- "title": "Graph color for headline",
657
- "default": "#004466",
658
- "description": "This setting can be used to customize the color used in the chart 'headlines'.",
659
- "examples": [],
660
- "links": [
661
- {
662
- "rel": "More information on the graph color headline setting",
663
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_headline"
664
- }
665
- ]
666
- },
667
- "graph_color_headline_high_contrast": {
668
- "type": "string",
669
- "format": "color",
670
- "title": "Graph color for headline - high-contrast",
671
- "default": "#55a6e5",
672
- "description": "This setting can be used to customize the color used in the chart 'headlines' in high-contrast mode.",
673
- "examples": [],
674
- "links": [
675
- {
676
- "rel": "More information on the graph color headline high-contrast setting",
677
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_headline_high_contrast"
678
- }
679
- ]
680
- },
681
- "graph_color_set": {
682
- "type": "string",
683
- "title": "Graph color set",
684
- "description": "This setting can be used to customize the color set used in the charts.",
685
- "examples": [],
686
- "enum": ["default", "accessible", "sdg", "goal", "custom"],
687
- "links": [
688
- {
689
- "rel": "More information on the graph color set setting",
690
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_set"
691
- }
692
- ]
693
- },
694
- "graph_color_list": {
695
- "options": {"collapsed": true},
696
- "type": "array",
697
- "title": "Graph color list",
698
- "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'.",
699
- "items": {
700
- "type": "string",
701
- "format": "color",
702
- "title": "Color",
703
- "description": "Hexadecimal color code"
704
- },
705
- "links": [
706
- {
707
- "rel": "More information on the graph color list setting",
708
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_list"
709
- }
710
- ]
711
- },
712
- "graph_color_number": {
713
- "title": "Graph color number",
714
- "type": "integer",
715
- "description": "This setting can be used to limit the length of the list of colors selected via graph_color_set.",
716
- "links": [
717
- {
718
- "rel": "More information on the graph color number setting",
719
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_number"
720
- }
721
- ]
722
- },
723
- "graph_title_from_series": {
724
- "title": "Graph title from series",
725
- "type": "boolean",
726
- "description": "This setting can be set to `true` to use the selected series for the graph title, whenever possible.",
727
- "format": "checkbox",
728
- "links": [
729
- {
730
- "rel": "More information on the graph title from series setting",
731
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_title_from_series"
732
- }
733
- ]
734
- },
735
- "header": {
736
- "options": {"collapsed": true},
737
- "type": "object",
738
- "title": "Header",
739
- "description": "This setting can be used to customise the header.",
740
- "properties": {
741
- "include": {
742
- "type": "string",
743
- "title": "Include file",
744
- "enum": [
745
- "header-default.html",
746
- "header-menu-left-aligned.html"
747
- ],
748
- "options": {
749
- "enum_titles": [
750
- "Default header",
751
- "Menu left-aligned"
752
- ]
753
- },
754
- "description": "The header style to use on all pages."
755
- }
756
- },
757
- "links": [
758
- {
759
- "rel": "More information on the header setting",
760
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header"
761
- }
762
- ]
763
- },
764
- "header_language_toggle": {
765
- "type": "string",
766
- "title": "Header language toggle",
767
- "description": "This setting controls the type of language toggle to be used in the header.",
768
- "enum": ["none", "dropdown", "links"],
769
- "links": [
770
- {
771
- "rel": "More information on the header language toggle setting",
772
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header_language_toggle"
773
- }
774
- ]
775
- },
776
- "hide_empty_metadata": {
777
- "title": "Hide empty metadata",
778
- "type": "boolean",
779
- "description": "This setting can be used to hide any metadata fields that are empty.",
780
- "format": "checkbox",
781
- "links": [
782
- {
783
- "rel": "More information on the hide empty metadata setting",
784
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_empty_metadata"
785
- }
786
- ]
787
- },
788
- "hide_single_series": {
789
- "title": "Hide single series",
790
- "type": "boolean",
791
- "description": "This setting can be used to hide the 'Series' toggle on indicators where there is only one choice.",
792
- "format": "checkbox",
793
- "links": [
794
- {
795
- "rel": "More information on the hide single series setting",
796
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_series"
797
- }
798
- ]
799
- },
800
- "hide_single_unit": {
801
- "title": "Hide single unit",
802
- "type": "boolean",
803
- "description": "This setting can be used to hide the 'Unit' toggle on indicators where there is only one choice.",
804
- "format": "checkbox",
805
- "links": [
806
- {
807
- "rel": "More information on the hide single unit setting",
808
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_unit"
809
- }
810
- ]
811
- },
812
- "indicator_config_form": {
813
- "options": {"collapsed": true},
814
- "type": "object",
815
- "title": "Indicator configuration form",
816
- "description": "Configuration of the indicator configuration form.",
817
- "$ref": "#/definitions/config_form_options"
818
- },
819
- "indicator_data_form": {
820
- "options": {"collapsed": true},
821
- "type": "object",
822
- "title": "Indicator data form",
823
- "description": "Configuration of the indicator data form.",
824
- "properties": {
825
- "enabled": {
826
- "type": "boolean",
827
- "title": "Enable this type of form",
828
- "description": "If enabled, the indicator data form will be available.",
829
- "format": "checkbox"
830
- },
831
- "repository_link": {
832
- "type": "string",
833
- "title": "Repository link",
834
- "description": "The URL pattern of the 'Go to repository' link on the configuration page."
835
- }
836
- }
837
- },
838
- "indicator_metadata_form": {
839
- "options": {"collapsed": true},
840
- "type": "object",
841
- "title": "Indicator metadata form",
842
- "description": "Configuration of the indicator metadata form.",
843
- "allOf": [
844
- { "$ref": "#/definitions/config_form_options" },
845
- {
846
- "properties": {
847
- "language": {
848
- "type": "string",
849
- "title": "Language for editing",
850
- "description": "Choose the language you prefer when editing metadata. This is used to translate the labels of the metadata fields."
851
- },
852
- "scopes": {
853
- "options": {"collapsed": true},
854
- "type": "array",
855
- "title": "Metadata scopes",
856
- "description": "Specify the 'scopes' of metadata to include on the form. Eg: 'national' or 'global'.",
857
- "items": {
858
- "type": "string",
859
- "title": "Scope"
860
- }
861
- },
862
- "exclude_fields": {
863
- "options": {"collapsed": true},
864
- "type": "array",
865
- "title": "Exclude fields",
866
- "description": "Specify any fields you would like to exclude from the form.",
867
- "items": {
868
- "type": "string",
869
- "title": "Field"
870
- }
871
- },
872
- "translated": {
873
- "type": "boolean",
874
- "title": "Display translated contents in the form",
875
- "description": "This should only be enabled if you are using the 'subfolder' approach for your metadata.",
876
- "format": "checkbox"
877
- }
878
- }
879
- }
880
- ]
881
- },
882
- "languages": {
883
- "options": {"collapsed": true},
884
- "type": "array",
885
- "minItems": 1,
886
- "title": "Languages",
887
- "description": "This setting controls the languages to be used on the site.",
888
- "items": {
889
- "type": "string",
890
- "minLength": 1,
891
- "title": "Language"
892
- },
893
- "links": [
894
- {
895
- "rel": "More information on the languages setting",
896
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages"
897
- }
898
- ]
899
- },
900
- "languages_public": {
901
- "options": {"collapsed": true},
902
- "type": "array",
903
- "title": "Language code overrides",
904
- "description": "This setting can be used if you are not happy with any of the standard language codes.",
905
- "items": {
906
- "type": "object",
907
- "title": "Language override",
908
- "properties": {
909
- "language": {
910
- "type": "string",
911
- "minLength": 1,
912
- "title": "Language",
913
- "description": "The (standard) language code that you would like to override."
914
- },
915
- "language_public": {
916
- "type": "string",
917
- "minLength": 1,
918
- "title": "Language override",
919
- "description": "The (non-standard) language code that you would like show the public instead."
920
- }
921
- }
922
- },
923
- "links": [
924
- {
925
- "rel": "More information on the language override setting",
926
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages_public"
927
- }
928
- ]
929
- },
930
- "logos": {
931
- "options": {"collapsed": true},
932
- "type": "array",
933
- "title": "Logos",
934
- "description": "This setting can be used to control the main logo (or logos).",
935
- "items": {
936
- "type": "object",
937
- "title": "Logo",
938
- "properties": {
939
- "language": {
940
- "type": "string",
941
- "title": "Language",
942
- "description": "The language on which this logo displays. Leave blank to show on all."
943
- },
944
- "src": {
945
- "type": "string",
946
- "minLength": 1,
947
- "title": "Image file",
948
- "description": "The image file (path or URL) for this logo"
949
- },
950
- "alt": {
951
- "type": "string",
952
- "minLength": 1,
953
- "title": "Alt text",
954
- "description": "The alt text for this logo"
955
- }
956
- }
957
- },
958
- "links": [
959
- {
960
- "rel": "More information on the logos setting",
961
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#logos"
962
- }
963
- ]
964
- },
965
- "map_layers": {
966
- "options": {"collapsed": true},
967
- "type": "array",
968
- "title": "Map layers",
969
- "description": "Configure any number of layers to display on all indicator maps. A minimum of one layer is required to display maps.",
970
- "items": {
971
- "type": "object",
972
- "title": "Map layer",
973
- "properties": {
974
- "subfolder": {
975
- "type": "string",
976
- "title": "Subfolder",
977
- "description": "The subfolder under 'geojson' in the data repository holding the GeoJSON file for this layer."
978
- },
979
- "label": {
980
- "type": "string",
981
- "title": "Download button label",
982
- "description": "The label to use in the 'Download GeoJSON' button for this layer."
983
- },
984
- "min_zoom": {
985
- "type": "integer",
986
- "title": "Minimum zoom",
987
- "description": "This layer will only be visible when the map is zoomed to at least this number."
988
- },
989
- "max_zoom": {
990
- "type": "integer",
991
- "title": "Maximum zoom",
992
- "description": "The layer will not be visible when the map is zoomed beyond this number."
993
- },
994
- "staticBorders": {
995
- "type": "boolean",
996
- "format": "checkbox",
997
- "title": "Static borders",
998
- "description": "Whether the borders on this layer should remain visible when the map is zoomed past the maximum."
999
- }
1000
- }
1001
- },
1002
- "links": [
1003
- {
1004
- "rel": "More information on the map layers setting",
1005
- "href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_layers"
1006
- }
1007
- ]
1008
- },
1009
- "map_options": {
1010
- "options": {"collapsed": true},
1011
- "type": "object",
1012
- "title": "Map options",
1013
- "description": "Site-wide configuration of map behavior and style.",
1014
- "properties": {
1015
- "minZoom": {
1016
- "title": "Minimum zoom",
1017
- "type": "integer",
1018
- "description": "The lowest amount of 'zoom' possible for users.",
1019
- "default": 5
1020
- },
1021
- "maxZoom": {
1022
- "title": "Maximum zoom",
1023
- "type": "integer",
1024
- "description": "The highest amount of 'zoom' possible for users.",
1025
- "default": 10
1026
- },
1027
- "tileURL": {
1028
- "title": "Tile URL",
1029
- "type": "string",
1030
- "format": "url",
1031
- "description": "If you would like the maps to show tile imagery, add the URL here."
1032
- },
1033
- "tileOptions": {
1034
- "title": "Tile options",
1035
- "type": "object",
1036
- "options": {"collapsed": true},
1037
- "description": "Additional options for map tile imagery.",
1038
- "properties": {
1039
- "id": {
1040
- "type": "string",
1041
- "title": "Tile ID"
1042
- },
1043
- "accessToken": {
1044
- "type": "string",
1045
- "title": "Access token"
1046
- },
1047
- "attribution": {
1048
- "type": "string",
1049
- "title": "Attribution"
1050
- }
1051
- }
1052
- },
1053
- "colorRange": {
1054
- "type": "string",
1055
- "title": "Color range",
1056
- "description": "The color range for the choropleth map.",
1057
- "default": "chroma.brewer.BuGn",
1058
- "links": [
1059
- {
1060
- "ref": "More information on the color range setting",
1061
- "href": "https://gka.github.io/chroma.js/#chroma-brewer"
1062
- }
1063
- ]
1064
- },
1065
- "noValueColor": {
1066
- "type": "string",
1067
- "format": "color",
1068
- "title": "No-value color",
1069
- "description": "Color for boundaries that have no data.",
1070
- "default": "#f0f0f0"
1071
- },
1072
- "styleNormal": {
1073
- "type": "object",
1074
- "title": "Style (normal)",
1075
- "description": "Style for boundaries in normal state",
1076
- "$ref": "#/definitions/map_style",
1077
- "default": {
1078
- "weight": 1,
1079
- "opacity": 1,
1080
- "fillOpacity": 0.7,
1081
- "color": "#888888"
1082
- }
1083
- },
1084
- "styleHighlighted": {
1085
- "type": "object",
1086
- "title": "Style (highlighted)",
1087
- "description": "Style for boundaries in highlighted state",
1088
- "$ref": "#/definitions/map_style",
1089
- "default": {
1090
- "weight": 1,
1091
- "opacity": 1,
1092
- "fillOpacity": 0.7,
1093
- "color": "#111111"
1094
- }
1095
- },
1096
- "styleStatic": {
1097
- "type": "object",
1098
- "title": "Style (static)",
1099
- "description": "Style for boundaries in static state (map layers using the 'static boundaries' option).",
1100
- "$ref": "#/definitions/map_style",
1101
- "default": {
1102
- "weight": 2,
1103
- "opacity": 1,
1104
- "fillOpacity": 0,
1105
- "color": "#172d44",
1106
- "dashArray": "5,5"
1107
- }
1108
- }
1109
- },
1110
- "links": [
1111
- {
1112
- "rel": "More information on the map options setting",
1113
- "href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_options"
1114
- }
1115
- ]
1116
- },
1117
- "menu": {
1118
- "options": {"collapsed": true},
1119
- "type": "array",
1120
- "minItems": 1,
1121
- "title": "Main menu",
1122
- "description": "The links to display in the main menu.",
1123
- "items": {
1124
- "title": "Menu item",
1125
- "allOf": [
1126
- { "$ref": "#/definitions/menu_item" },
1127
- {
1128
- "properties": {
1129
- "dropdown": {
1130
- "title": "Dropdown menu",
1131
- "type": "array",
1132
- "description": "Enter menu items here to turn this into a dropdown.",
1133
- "items": {
1134
- "$ref": "#/definitions/menu_item",
1135
- "title": "Dropdown menu item"
1136
- }
1137
- }
1138
- }
1139
- }
1140
- ]
1141
- },
1142
- "links": [
1143
- {
1144
- "rel": "More information on the menu setting",
1145
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#menu"
1146
- }
1147
- ]
1148
- },
1149
- "metadata_edit_url": {
1150
- "type": "string",
1151
- "title": "Metadata edit URL",
1152
- "description": "This setting controls the URL of the 'Edit Metadata' buttons that appear on the staging site's indicator pages.",
1153
- "links": [
1154
- {
1155
- "rel": "More information on the metadata edit URL setting",
1156
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_edit_url"
1157
- }
1158
- ]
1159
- },
1160
- "metadata_tabs": {
1161
- "options": {"collapsed": true},
1162
- "type": "array",
1163
- "title": "Metadata tabs",
1164
- "description": "This setting can control the metadata tabs which appear on the indicator pages.",
1165
- "items": {
1166
- "type": "object",
1167
- "title": "Metadata tab",
1168
- "properties": {
1169
- "scope": {
1170
- "type": "string",
1171
- "minLength": 1,
1172
- "title": "Scope",
1173
- "description": "This tab will contain fields in the specific `scope` in your data repository's metadata schema file (eg, `_prose.yml`)."
1174
- },
1175
- "title": {
1176
- "type": "string",
1177
- "minLength": 1,
1178
- "title": "Title",
1179
- "description": "The title of the metadata tab."
1180
- },
1181
- "description": {
1182
- "type": "string",
1183
- "title": "Description",
1184
- "description": "A descriptive blurb to show at the top of the tab content.",
1185
- "format": "markdown"
1186
- }
1187
- }
1188
- },
1189
- "links": [
1190
- {
1191
- "rel": "More information on the metadata tabs setting",
1192
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_tabs"
1193
- }
1194
- ]
1195
- },
1196
- "news": {
1197
- "options": {"collapsed": true},
1198
- "type": "object",
1199
- "title": "News",
1200
- "description": "Configuration related to news updates and posts.",
1201
- "properties": {
1202
- "category_links": {
1203
- "title": "Category links",
1204
- "type": "boolean",
1205
- "description": "Whether you would like the 'categories' of posts to generate links to dedicated category pages.",
1206
- "format": "checkbox"
1207
- }
1208
- },
1209
- "links": [
1210
- {
1211
- "rel": "More information on the news setting",
1212
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#news"
1213
- }
1214
- ]
1215
- },
1216
- "non_global_metadata": {
1217
- "type": "string",
1218
- "title": "Non-global metadata",
1219
- "description": "This setting can be used to control the text of the tab containing non-global metadata.",
1220
- "links": [
1221
- {
1222
- "rel": "More information on the non-global metadata setting",
1223
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#non_global_metadata"
1224
- }
1225
- ]
1226
- },
1227
- "progress_status": {
1228
- "options": {"collapsed": true},
1229
- "type": "object",
1230
- "title": "Progress status",
1231
- "description": "This setting is used in the 'goal-with-progress' layout. It controls the behavior of progress status functionality.",
1232
- "properties": {
1233
- "status_heading": {
1234
- "title": "Status heading",
1235
- "type": "string",
1236
- "description": "A heading to display before the progress status on indicator pages."
1237
- },
1238
- "status_types": {
1239
- "options": {"collapsed": true},
1240
- "type": "array",
1241
- "title": "Status types",
1242
- "description": "Controls the behavior and labels for the different progress status types.",
1243
- "items": {
1244
- "type": "object",
1245
- "title": "Status type",
1246
- "properties": {
1247
- "value": {
1248
- "type": "string",
1249
- "minLength": 1,
1250
- "title": "Value",
1251
- "description": "The value of the status type, as it is set in the indicator configuration (eg, 'targetachieved')."
1252
- },
1253
- "label": {
1254
- "type": "string",
1255
- "title": "Label",
1256
- "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.target_achieved')."
1257
- },
1258
- "image": {
1259
- "type": "string",
1260
- "title": "Image",
1261
- "description": "The internal path to the image to use (if any) for this progress status."
1262
- },
1263
- "alt": {
1264
- "type": "string",
1265
- "title": "Alt",
1266
- "description": "An alt tag for the image above."
1267
- }
1268
- }
1269
- }
1270
- }
1271
- },
1272
- "links": [
1273
- {
1274
- "rel": "More information on the progress status setting",
1275
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#progress_status"
1276
- }
1277
- ]
1278
- },
1279
- "remote_data_prefix": {
1280
- "type": "string",
1281
- "minLength": 1,
1282
- "title": "Remote data prefix",
1283
- "description": "Specify the URL of the 'data service' that is generated from your data repository.",
1284
- "links": [
1285
- {
1286
- "rel": "More information on the remote data prefix setting",
1287
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#remote_data_prefix"
1288
- }
1289
- ]
1290
- },
1291
- "reporting_status": {
1292
- "options": {"collapsed": true},
1293
- "type": "object",
1294
- "title": "Reporting status",
1295
- "description": "This setting is used in the 'reportingstatus' layout. It can display a title and description above the reporting status page.",
1296
- "allOf": [
1297
- { "$ref": "#/definitions/title_and_description" },
1298
- {
1299
- "properties": {
1300
- "disaggregation_tabs": {
1301
- "title": "Disaggregation tabs",
1302
- "type": "boolean",
1303
- "description": "Whether or not to display disaggregation status tabs. If you enable this setting, you should also use 'expected_disaggregations' in your indicator configuration, in order to provide the disaggregation status report with useful metrics.",
1304
- "format": "checkbox"
1305
- },
1306
- "status_types": {
1307
- "options": {"collapsed": true},
1308
- "type": "array",
1309
- "title": "Status types",
1310
- "description": "Controls the behavior and labels for the different reporting status types.",
1311
- "items": {
1312
- "type": "object",
1313
- "title": "Status type",
1314
- "properties": {
1315
- "value": {
1316
- "type": "string",
1317
- "minLength": 1,
1318
- "title": "Value",
1319
- "description": "The value of the status type, as it is set in the indicator configuration (eg, 'complete')."
1320
- },
1321
- "label": {
1322
- "type": "string",
1323
- "minLength": 1,
1324
- "title": "Label",
1325
- "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.reported_online')."
1326
- },
1327
- "hide_on_goal_pages": {
1328
- "type": "boolean",
1329
- "title": "Hide on goal pages",
1330
- "description": "Whether to hide this status type on goal pages. Useful for the most commonly-occuring type.",
1331
- "format": "checkbox"
1332
- }
1333
- }
1334
- }
1335
- }
1336
- }
1337
- }
1338
- ],
1339
- "links": [
1340
- {
1341
- "rel": "More information on the reporting status setting",
1342
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#reporting_status"
1343
- }
1344
- ]
1345
- },
1346
- "repository_url_data": {
1347
- "type": "string",
1348
- "title": "Repository URL - Data",
1349
- "description": "The URL of your data repository, eg: https://github.com/my-github-org/data",
1350
- "links": [
1351
- {
1352
- "rel": "More information on the data repository URL setting",
1353
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#repository_url_data"
1354
- }
1355
- ]
1356
- },
1357
- "repository_url_site": {
1358
- "type": "string",
1359
- "title": "Repository URL - Site",
1360
- "description": "The URL of your site repository, eg: https://github.com/my-github-org/site",
1361
- "links": [
1362
- {
1363
- "rel": "More information on the site repository URL setting",
1364
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#repository_url_site"
1365
- }
1366
- ]
1367
- },
1368
- "search_index_boost": {
1369
- "options": {"collapsed": true},
1370
- "type": "array",
1371
- "title": "Search index boost",
1372
- "description": "This setting can be used to give a boost to one or more fields in the search index.",
1373
- "items": {
1374
- "type": "object",
1375
- "title": "Boost",
1376
- "properties": {
1377
- "field": {
1378
- "type": "string",
1379
- "minLength": 1,
1380
- "title": "Field",
1381
- "description": "Field to boost ('title', 'content', etc.)"
1382
- },
1383
- "boost": {
1384
- "type": "integer",
1385
- "minLength": 1,
1386
- "title": "Boost",
1387
- "description": "Higher boost means higher search ranking."
1388
- }
1389
- }
1390
- },
1391
- "links": [
1392
- {
1393
- "rel": "More information on the search index boost setting",
1394
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_boost"
1395
- }
1396
- ]
1397
- },
1398
- "search_index_extra_fields": {
1399
- "options": {"collapsed": true},
1400
- "type": "array",
1401
- "title": "Search index extra fields",
1402
- "description": "This setting can be used to index additional metadata fields in your indicators, for the purposes of affecting the site-wide search.",
1403
- "items": {
1404
- "type": "string",
1405
- "title": "Extra field"
1406
- },
1407
- "links": [
1408
- {
1409
- "rel": "More information on the search index extra fields setting",
1410
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_extra_fields"
1411
- }
1412
- ]
1413
- },
1414
- "series_toggle": {
1415
- "title": "Series toggle",
1416
- "type": "boolean",
1417
- "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.",
1418
- "format": "checkbox",
1419
- "links": [
1420
- {
1421
- "rel": "More information on the series toggle setting",
1422
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#series_toggle"
1423
- }
1424
- ]
1425
- },
1426
- "site_config_form": {
1427
- "options": {"collapsed": true},
1428
- "type": "object",
1429
- "title": "Site configuration form",
1430
- "description": "Configuration of the site configuration form.",
1431
- "$ref": "#/definitions/config_form_options"
1432
- },
1433
- "validate_indicator_config": {
1434
- "title": "Validate indicator config",
1435
- "type": "boolean",
1436
- "description": "If checked, this will require that all indicators have valid Open SDG indicator configuration.",
1437
- "format": "checkbox",
1438
- "links": [
1439
- {
1440
- "rel": "More information on the validate indicator config setting",
1441
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_indicator_config"
1442
- }
1443
- ]
1444
- },
1445
- "validate_site_config": {
1446
- "title": "Validate site config",
1447
- "type": "boolean",
1448
- "description": "If checked, this will require valid site configuration.",
1449
- "format": "checkbox",
1450
- "links": [
1451
- {
1452
- "rel": "More information on the validate site config setting",
1453
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_site_config"
1454
- }
1455
- ]
1456
- },
1457
- "x_axis_label": {
1458
- "type": "string",
1459
- "title": "X axis label",
1460
- "description": "A label beneath the X axis on charts. This is overridden by the same indicator configuration setting.",
1461
- "links": [
1462
- {
1463
- "rel": "More information on the X axis label setting",
1464
- "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#x_axis_label"
1465
- }
1466
- ]
1467
- }
1468
- },
1469
- "additionalProperties": true,
1470
- "definitions": {
1471
- "menu_item": {
1472
- "type": "object",
1473
- "title": "Menu item",
1474
- "properties": {
1475
- "path": {
1476
- "type": "string",
1477
- "minLength": 1,
1478
- "title": "Path",
1479
- "description": "Path or URL that the menu item should link to."
1480
- },
1481
- "translation_key": {
1482
- "type": "string",
1483
- "minLength": 1,
1484
- "title": "Label",
1485
- "description": "Label (or translation key) for the link."
1486
- }
1487
- }
1488
- },
1489
- "breadcrumb_item": {
1490
- "type": "object",
1491
- "title": "Breadcrumb item",
1492
- "properties": {
1493
- "path": {
1494
- "type": "string",
1495
- "minLength": 1,
1496
- "title": "Path",
1497
- "description": "Path or URL that the breadcrumb item should link to."
1498
- },
1499
- "label": {
1500
- "type": "string",
1501
- "minLength": 1,
1502
- "title": "Label",
1503
- "description": "Label (or translation key) for the breadcrumb item."
1504
- }
1505
- }
1506
- },
1507
- "title_and_description": {
1508
- "type": "object",
1509
- "properties": {
1510
- "title": {
1511
- "type": "string",
1512
- "title": "Title"
1513
- },
1514
- "description": {
1515
- "type": "string",
1516
- "title": "Description",
1517
- "format": "markdown"
1518
- }
1519
- }
1520
- },
1521
- "map_style": {
1522
- "properties": {
1523
- "weight": {
1524
- "type": "number",
1525
- "title": "Weight",
1526
- "description": "The weight (boldness) of boundary borders."
1527
- },
1528
- "opacity": {
1529
- "type": "number",
1530
- "title": "Opacity",
1531
- "description": "The opacity of the boundary borders (between 0 and 1)."
1532
- },
1533
- "fillOpacity": {
1534
- "type": "number",
1535
- "title": "Fill opacity",
1536
- "description": "The opacity of the boundaries' background color (between 0 and 1)."
1537
- },
1538
- "color": {
1539
- "type": "string",
1540
- "format": "color",
1541
- "title": "Color",
1542
- "description": "The color of the boundary borders."
1543
- },
1544
- "dashArray": {
1545
- "type": "string",
1546
- "title": "Dash array",
1547
- "description": "A 'dash array' describing the boundary as dashed lines."
1548
- }
1549
- }
1550
- },
1551
- "config_form_options": {
1552
- "type": "object",
1553
- "properties": {
1554
- "enabled": {
1555
- "type": "boolean",
1556
- "title": "Enable this type of form",
1557
- "description": "If enabled, this type of configuration form will be available.",
1558
- "format": "checkbox"
1559
- },
1560
- "dropdowns": {
1561
- "type": "array",
1562
- "title": "Dropdown lists",
1563
- "description": "Set options for any dropdown lists.",
1564
- "items": {
1565
- "type": "object",
1566
- "title": "Dropdown list",
1567
- "properties": {
1568
- "jsonschema": {
1569
- "type": "string",
1570
- "title": "JSONSchema path",
1571
- "description": "The jsonschema path to the dropdown field."
1572
- },
1573
- "values": {
1574
- "type": "array",
1575
- "title": "Values",
1576
- "description": "List of dropdown option values",
1577
- "items": {
1578
- "type": "string",
1579
- "title": "Value"
1580
- }
1581
- },
1582
- "labels": {
1583
- "type": "array",
1584
- "title": "Labels",
1585
- "description": "Optional list of dropdown option labels. Should correspond to the values above.",
1586
- "items": {
1587
- "type": "string",
1588
- "title": "Label"
1589
- }
1590
- }
1591
- }
1592
- }
1593
- },
1594
- "repository_link": {
1595
- "type": "string",
1596
- "title": "Repository link",
1597
- "description": "The URL pattern of the 'Go to repository' link on the configuration page."
1598
- },
1599
- "translation_link": {
1600
- "type": "string",
1601
- "title": "Translation link",
1602
- "description": "The URL pattern for all 'Go to translation' links on the configuration page."
1603
- }
1604
- }
1605
- }
1606
- }
1607
- }
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. These are optional, and you don't have to use all of them. Typically you would just use one, such as the 'ua' option.",
35
+ "properties": {
36
+ "ua": {
37
+ "type": "string",
38
+ "title": "Universal Analytics (ua) tracking ID",
39
+ "description": "The tracking ID for the analytics.js approach, for your property on Google Analytics. Typically starts with 'UA-'."
40
+ },
41
+ "gtag": {
42
+ "type": "string",
43
+ "title": "gtag.js (gtag) tracking ID",
44
+ "description": "The tracking ID for the gtag.js approach, for your property on Google Analytics. Typically starts with 'G-'."
45
+ },
46
+ "gtm": {
47
+ "type": "string",
48
+ "title": "Google Tag Manager (gtm) tracking ID",
49
+ "description": "Your tracking ID for Google Tag Manager. Typically starts with 'GTM-'. Though this is included as an analytics approach, it requires additional configuration within Google Tag Manager in order to capture analytics."
50
+ }
51
+ },
52
+ "links": [
53
+ {
54
+ "rel": "More information on the analytics setting",
55
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#analytics"
56
+ }
57
+ ]
58
+ },
59
+ "bootstrap_5": {
60
+ "title": "Bootstrap 5",
61
+ "type": "boolean",
62
+ "description": "This setting can be set to `true` to enable Bootstrap 5. Importantly, this will automatically be set to 'true' in Open SDG 2.0.0.",
63
+ "format": "checkbox",
64
+ "links": [
65
+ {
66
+ "rel": "More information on the bootstrap_5 setting",
67
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#bootstrap_5"
68
+ }
69
+ ]
70
+ },
71
+ "breadcrumbs": {
72
+ "options": {"collapsed": true},
73
+ "type": "object",
74
+ "title": "Breadcrumbs",
75
+ "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.",
76
+ "properties": {
77
+ "goal": {
78
+ "options": {"collapsed": true},
79
+ "type": "array",
80
+ "title": "Goal breadcrumbs",
81
+ "description": "The breadcrumb items for goal pages.",
82
+ "items": {
83
+ "$ref": "#/definitions/breadcrumb_item"
84
+ }
85
+ },
86
+ "indicator": {
87
+ "options": {"collapsed": true},
88
+ "type": "array",
89
+ "title": "Indicator breadcrumbs",
90
+ "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.",
91
+ "items": {
92
+ "$ref": "#/definitions/breadcrumb_item"
93
+ }
94
+ },
95
+ "post": {
96
+ "options": {"collapsed": true},
97
+ "type": "array",
98
+ "title": "Post breadcrumbs",
99
+ "description": "The breadcrumb items for post pages.",
100
+ "items": {
101
+ "$ref": "#/definitions/breadcrumb_item"
102
+ }
103
+ }
104
+ },
105
+ "links": [
106
+ {
107
+ "rel": "More information on the breadcrumbs setting",
108
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#breadcrumbs"
109
+ }
110
+ ]
111
+ },
112
+ "chartjs_3": {
113
+ "title": "Chart.js 3",
114
+ "type": "boolean",
115
+ "description": "This setting can be set to `true` to enable Chart.js 3. Importantly, this will automatically be set to 'true' in Open SDG 2.0.0.",
116
+ "format": "checkbox",
117
+ "links": [
118
+ {
119
+ "rel": "More information on the chartjs_3 setting",
120
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#chartjs_3"
121
+ }
122
+ ]
123
+ },
124
+ "contrast_type": {
125
+ "type": "string",
126
+ "title": "Contrast type",
127
+ "description": "The type of high-contrast toggle to use.",
128
+ "enum": ["default", "single", "long"],
129
+ "options": {
130
+ "enum_titles": [
131
+ "Default - two 'A' buttons side-by-side",
132
+ "Single - one 'A' button which toggles on/off",
133
+ "Long - text toggling between 'High contrast' and 'Default contrast'"
134
+ ]
135
+ },
136
+ "links": [
137
+ {
138
+ "rel": "More information on the contrast type setting",
139
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#contrast_type"
140
+ }
141
+ ]
142
+ },
143
+ "cookie_consent_form": {
144
+ "options": {"collapsed": true},
145
+ "type": "object",
146
+ "title": "Cookie consent form",
147
+ "description": "A cookie consent form for users",
148
+ "properties": {
149
+ "enabled": {
150
+ "type": "boolean",
151
+ "title": "Enabled",
152
+ "description": "Whether the cookie consent form will be enabled",
153
+ "format": "checkbox"
154
+ }
155
+ },
156
+ "links": [
157
+ {
158
+ "rel": "More information on the cookie_consent_form setting",
159
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#cookie_consent_form"
160
+ }
161
+ ]
162
+ },
163
+ "country": {
164
+ "options": {"collapsed": true},
165
+ "type": "object",
166
+ "title": "Country information",
167
+ "description": "Information about your country (or region, locality, etc.)",
168
+ "properties": {
169
+ "name": {
170
+ "type": "string",
171
+ "title": "Name",
172
+ "description": "The name of your country/region/locality/etc.",
173
+ "minLength": 1
174
+ },
175
+ "adjective": {
176
+ "type": "string",
177
+ "title": "Adjective",
178
+ "description": "Adjective form of your country/region/locality/etc.",
179
+ "minLength": 1
180
+ }
181
+ },
182
+ "links": [
183
+ {
184
+ "rel": "More information on the country setting",
185
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#country"
186
+ }
187
+ ]
188
+ },
189
+ "create_goals": {
190
+ "options": {"collapsed": true},
191
+ "type": "object",
192
+ "title": "Create goals",
193
+ "description": "This setting can be used to automatically create the goal pages.",
194
+ "properties": {
195
+ "layout": {
196
+ "type": "string",
197
+ "title": "Layout",
198
+ "enum": [
199
+ "",
200
+ "goal",
201
+ "goal-by-target",
202
+ "goal-by-target-vertical",
203
+ "goal-with-progress"
204
+ ],
205
+ "options": {
206
+ "enum_titles": [
207
+ "Do not automatically create goals",
208
+ "goal",
209
+ "goal-by-target",
210
+ "goal-by-target-vertical",
211
+ "goal-with-progress"
212
+ ]
213
+ },
214
+ "description": "The layout to use for the goal pages."
215
+ },
216
+ "previous_next_links": {
217
+ "title": "Previous/next links",
218
+ "type": "boolean",
219
+ "description": "This setting can be used to show navigation links to the previous/next goals.",
220
+ "format": "checkbox"
221
+ },
222
+ "goals": {
223
+ "options": {"collapsed": true},
224
+ "type": "array",
225
+ "title": "Content per goal",
226
+ "description": "This setting can be used to enter details for each goal.",
227
+ "items": {
228
+ "type": "object",
229
+ "title": "Goal",
230
+ "properties": {
231
+ "content": {
232
+ "type": "string",
233
+ "title": "Content",
234
+ "format": "markdown",
235
+ "description": "Markdown content or a translation key for this goal."
236
+ }
237
+ }
238
+ }
239
+ }
240
+ },
241
+ "links": [
242
+ {
243
+ "rel": "More information on the create goals setting",
244
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_goals"
245
+ }
246
+ ]
247
+ },
248
+ "create_indicators": {
249
+ "options": {"collapsed": true},
250
+ "type": "object",
251
+ "title": "Create indicators",
252
+ "description": "This setting can be used to automatically create the indicator pages.",
253
+ "properties": {
254
+ "layout": {
255
+ "type": "string",
256
+ "title": "Layout",
257
+ "enum": [
258
+ "",
259
+ "indicator"
260
+ ],
261
+ "options": {
262
+ "enum_titles": [
263
+ "Do not automatically create indicators",
264
+ "indicator"
265
+ ]
266
+ },
267
+ "description": "The layout to use for the indicator pages."
268
+ },
269
+ "previous_next_links": {
270
+ "title": "Previous/next links",
271
+ "type": "boolean",
272
+ "description": "This setting can be used to show navigation links to the previous/next indicators.",
273
+ "format": "checkbox"
274
+ }
275
+ },
276
+ "links": [
277
+ {
278
+ "rel": "More information on the create indicators setting",
279
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_indicators"
280
+ }
281
+ ]
282
+ },
283
+ "create_pages": {
284
+ "options": {"collapsed": true},
285
+ "type": "array",
286
+ "title": "Create pages",
287
+ "description": "This setting can be used to automatically create the pages.",
288
+ "items": {
289
+ "type": "object",
290
+ "title": "Page",
291
+ "properties": {
292
+ "filename": {
293
+ "type": "string",
294
+ "title": "Filename",
295
+ "description": "The filename for the page - usually 'index.html'."
296
+ },
297
+ "folder": {
298
+ "type": "string",
299
+ "minLength": 1,
300
+ "title": "Folder",
301
+ "description": "The folder path for the page."
302
+ },
303
+ "layout": {
304
+ "type": "string",
305
+ "minLength": 1,
306
+ "title": "Layout",
307
+ "description": "The layout to use for the page."
308
+ },
309
+ "title": {
310
+ "type": "string",
311
+ "title": "Title",
312
+ "description": "The page title for the page."
313
+ }
314
+ }
315
+ },
316
+ "links": [
317
+ {
318
+ "rel": "More information on the create pages setting",
319
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#create_pages"
320
+ }
321
+ ]
322
+ },
323
+ "custom_css": {
324
+ "options": {"collapsed": true},
325
+ "type": "array",
326
+ "title": "Custom CSS files",
327
+ "description": "Deprecated: instead of using this, it is recommended to put custom CSS in a _sass/custom.scss file.",
328
+ "items": {
329
+ "type": "string",
330
+ "title": "Custom CSS file"
331
+ },
332
+ "links": [
333
+ {
334
+ "rel": "More information on the custom CSS setting",
335
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_css"
336
+ }
337
+ ]
338
+ },
339
+ "custom_js": {
340
+ "options": {"collapsed": true},
341
+ "type": "array",
342
+ "title": "Custom JavaScript files",
343
+ "description": "This setting can be used to load additional JavaScript files on each page.",
344
+ "items": {
345
+ "type": "string",
346
+ "title": "Custom JavaScript file"
347
+ },
348
+ "links": [
349
+ {
350
+ "rel": "More information on the custom JS setting",
351
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#custom_js"
352
+ }
353
+ ]
354
+ },
355
+ "data_edit_url": {
356
+ "type": "string",
357
+ "title": "Data edit URL",
358
+ "description": "This setting controls the URL of the 'Edit Data' buttons that appear on the staging site's indicator pages.",
359
+ "links": [
360
+ {
361
+ "rel": "More information on the data edit URL setting",
362
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_edit_url"
363
+ }
364
+ ]
365
+ },
366
+ "data_fields": {
367
+ "options": {"collapsed": true},
368
+ "type": "object",
369
+ "title": "Data fields",
370
+ "description": "Control the names of fields used for special purposes in data.",
371
+ "properties": {
372
+ "units": {
373
+ "type": "string",
374
+ "title": "Units",
375
+ "description": "Field to reserve for units of measurement. Defaults to 'Units'."
376
+ },
377
+ "series": {
378
+ "type": "string",
379
+ "title": "Series",
380
+ "description": "Field to reserve for the SDG series. Defaults to 'Series'."
381
+ }
382
+ },
383
+ "links": [
384
+ {
385
+ "rel": "More information on the data fields setting",
386
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#data_fields"
387
+ }
388
+ ]
389
+ },
390
+ "date_formats": {
391
+ "options": {"collapsed": true},
392
+ "type": "array",
393
+ "title": "Date formats",
394
+ "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.",
395
+ "items": {
396
+ "type": "object",
397
+ "title": "Date format",
398
+ "properties": {
399
+ "type": {
400
+ "type": "string",
401
+ "minLength": 1,
402
+ "title": "Type",
403
+ "description": "Use `standard` for news/post dates."
404
+ },
405
+ "language": {
406
+ "type": "string",
407
+ "minLength": 1,
408
+ "title": "Language",
409
+ "description": "Language code the format applies to."
410
+ },
411
+ "format": {
412
+ "type": "string",
413
+ "minLength": 1,
414
+ "title": "Format",
415
+ "description": "Ruby DateTime date format."
416
+ }
417
+ }
418
+ },
419
+ "links": [
420
+ {
421
+ "rel": "More information on the date formats setting",
422
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#date_formats"
423
+ }
424
+ ]
425
+ },
426
+ "disclaimer": {
427
+ "options": {"collapsed": true},
428
+ "type": "object",
429
+ "title": "Disclaimer",
430
+ "description": "This setting controls the content of the disclaimer that appears at the top of each page.",
431
+ "properties": {
432
+ "phase": {
433
+ "type": "string",
434
+ "title": "Phase",
435
+ "description": "The development phase of your platform (alpha, beta, etc.)"
436
+ },
437
+ "message": {
438
+ "type": "string",
439
+ "title": "Message",
440
+ "description": "A short disclaimer message."
441
+ },
442
+ "hidden": {
443
+ "type": "boolean",
444
+ "title": "Hidden",
445
+ "description": "Hide the disclaimer.",
446
+ "format": "checkbox"
447
+ }
448
+ },
449
+ "links": [
450
+ {
451
+ "rel": "More information on the disclaimer setting",
452
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#disclaimer"
453
+ }
454
+ ]
455
+ },
456
+ "email_contacts": {
457
+ "options": {"collapsed": true},
458
+ "type": "object",
459
+ "title": "Email addresses",
460
+ "description": "Email addresses to publish on your platform.",
461
+ "properties": {
462
+ "questions": {
463
+ "type": "string",
464
+ "minLength": 1,
465
+ "format": "email",
466
+ "title": "Questions",
467
+ "description": "Inbox for questions about your platform."
468
+ },
469
+ "suggestions": {
470
+ "type": "string",
471
+ "minLength": 1,
472
+ "format": "email",
473
+ "title": "Suggestions",
474
+ "description": "Inbox for suggestions for your platform."
475
+ },
476
+ "functional": {
477
+ "type": "string",
478
+ "minLength": 1,
479
+ "format": "email",
480
+ "title": "Functional",
481
+ "description": "Inbox for bug reports for your platform."
482
+ }
483
+ },
484
+ "links": [
485
+ {
486
+ "rel": "More information on the email contacts setting",
487
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#email_contacts"
488
+ }
489
+ ]
490
+ },
491
+ "environment": {
492
+ "type": "string",
493
+ "minLength": 1,
494
+ "title": "Environment",
495
+ "description": "Which environment (staging or production) this configuration is for.",
496
+ "enum": ["staging", "production"],
497
+ "links": [
498
+ {
499
+ "rel": "More information on the environment setting",
500
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#environment"
501
+ }
502
+ ]
503
+ },
504
+ "favicons": {
505
+ "type": "string",
506
+ "title": "Favicons",
507
+ "description": "The type of favicons to use.",
508
+ "enum": ["legacy", "favicon.io"],
509
+ "options": {
510
+ "enum_titles": [
511
+ "Legacy",
512
+ "Favicon.io (recommended)"
513
+ ]
514
+ },
515
+ "links": [
516
+ {
517
+ "rel": "More information on the favicons setting",
518
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#favicons"
519
+ }
520
+ ]
521
+ },
522
+ "footer_language_toggle": {
523
+ "type": "string",
524
+ "title": "Footer language toggle",
525
+ "description": "This setting controls the type of language toggle to be used in the footer.",
526
+ "enum": ["none", "dropdown", "links"],
527
+ "links": [
528
+ {
529
+ "rel": "More information on the footer language toggle setting",
530
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_language_toggle"
531
+ }
532
+ ]
533
+ },
534
+ "footer_menu": {
535
+ "options": {"collapsed": true},
536
+ "type": "array",
537
+ "title": "Footer menu",
538
+ "description": "The links to display in the footer menu.",
539
+ "items": {
540
+ "$ref": "#/definitions/menu_item"
541
+ },
542
+ "links": [
543
+ {
544
+ "rel": "More information on the footer menu setting",
545
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#footer_menu"
546
+ }
547
+ ]
548
+ },
549
+ "frontpage_cards": {
550
+ "options": {"collapsed": true},
551
+ "type": "array",
552
+ "title": "Frontpage cards",
553
+ "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.",
554
+ "items": {
555
+ "type": "object",
556
+ "title": "Frontpage card",
557
+ "properties": {
558
+ "title": {
559
+ "type": "string",
560
+ "minLength": 1,
561
+ "title": "Title",
562
+ "description": "The card's title."
563
+ },
564
+ "content": {
565
+ "type": "string",
566
+ "title": "Content",
567
+ "description": "The card's content.",
568
+ "format": "markdown"
569
+ },
570
+ "include": {
571
+ "type": "string",
572
+ "title": "Include file",
573
+ "description": "A Jekyll include file to place inside the card."
574
+ },
575
+ "button_label": {
576
+ "type": "string",
577
+ "title": "Button label",
578
+ "description": "A label for a button to display at the bottom of the card."
579
+ },
580
+ "button_link": {
581
+ "type": "string",
582
+ "title": "Button link",
583
+ "description": "A path or URL for the card's button to link to."
584
+ },
585
+ "rule_color": {
586
+ "type": "string",
587
+ "title": "Rule color",
588
+ "description": "The color of the horizontal line appearing above the card."
589
+ }
590
+ }
591
+ },
592
+ "links": [
593
+ {
594
+ "rel": "More information on the frontpage cards setting",
595
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_cards"
596
+ }
597
+ ]
598
+ },
599
+ "frontpage_goals_grid": {
600
+ "options": {"collapsed": true},
601
+ "type": "object",
602
+ "title": "Frontpage goals grid",
603
+ "description": "This setting is only used in the frontpage-alt layout. It can display a title and description above the grid of goal tiles.",
604
+ "$ref": "#/definitions/title_and_description",
605
+ "links": [
606
+ {
607
+ "rel": "More information on the frontpage goals grid setting",
608
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_goals_grid"
609
+ }
610
+ ]
611
+ },
612
+ "frontpage_heading": {
613
+ "type": "string",
614
+ "title": "Frontpage heading",
615
+ "description": "This setting can control the heading that appears on the front page. This setting is only used in the frontpage layout.",
616
+ "links": [
617
+ {
618
+ "rel": "More information on the frontpage heading setting",
619
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_heading"
620
+ }
621
+ ]
622
+ },
623
+ "frontpage_instructions": {
624
+ "type": "string",
625
+ "title": "Frontpage instructions",
626
+ "description": "This setting can control the instructions that appear on the front page. This setting is only used in the frontpage layout.",
627
+ "links": [
628
+ {
629
+ "rel": "More information on the frontpage instructions setting",
630
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_instructions"
631
+ }
632
+ ]
633
+ },
634
+ "frontpage_introduction_banner": {
635
+ "options": {"collapsed": true},
636
+ "type": "object",
637
+ "title": "Frontpage introduction banner",
638
+ "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.",
639
+ "$ref": "#/definitions/title_and_description",
640
+ "links": [
641
+ {
642
+ "rel": "More information on the frontpage introduction banner setting",
643
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#frontpage_introduction_banner"
644
+ }
645
+ ]
646
+ },
647
+ "goal_image_base": {
648
+ "type": "string",
649
+ "minLength": 1,
650
+ "title": "Goal image base URL",
651
+ "description": "This setting controls the base URL for downloading the imagery for the goals.",
652
+ "links": [
653
+ {
654
+ "rel": "More information on the goal image base setting",
655
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_base"
656
+ }
657
+ ]
658
+ },
659
+ "goal_image_extension": {
660
+ "type": "string",
661
+ "title": "Goal image extension",
662
+ "description": "This setting controls the type of file (the file extension) that will be used for the goal images.",
663
+ "links": [
664
+ {
665
+ "rel": "More information on the goal image extension setting",
666
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goal_image_extension"
667
+ }
668
+ ]
669
+ },
670
+ "goals_page": {
671
+ "options": {"collapsed": true},
672
+ "type": "object",
673
+ "title": "Goals page",
674
+ "description": "This setting is used in the 'goals' layout. It can display a title and description above the grid of goal tiles.",
675
+ "$ref": "#/definitions/title_and_description",
676
+ "links": [
677
+ {
678
+ "rel": "More information on the goals page setting",
679
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#goals_page"
680
+ }
681
+ ]
682
+ },
683
+ "graph_color_headline": {
684
+ "type": "string",
685
+ "format": "color",
686
+ "title": "Graph color for headline",
687
+ "default": "#004466",
688
+ "description": "This setting can be used to customize the color used in the chart 'headlines'.",
689
+ "examples": [],
690
+ "links": [
691
+ {
692
+ "rel": "More information on the graph color headline setting",
693
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_headline"
694
+ }
695
+ ]
696
+ },
697
+ "graph_color_headline_high_contrast": {
698
+ "type": "string",
699
+ "format": "color",
700
+ "title": "Graph color for headline - high-contrast",
701
+ "default": "#55a6e5",
702
+ "description": "This setting can be used to customize the color used in the chart 'headlines' in high-contrast mode.",
703
+ "examples": [],
704
+ "links": [
705
+ {
706
+ "rel": "More information on the graph color headline high-contrast setting",
707
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_headline_high_contrast"
708
+ }
709
+ ]
710
+ },
711
+ "graph_color_set": {
712
+ "type": "string",
713
+ "title": "Graph color set",
714
+ "description": "This setting can be used to customize the color set used in the charts.",
715
+ "examples": [],
716
+ "enum": ["default", "accessible", "sdg", "goal", "custom"],
717
+ "links": [
718
+ {
719
+ "rel": "More information on the graph color set setting",
720
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_set"
721
+ }
722
+ ]
723
+ },
724
+ "graph_color_list": {
725
+ "options": {"collapsed": true},
726
+ "type": "array",
727
+ "title": "Graph color list",
728
+ "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'.",
729
+ "items": {
730
+ "type": "string",
731
+ "format": "color",
732
+ "title": "Color",
733
+ "description": "Hexadecimal color code"
734
+ },
735
+ "links": [
736
+ {
737
+ "rel": "More information on the graph color list setting",
738
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_list"
739
+ }
740
+ ]
741
+ },
742
+ "graph_color_number": {
743
+ "title": "Graph color number",
744
+ "type": "integer",
745
+ "description": "This setting can be used to limit the length of the list of colors selected via graph_color_set.",
746
+ "links": [
747
+ {
748
+ "rel": "More information on the graph color number setting",
749
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_color_number"
750
+ }
751
+ ]
752
+ },
753
+ "graph_title_from_series": {
754
+ "title": "Graph title from series",
755
+ "type": "boolean",
756
+ "description": "This setting can be set to `true` to use the selected series for the graph title, whenever possible.",
757
+ "format": "checkbox",
758
+ "links": [
759
+ {
760
+ "rel": "More information on the graph title from series setting",
761
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#graph_title_from_series"
762
+ }
763
+ ]
764
+ },
765
+ "header": {
766
+ "options": {"collapsed": true},
767
+ "type": "object",
768
+ "title": "Header",
769
+ "description": "This setting can be used to customise the header.",
770
+ "properties": {
771
+ "include": {
772
+ "type": "string",
773
+ "title": "Include file",
774
+ "enum": [
775
+ "header-default.html",
776
+ "header-menu-left-aligned.html"
777
+ ],
778
+ "options": {
779
+ "enum_titles": [
780
+ "Default header",
781
+ "Menu left-aligned"
782
+ ]
783
+ },
784
+ "description": "The header style to use on all pages."
785
+ }
786
+ },
787
+ "links": [
788
+ {
789
+ "rel": "More information on the header setting",
790
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header"
791
+ }
792
+ ]
793
+ },
794
+ "header_language_toggle": {
795
+ "type": "string",
796
+ "title": "Header language toggle",
797
+ "description": "This setting controls the type of language toggle to be used in the header.",
798
+ "enum": ["none", "dropdown", "links"],
799
+ "links": [
800
+ {
801
+ "rel": "More information on the header language toggle setting",
802
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#header_language_toggle"
803
+ }
804
+ ]
805
+ },
806
+ "hide_empty_metadata": {
807
+ "title": "Hide empty metadata",
808
+ "type": "boolean",
809
+ "description": "This setting can be used to hide any metadata fields that are empty.",
810
+ "format": "checkbox",
811
+ "links": [
812
+ {
813
+ "rel": "More information on the hide empty metadata setting",
814
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_empty_metadata"
815
+ }
816
+ ]
817
+ },
818
+ "hide_single_series": {
819
+ "title": "Hide single series",
820
+ "type": "boolean",
821
+ "description": "This setting can be used to hide the 'Series' toggle on indicators where there is only one choice.",
822
+ "format": "checkbox",
823
+ "links": [
824
+ {
825
+ "rel": "More information on the hide single series setting",
826
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_series"
827
+ }
828
+ ]
829
+ },
830
+ "hide_single_unit": {
831
+ "title": "Hide single unit",
832
+ "type": "boolean",
833
+ "description": "This setting can be used to hide the 'Unit' toggle on indicators where there is only one choice.",
834
+ "format": "checkbox",
835
+ "links": [
836
+ {
837
+ "rel": "More information on the hide single unit setting",
838
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#hide_single_unit"
839
+ }
840
+ ]
841
+ },
842
+ "indicator_config_form": {
843
+ "options": {"collapsed": true},
844
+ "type": "object",
845
+ "title": "Indicator configuration form",
846
+ "description": "Configuration of the indicator configuration form.",
847
+ "$ref": "#/definitions/config_form_options"
848
+ },
849
+ "indicator_data_form": {
850
+ "options": {"collapsed": true},
851
+ "type": "object",
852
+ "title": "Indicator data form",
853
+ "description": "Configuration of the indicator data form.",
854
+ "properties": {
855
+ "enabled": {
856
+ "type": "boolean",
857
+ "title": "Enable this type of form",
858
+ "description": "If enabled, the indicator data form will be available.",
859
+ "format": "checkbox"
860
+ },
861
+ "repository_link": {
862
+ "type": "string",
863
+ "title": "Repository link",
864
+ "description": "The URL pattern of the 'Go to repository' link on the configuration page."
865
+ }
866
+ }
867
+ },
868
+ "indicator_metadata_form": {
869
+ "options": {"collapsed": true},
870
+ "type": "object",
871
+ "title": "Indicator metadata form",
872
+ "description": "Configuration of the indicator metadata form.",
873
+ "allOf": [
874
+ { "$ref": "#/definitions/config_form_options" },
875
+ {
876
+ "properties": {
877
+ "language": {
878
+ "type": "string",
879
+ "title": "Language for editing",
880
+ "description": "Choose the language you prefer when editing metadata. This is used to translate the labels of the metadata fields."
881
+ },
882
+ "scopes": {
883
+ "options": {"collapsed": true},
884
+ "type": "array",
885
+ "title": "Metadata scopes",
886
+ "description": "Specify the 'scopes' of metadata to include on the form. Eg: 'national' or 'global'.",
887
+ "items": {
888
+ "type": "string",
889
+ "title": "Scope"
890
+ }
891
+ },
892
+ "exclude_fields": {
893
+ "options": {"collapsed": true},
894
+ "type": "array",
895
+ "title": "Exclude fields",
896
+ "description": "Specify any fields you would like to exclude from the form.",
897
+ "items": {
898
+ "type": "string",
899
+ "title": "Field"
900
+ }
901
+ },
902
+ "translated": {
903
+ "type": "boolean",
904
+ "title": "Display translated contents in the form",
905
+ "description": "This should only be enabled if you are using the 'subfolder' approach for your metadata.",
906
+ "format": "checkbox"
907
+ }
908
+ }
909
+ }
910
+ ]
911
+ },
912
+ "indicator_tabs": {
913
+ "options": {"collapsed": true},
914
+ "type": "object",
915
+ "title": "Indicator tabs",
916
+ "description": "Assign content for the indicator tabs.",
917
+ "properties": {
918
+ "tab_1": {
919
+ "type": "string",
920
+ "title": "Tab 1",
921
+ "description": "What to display in the first tab",
922
+ "$ref": "#/definitions/indicator_tabs_options"
923
+ },
924
+ "tab_2": {
925
+ "type": "string",
926
+ "title": "Tab 2",
927
+ "description": "What to display in the second tab",
928
+ "$ref": "#/definitions/indicator_tabs_options"
929
+ },
930
+ "tab_3": {
931
+ "type": "string",
932
+ "title": "Tab 3",
933
+ "description": "What to display in the third tab",
934
+ "$ref": "#/definitions/indicator_tabs_options"
935
+ },
936
+ "tab_4": {
937
+ "type": "string",
938
+ "title": "Tab 4",
939
+ "description": "What to display in the fourth tab",
940
+ "$ref": "#/definitions/indicator_tabs_options"
941
+ }
942
+ }
943
+ },
944
+ "languages": {
945
+ "options": {"collapsed": true},
946
+ "type": "array",
947
+ "minItems": 1,
948
+ "title": "Languages",
949
+ "description": "This setting controls the languages to be used on the site.",
950
+ "items": {
951
+ "type": "string",
952
+ "minLength": 1,
953
+ "title": "Language"
954
+ },
955
+ "links": [
956
+ {
957
+ "rel": "More information on the languages setting",
958
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages"
959
+ }
960
+ ]
961
+ },
962
+ "languages_public": {
963
+ "options": {"collapsed": true},
964
+ "type": "array",
965
+ "title": "Language code overrides",
966
+ "description": "This setting can be used if you are not happy with any of the standard language codes.",
967
+ "items": {
968
+ "type": "object",
969
+ "title": "Language override",
970
+ "properties": {
971
+ "language": {
972
+ "type": "string",
973
+ "minLength": 1,
974
+ "title": "Language",
975
+ "description": "The (standard) language code that you would like to override."
976
+ },
977
+ "language_public": {
978
+ "type": "string",
979
+ "minLength": 1,
980
+ "title": "Language override",
981
+ "description": "The (non-standard) language code that you would like show the public instead."
982
+ }
983
+ }
984
+ },
985
+ "links": [
986
+ {
987
+ "rel": "More information on the language override setting",
988
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#languages_public"
989
+ }
990
+ ]
991
+ },
992
+ "logos": {
993
+ "options": {"collapsed": true},
994
+ "type": "array",
995
+ "title": "Logos",
996
+ "description": "This setting can be used to control the main logo (or logos).",
997
+ "items": {
998
+ "type": "object",
999
+ "title": "Logo",
1000
+ "properties": {
1001
+ "language": {
1002
+ "type": "string",
1003
+ "title": "Language",
1004
+ "description": "The language on which this logo displays. Leave blank to show on all."
1005
+ },
1006
+ "src": {
1007
+ "type": "string",
1008
+ "minLength": 1,
1009
+ "title": "Image file",
1010
+ "description": "The image file (path or URL) for this logo"
1011
+ },
1012
+ "alt": {
1013
+ "type": "string",
1014
+ "minLength": 1,
1015
+ "title": "Alt text",
1016
+ "description": "The alt text for this logo"
1017
+ }
1018
+ }
1019
+ },
1020
+ "links": [
1021
+ {
1022
+ "rel": "More information on the logos setting",
1023
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#logos"
1024
+ }
1025
+ ]
1026
+ },
1027
+ "map_layers": {
1028
+ "options": {"collapsed": true},
1029
+ "type": "array",
1030
+ "title": "Map layers",
1031
+ "description": "Configure any number of layers to display on all indicator maps. A minimum of one layer is required to display maps.",
1032
+ "items": {
1033
+ "type": "object",
1034
+ "title": "Map layer",
1035
+ "properties": {
1036
+ "subfolder": {
1037
+ "type": "string",
1038
+ "title": "Subfolder",
1039
+ "description": "The subfolder under 'geojson' in the data repository holding the GeoJSON file for this layer."
1040
+ },
1041
+ "label": {
1042
+ "type": "string",
1043
+ "title": "Download button label",
1044
+ "description": "The label to use in the 'Download GeoJSON' button for this layer."
1045
+ },
1046
+ "min_zoom": {
1047
+ "type": "integer",
1048
+ "title": "Minimum zoom",
1049
+ "description": "This layer will only be visible when the map is zoomed to at least this number."
1050
+ },
1051
+ "max_zoom": {
1052
+ "type": "integer",
1053
+ "title": "Maximum zoom",
1054
+ "description": "The layer will not be visible when the map is zoomed beyond this number."
1055
+ },
1056
+ "staticBorders": {
1057
+ "type": "boolean",
1058
+ "format": "checkbox",
1059
+ "title": "Static borders",
1060
+ "description": "Whether the borders on this layer should remain visible when the map is zoomed past the maximum."
1061
+ }
1062
+ }
1063
+ },
1064
+ "links": [
1065
+ {
1066
+ "rel": "More information on the map layers setting",
1067
+ "href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_layers"
1068
+ }
1069
+ ]
1070
+ },
1071
+ "map_options": {
1072
+ "options": {"collapsed": true},
1073
+ "type": "object",
1074
+ "title": "Map options",
1075
+ "description": "Site-wide configuration of map behavior and style.",
1076
+ "properties": {
1077
+ "minZoom": {
1078
+ "title": "Minimum zoom",
1079
+ "type": "integer",
1080
+ "description": "The lowest amount of 'zoom' possible for users.",
1081
+ "default": 5
1082
+ },
1083
+ "maxZoom": {
1084
+ "title": "Maximum zoom",
1085
+ "type": "integer",
1086
+ "description": "The highest amount of 'zoom' possible for users.",
1087
+ "default": 10
1088
+ },
1089
+ "tileURL": {
1090
+ "title": "Tile URL",
1091
+ "type": "string",
1092
+ "format": "url",
1093
+ "description": "If you would like the maps to show tile imagery, add the URL here."
1094
+ },
1095
+ "tileOptions": {
1096
+ "title": "Tile options",
1097
+ "type": "object",
1098
+ "options": {"collapsed": true},
1099
+ "description": "Additional options for map tile imagery.",
1100
+ "properties": {
1101
+ "id": {
1102
+ "type": "string",
1103
+ "title": "Tile ID"
1104
+ },
1105
+ "accessToken": {
1106
+ "type": "string",
1107
+ "title": "Access token"
1108
+ },
1109
+ "attribution": {
1110
+ "type": "string",
1111
+ "title": "Attribution"
1112
+ }
1113
+ }
1114
+ },
1115
+ "colorRange": {
1116
+ "type": "string",
1117
+ "title": "Color range",
1118
+ "description": "The color range for the choropleth map.",
1119
+ "default": "chroma.brewer.BuGn",
1120
+ "links": [
1121
+ {
1122
+ "ref": "More information on the color range setting",
1123
+ "href": "https://gka.github.io/chroma.js/#chroma-brewer"
1124
+ }
1125
+ ]
1126
+ },
1127
+ "noValueColor": {
1128
+ "type": "string",
1129
+ "format": "color",
1130
+ "title": "No-value color",
1131
+ "description": "Color for boundaries that have no data.",
1132
+ "default": "#f0f0f0"
1133
+ },
1134
+ "styleNormal": {
1135
+ "type": "object",
1136
+ "title": "Style (normal)",
1137
+ "description": "Style for boundaries in normal state",
1138
+ "$ref": "#/definitions/map_style",
1139
+ "default": {
1140
+ "weight": 1,
1141
+ "opacity": 1,
1142
+ "fillOpacity": 0.7,
1143
+ "color": "#888888"
1144
+ }
1145
+ },
1146
+ "styleHighlighted": {
1147
+ "type": "object",
1148
+ "title": "Style (highlighted)",
1149
+ "description": "Style for boundaries in highlighted state",
1150
+ "$ref": "#/definitions/map_style",
1151
+ "default": {
1152
+ "weight": 1,
1153
+ "opacity": 1,
1154
+ "fillOpacity": 0.7,
1155
+ "color": "#111111"
1156
+ }
1157
+ },
1158
+ "styleStatic": {
1159
+ "type": "object",
1160
+ "title": "Style (static)",
1161
+ "description": "Style for boundaries in static state (map layers using the 'static boundaries' option).",
1162
+ "$ref": "#/definitions/map_style",
1163
+ "default": {
1164
+ "weight": 2,
1165
+ "opacity": 1,
1166
+ "fillOpacity": 0,
1167
+ "color": "#172d44",
1168
+ "dashArray": "5,5"
1169
+ }
1170
+ }
1171
+ },
1172
+ "links": [
1173
+ {
1174
+ "rel": "More information on the map options setting",
1175
+ "href": "https://open-sdg.readthedocs.io/en/latest/maps/#map_options"
1176
+ }
1177
+ ]
1178
+ },
1179
+ "menu": {
1180
+ "options": {"collapsed": true},
1181
+ "type": "array",
1182
+ "minItems": 1,
1183
+ "title": "Main menu",
1184
+ "description": "The links to display in the main menu.",
1185
+ "items": {
1186
+ "title": "Menu item",
1187
+ "allOf": [
1188
+ { "$ref": "#/definitions/menu_item" },
1189
+ {
1190
+ "properties": {
1191
+ "dropdown": {
1192
+ "title": "Dropdown menu",
1193
+ "type": "array",
1194
+ "description": "Enter menu items here to turn this into a dropdown.",
1195
+ "items": {
1196
+ "$ref": "#/definitions/menu_item",
1197
+ "title": "Dropdown menu item"
1198
+ }
1199
+ }
1200
+ }
1201
+ }
1202
+ ]
1203
+ },
1204
+ "links": [
1205
+ {
1206
+ "rel": "More information on the menu setting",
1207
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#menu"
1208
+ }
1209
+ ]
1210
+ },
1211
+ "metadata_edit_url": {
1212
+ "type": "string",
1213
+ "title": "Metadata edit URL",
1214
+ "description": "This setting controls the URL of the 'Edit Metadata' buttons that appear on the staging site's indicator pages.",
1215
+ "links": [
1216
+ {
1217
+ "rel": "More information on the metadata edit URL setting",
1218
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_edit_url"
1219
+ }
1220
+ ]
1221
+ },
1222
+ "metadata_tabs": {
1223
+ "options": {"collapsed": true},
1224
+ "type": "array",
1225
+ "title": "Metadata tabs",
1226
+ "description": "This setting can control the metadata tabs which appear on the indicator pages.",
1227
+ "items": {
1228
+ "type": "object",
1229
+ "title": "Metadata tab",
1230
+ "properties": {
1231
+ "scope": {
1232
+ "type": "string",
1233
+ "minLength": 1,
1234
+ "title": "Scope",
1235
+ "description": "This tab will contain fields in the specific `scope` in your data repository's metadata schema file (eg, `_prose.yml`)."
1236
+ },
1237
+ "title": {
1238
+ "type": "string",
1239
+ "minLength": 1,
1240
+ "title": "Title",
1241
+ "description": "The title of the metadata tab."
1242
+ },
1243
+ "description": {
1244
+ "type": "string",
1245
+ "title": "Description",
1246
+ "description": "A descriptive blurb to show at the top of the tab content.",
1247
+ "format": "markdown"
1248
+ }
1249
+ }
1250
+ },
1251
+ "links": [
1252
+ {
1253
+ "rel": "More information on the metadata tabs setting",
1254
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#metadata_tabs"
1255
+ }
1256
+ ]
1257
+ },
1258
+ "news": {
1259
+ "options": {"collapsed": true},
1260
+ "type": "object",
1261
+ "title": "News",
1262
+ "description": "Configuration related to news updates and posts.",
1263
+ "properties": {
1264
+ "category_links": {
1265
+ "title": "Category links",
1266
+ "type": "boolean",
1267
+ "description": "Whether you would like the 'categories' of posts to generate links to dedicated category pages.",
1268
+ "format": "checkbox"
1269
+ }
1270
+ },
1271
+ "links": [
1272
+ {
1273
+ "rel": "More information on the news setting",
1274
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#news"
1275
+ }
1276
+ ]
1277
+ },
1278
+ "non_global_metadata": {
1279
+ "type": "string",
1280
+ "title": "Non-global metadata",
1281
+ "description": "This setting can be used to control the text of the tab containing non-global metadata.",
1282
+ "links": [
1283
+ {
1284
+ "rel": "More information on the non-global metadata setting",
1285
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#non_global_metadata"
1286
+ }
1287
+ ]
1288
+ },
1289
+ "progress_status": {
1290
+ "options": {"collapsed": true},
1291
+ "type": "object",
1292
+ "title": "Progress status",
1293
+ "description": "This setting is used in the 'goal-with-progress' layout. It controls the behavior of progress status functionality.",
1294
+ "properties": {
1295
+ "status_heading": {
1296
+ "title": "Status heading",
1297
+ "type": "string",
1298
+ "description": "A heading to display before the progress status on indicator pages."
1299
+ },
1300
+ "status_types": {
1301
+ "options": {"collapsed": true},
1302
+ "type": "array",
1303
+ "title": "Status types",
1304
+ "description": "Controls the behavior and labels for the different progress status types.",
1305
+ "items": {
1306
+ "type": "object",
1307
+ "title": "Status type",
1308
+ "properties": {
1309
+ "value": {
1310
+ "type": "string",
1311
+ "minLength": 1,
1312
+ "title": "Value",
1313
+ "description": "The value of the status type, as it is set in the indicator configuration (eg, 'targetachieved')."
1314
+ },
1315
+ "label": {
1316
+ "type": "string",
1317
+ "title": "Label",
1318
+ "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.target_achieved')."
1319
+ },
1320
+ "image": {
1321
+ "type": "string",
1322
+ "title": "Image",
1323
+ "description": "The internal path to the image to use (if any) for this progress status."
1324
+ },
1325
+ "alt": {
1326
+ "type": "string",
1327
+ "title": "Alt",
1328
+ "description": "An alt tag for the image above."
1329
+ }
1330
+ }
1331
+ }
1332
+ }
1333
+ },
1334
+ "links": [
1335
+ {
1336
+ "rel": "More information on the progress status setting",
1337
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#progress_status"
1338
+ }
1339
+ ]
1340
+ },
1341
+ "remote_data_prefix": {
1342
+ "type": "string",
1343
+ "minLength": 1,
1344
+ "title": "Remote data prefix",
1345
+ "description": "Specify the URL of the 'data service' that is generated from your data repository.",
1346
+ "links": [
1347
+ {
1348
+ "rel": "More information on the remote data prefix setting",
1349
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#remote_data_prefix"
1350
+ }
1351
+ ]
1352
+ },
1353
+ "reporting_status": {
1354
+ "options": {"collapsed": true},
1355
+ "type": "object",
1356
+ "title": "Reporting status",
1357
+ "description": "This setting is used in the 'reportingstatus' layout. It can display a title and description above the reporting status page.",
1358
+ "allOf": [
1359
+ { "$ref": "#/definitions/title_and_description" },
1360
+ {
1361
+ "properties": {
1362
+ "disaggregation_tabs": {
1363
+ "title": "Disaggregation tabs",
1364
+ "type": "boolean",
1365
+ "description": "Whether or not to display disaggregation status tabs. If you enable this setting, you should also use 'expected_disaggregations' in your indicator configuration, in order to provide the disaggregation status report with useful metrics.",
1366
+ "format": "checkbox"
1367
+ },
1368
+ "status_types": {
1369
+ "options": {"collapsed": true},
1370
+ "type": "array",
1371
+ "title": "Status types",
1372
+ "description": "Controls the behavior and labels for the different reporting status types.",
1373
+ "items": {
1374
+ "type": "object",
1375
+ "title": "Status type",
1376
+ "properties": {
1377
+ "value": {
1378
+ "type": "string",
1379
+ "minLength": 1,
1380
+ "title": "Value",
1381
+ "description": "The value of the status type, as it is set in the indicator configuration (eg, 'complete')."
1382
+ },
1383
+ "label": {
1384
+ "type": "string",
1385
+ "minLength": 1,
1386
+ "title": "Label",
1387
+ "description": "The human-readable label for the status type. Can be a translation key (eg, 'status.reported_online')."
1388
+ },
1389
+ "hide_on_goal_pages": {
1390
+ "type": "boolean",
1391
+ "title": "Hide on goal pages",
1392
+ "description": "Whether to hide this status type on goal pages. Useful for the most commonly-occuring type.",
1393
+ "format": "checkbox"
1394
+ }
1395
+ }
1396
+ }
1397
+ }
1398
+ }
1399
+ }
1400
+ ],
1401
+ "links": [
1402
+ {
1403
+ "rel": "More information on the reporting status setting",
1404
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#reporting_status"
1405
+ }
1406
+ ]
1407
+ },
1408
+ "repository_url_data": {
1409
+ "type": "string",
1410
+ "title": "Repository URL - Data",
1411
+ "description": "The URL of your data repository, eg: https://github.com/my-github-org/data",
1412
+ "links": [
1413
+ {
1414
+ "rel": "More information on the data repository URL setting",
1415
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#repository_url_data"
1416
+ }
1417
+ ]
1418
+ },
1419
+ "repository_url_site": {
1420
+ "type": "string",
1421
+ "title": "Repository URL - Site",
1422
+ "description": "The URL of your site repository, eg: https://github.com/my-github-org/site",
1423
+ "links": [
1424
+ {
1425
+ "rel": "More information on the site repository URL setting",
1426
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#repository_url_site"
1427
+ }
1428
+ ]
1429
+ },
1430
+ "search_index_boost": {
1431
+ "options": {"collapsed": true},
1432
+ "type": "array",
1433
+ "title": "Search index boost",
1434
+ "description": "This setting can be used to give a boost to one or more fields in the search index.",
1435
+ "items": {
1436
+ "type": "object",
1437
+ "title": "Boost",
1438
+ "properties": {
1439
+ "field": {
1440
+ "type": "string",
1441
+ "minLength": 1,
1442
+ "title": "Field",
1443
+ "description": "Field to boost ('title', 'content', etc.)"
1444
+ },
1445
+ "boost": {
1446
+ "type": "integer",
1447
+ "minLength": 1,
1448
+ "title": "Boost",
1449
+ "description": "Higher boost means higher search ranking."
1450
+ }
1451
+ }
1452
+ },
1453
+ "links": [
1454
+ {
1455
+ "rel": "More information on the search index boost setting",
1456
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_boost"
1457
+ }
1458
+ ]
1459
+ },
1460
+ "search_index_extra_fields": {
1461
+ "options": {"collapsed": true},
1462
+ "type": "array",
1463
+ "title": "Search index extra fields",
1464
+ "description": "This setting can be used to index additional metadata fields in your indicators, for the purposes of affecting the site-wide search.",
1465
+ "items": {
1466
+ "type": "string",
1467
+ "title": "Extra field"
1468
+ },
1469
+ "links": [
1470
+ {
1471
+ "rel": "More information on the search index extra fields setting",
1472
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#search_index_extra_fields"
1473
+ }
1474
+ ]
1475
+ },
1476
+ "series_toggle": {
1477
+ "title": "Series toggle",
1478
+ "type": "boolean",
1479
+ "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.",
1480
+ "format": "checkbox",
1481
+ "links": [
1482
+ {
1483
+ "rel": "More information on the series toggle setting",
1484
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#series_toggle"
1485
+ }
1486
+ ]
1487
+ },
1488
+ "site_config_form": {
1489
+ "options": {"collapsed": true},
1490
+ "type": "object",
1491
+ "title": "Site configuration form",
1492
+ "description": "Configuration of the site configuration form.",
1493
+ "$ref": "#/definitions/config_form_options"
1494
+ },
1495
+ "time_series_attributes": {
1496
+ "options": {"collapsed": true},
1497
+ "type": "array",
1498
+ "title": "Time-series attributes",
1499
+ "description": "This setting can be used to specify data columns to be considered 'time-series attributes' and displayed in the footer.",
1500
+ "items": {
1501
+ "type": "object",
1502
+ "title": "Time-series attribute",
1503
+ "properties": {
1504
+ "field": {
1505
+ "type": "string",
1506
+ "minLength": 1,
1507
+ "title": "Field",
1508
+ "description": "Column name in the data."
1509
+ },
1510
+ "label": {
1511
+ "type": "string",
1512
+ "minLength": 1,
1513
+ "title": "Label",
1514
+ "description": "Label when displayed in the footer."
1515
+ }
1516
+ }
1517
+ },
1518
+ "links": [
1519
+ {
1520
+ "rel": "More information on the time series attributes setting",
1521
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#time_series_attributes"
1522
+ }
1523
+ ]
1524
+ },
1525
+ "validate_indicator_config": {
1526
+ "title": "Validate indicator config",
1527
+ "type": "boolean",
1528
+ "description": "If checked, this will require that all indicators have valid Open SDG indicator configuration.",
1529
+ "format": "checkbox",
1530
+ "links": [
1531
+ {
1532
+ "rel": "More information on the validate indicator config setting",
1533
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_indicator_config"
1534
+ }
1535
+ ]
1536
+ },
1537
+ "validate_site_config": {
1538
+ "title": "Validate site config",
1539
+ "type": "boolean",
1540
+ "description": "If checked, this will require valid site configuration.",
1541
+ "format": "checkbox",
1542
+ "links": [
1543
+ {
1544
+ "rel": "More information on the validate site config setting",
1545
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#validate_site_config"
1546
+ }
1547
+ ]
1548
+ },
1549
+ "x_axis_label": {
1550
+ "type": "string",
1551
+ "title": "X axis label",
1552
+ "description": "A label beneath the X axis on charts. This is overridden by the same indicator configuration setting.",
1553
+ "links": [
1554
+ {
1555
+ "rel": "More information on the X axis label setting",
1556
+ "href": "https://open-sdg.readthedocs.io/en/latest/configuration/#x_axis_label"
1557
+ }
1558
+ ]
1559
+ }
1560
+ },
1561
+ "additionalProperties": true,
1562
+ "definitions": {
1563
+ "menu_item": {
1564
+ "type": "object",
1565
+ "title": "Menu item",
1566
+ "properties": {
1567
+ "path": {
1568
+ "type": "string",
1569
+ "minLength": 1,
1570
+ "title": "Path",
1571
+ "description": "Path or URL that the menu item should link to."
1572
+ },
1573
+ "translation_key": {
1574
+ "type": "string",
1575
+ "minLength": 1,
1576
+ "title": "Label",
1577
+ "description": "Label (or translation key) for the link."
1578
+ }
1579
+ }
1580
+ },
1581
+ "breadcrumb_item": {
1582
+ "type": "object",
1583
+ "title": "Breadcrumb item",
1584
+ "properties": {
1585
+ "path": {
1586
+ "type": "string",
1587
+ "minLength": 1,
1588
+ "title": "Path",
1589
+ "description": "Path or URL that the breadcrumb item should link to."
1590
+ },
1591
+ "label": {
1592
+ "type": "string",
1593
+ "minLength": 1,
1594
+ "title": "Label",
1595
+ "description": "Label (or translation key) for the breadcrumb item."
1596
+ }
1597
+ }
1598
+ },
1599
+ "title_and_description": {
1600
+ "type": "object",
1601
+ "properties": {
1602
+ "title": {
1603
+ "type": "string",
1604
+ "title": "Title"
1605
+ },
1606
+ "description": {
1607
+ "type": "string",
1608
+ "title": "Description",
1609
+ "format": "markdown"
1610
+ }
1611
+ }
1612
+ },
1613
+ "map_style": {
1614
+ "properties": {
1615
+ "weight": {
1616
+ "type": "number",
1617
+ "title": "Weight",
1618
+ "description": "The weight (boldness) of boundary borders."
1619
+ },
1620
+ "opacity": {
1621
+ "type": "number",
1622
+ "title": "Opacity",
1623
+ "description": "The opacity of the boundary borders (between 0 and 1)."
1624
+ },
1625
+ "fillOpacity": {
1626
+ "type": "number",
1627
+ "title": "Fill opacity",
1628
+ "description": "The opacity of the boundaries' background color (between 0 and 1)."
1629
+ },
1630
+ "color": {
1631
+ "type": "string",
1632
+ "format": "color",
1633
+ "title": "Color",
1634
+ "description": "The color of the boundary borders."
1635
+ },
1636
+ "dashArray": {
1637
+ "type": "string",
1638
+ "title": "Dash array",
1639
+ "description": "A 'dash array' describing the boundary as dashed lines."
1640
+ }
1641
+ }
1642
+ },
1643
+ "config_form_options": {
1644
+ "type": "object",
1645
+ "properties": {
1646
+ "enabled": {
1647
+ "type": "boolean",
1648
+ "title": "Enable this type of form",
1649
+ "description": "If enabled, this type of configuration form will be available.",
1650
+ "format": "checkbox"
1651
+ },
1652
+ "dropdowns": {
1653
+ "type": "array",
1654
+ "title": "Dropdown lists",
1655
+ "description": "Set options for any dropdown lists.",
1656
+ "items": {
1657
+ "type": "object",
1658
+ "title": "Dropdown list",
1659
+ "properties": {
1660
+ "jsonschema": {
1661
+ "type": "string",
1662
+ "title": "JSONSchema path",
1663
+ "description": "The jsonschema path to the dropdown field."
1664
+ },
1665
+ "values": {
1666
+ "type": "array",
1667
+ "title": "Values",
1668
+ "description": "List of dropdown option values",
1669
+ "items": {
1670
+ "type": "string",
1671
+ "title": "Value"
1672
+ }
1673
+ },
1674
+ "labels": {
1675
+ "type": "array",
1676
+ "title": "Labels",
1677
+ "description": "Optional list of dropdown option labels. Should correspond to the values above.",
1678
+ "items": {
1679
+ "type": "string",
1680
+ "title": "Label"
1681
+ }
1682
+ }
1683
+ }
1684
+ }
1685
+ },
1686
+ "repository_link": {
1687
+ "type": "string",
1688
+ "title": "Repository link",
1689
+ "description": "The URL pattern of the 'Go to repository' link on the configuration page."
1690
+ },
1691
+ "translation_link": {
1692
+ "type": "string",
1693
+ "title": "Translation link",
1694
+ "description": "The URL pattern for all 'Go to translation' links on the configuration page."
1695
+ }
1696
+ }
1697
+ },
1698
+ "indicator_tabs_options": {
1699
+ "enum": ["", "chart", "table", "map", "embed", "hide"],
1700
+ "options": {
1701
+ "enum_titles": [
1702
+ "",
1703
+ "Chart",
1704
+ "Table",
1705
+ "Map",
1706
+ "Embed",
1707
+ "Hide this tab"
1708
+ ]
1709
+ }
1710
+ }
1711
+ }
1712
+ }