jekyll-open-sdg-plugins 2.3.0 → 2.4.0.pre.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/jekyll-open-sdg-plugins.gemspec +0 -1
  3. data/lib/jekyll-open-sdg-plugins/create_indicators.rb +0 -3
  4. data/lib/jekyll-open-sdg-plugins/create_pages.rb +0 -3
  5. data/lib/jekyll-open-sdg-plugins/metadata_schema_to_config.rb +0 -2
  6. data/lib/jekyll-open-sdg-plugins/routes.rb +2 -2
  7. data/lib/jekyll-open-sdg-plugins/search_index.rb +1 -1
  8. data/lib/jekyll-open-sdg-plugins/version.rb +1 -1
  9. data/lib/jekyll-open-sdg-plugins.rb +0 -2
  10. data/tests/Gemfile +0 -1
  11. data/tests/_config.yml +0 -3
  12. metadata +4 -22
  13. data/lib/jekyll-open-sdg-plugins/schema-indicator-config.json +0 -956
  14. data/lib/jekyll-open-sdg-plugins/schema-site-config.json +0 -1723
  15. data/lib/jekyll-open-sdg-plugins/validate_indicator_config.rb +0 -48
  16. data/lib/jekyll-open-sdg-plugins/validate_site_config.rb +0 -34
data/lib/jekyll-open-sdg-plugins/schema-indicator-config.json DELETED
@@ -1,956 +0,0 @@
1
- {
2
- "type": "object",
3
- "title": "Open SDG indicator configuration",
4
- "description": "This form will produce an indicator's configuration for your Open SDG implementation.",
5
- "properties": {
6
- "composite_breakdown_label": {
7
- "type": "string",
8
- "title": "Composite breakdown label",
9
- "description": "Used as a label for the COMPOSITE_BREAKDOWN column, if it appears in the indicator data.",
10
- "links": [
11
- {
12
- "rel": "More information on the composite breakdown label setting",
13
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#composite-breakdown-label"
14
- }
15
- ]
16
- },
17
- "computation_units": {
18
- "type": "string",
19
- "title": "Unit of measurement",
20
- "description": "Unit of measurement which displays below the indicator chart.",
21
- "links": [
22
- {
23
- "rel": "More information on the units of measurement setting",
24
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
25
- }
26
- ]
27
- },
28
- "copyright": {
29
- "type": "string",
30
- "title": "Copyright",
31
- "description": "Copyright which displays below the indicator chart.",
32
- "links": [
33
- {
34
- "rel": "More information on the copyright setting",
35
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#footer"
36
- }
37
- ]
38
- },
39
- "data_footnote": {
40
- "type": "string",
41
- "format": "markdown",
42
- "title": "Footnote",
43
- "description": "Footnote which displays below the indicator chart.",
44
- "links": [
45
- {
46
- "rel": "More information on the footnote setting",
47
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#footer"
48
- }
49
- ]
50
- },
51
- "data_non_statistical": {
52
- "title": "Non-statistical data",
53
- "type": "boolean",
54
- "description": "Whether the indicator is statistical (can be charted/graphed) or not.",
55
- "format": "checkbox",
56
- "links": [
57
- {
58
- "rel": "More information the non-statistical setting",
59
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-fields"
60
- }
61
- ]
62
- },
63
- "data_notice_class": {
64
- "title": "Data notice - class",
65
- "type": "string",
66
- "description": "A CSS class to apply to the data notice for this indicator.",
67
- "links": [
68
- {
69
- "rel": "More information on the data notice setting",
70
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#data-notice"
71
- }
72
- ]
73
- },
74
- "data_notice_heading": {
75
- "title": "Data notice - heading",
76
- "type": "string",
77
- "description": "A title to display above the data notice for this indicator.",
78
- "links": [
79
- {
80
- "rel": "More information on the data notice heading setting",
81
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#data-notice"
82
- }
83
- ]
84
- },
85
- "data_notice_text": {
86
- "title": "Data notice - text",
87
- "type": "string",
88
- "format": "markdown",
89
- "description": "Text to display as a data notice for this indicator, intended to contain very important information which site viewers must keep in mind when using the data provided.",
90
- "links": [
91
- {
92
- "rel": "More information on the data notice text setting",
93
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#data-notice"
94
- }
95
- ]
96
- },
97
- "data_show_map": {
98
- "title": "Show map",
99
- "type": "boolean",
100
- "description": "Whether the indicator should display a Map tab.",
101
- "format": "checkbox",
102
- "links": [
103
- {
104
- "rel": "More information on the map setting",
105
- "href": "https://open-sdg.readthedocs.io/en/latest/maps/#metadata-field-data_show_map"
106
- }
107
- ]
108
- },
109
- "data_start_values": {
110
- "options": {"collapsed": true},
111
- "type": "array",
112
- "title": "Starting values",
113
- "description": "Disaggregation values for a an indicator to start with already selected",
114
- "items": {
115
- "type": "object",
116
- "title": "Starting value",
117
- "properties": {
118
- "field": {
119
- "type": "string",
120
- "minLength": 1,
121
- "title": "Field",
122
- "description": "The field (column) name."
123
- },
124
- "value": {
125
- "type": "string",
126
- "minLength": 1,
127
- "title": "Value",
128
- "description": "The value in that field to pre-select."
129
- }
130
- }
131
- },
132
- "links": [
133
- {
134
- "rel": "More information on the starting values setting",
135
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#starting-values"
136
- }
137
- ]
138
- },
139
- "embedded_feature_footer": {
140
- "type": "string",
141
- "format": "markdown",
142
- "title": "Embedded feature - Footer",
143
- "description": "A footer that displays below the embedded feature. Only used with either embedded_feature_url or embedded_feature_html.",
144
- "links": [
145
- {
146
- "rel": "More information on the embed footer setting",
147
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#embedded-feature-metadata"
148
- }
149
- ]
150
- },
151
- "embedded_feature_html": {
152
- "type": "string",
153
- "format": "textarea",
154
- "title": "Embedded feature - HTML",
155
- "description": "Any HTML to display in another tab, after Chart/Table/etc.",
156
- "links": [
157
- {
158
- "rel": "More information on the embed HTML setting",
159
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#embedded-feature-metadata"
160
- }
161
- ]
162
- },
163
- "embedded_feature_tab_title": {
164
- "type": "string",
165
- "title": "Embedded feature - Tab Title",
166
- "description": "A title for the embedded feature tab (ie, Chart/Table/[this]). Only used with either embedded_feature_url or embedded_feature_html.",
167
- "links": [
168
- {
169
- "rel": "More information on the embed tab title setting",
170
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#embedded-feature-metadata"
171
- }
172
- ]
173
- },
174
- "embedded_feature_title": {
175
- "type": "string",
176
- "title": "Embedded feature - Title",
177
- "description": "A title that displays above the embedded feature. Only used with either embedded_feature_url or embedded_feature_html.",
178
- "links": [
179
- {
180
- "rel": "More information on the embed title setting",
181
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#embedded-feature-metadata"
182
- }
183
- ]
184
- },
185
- "embedded_feature_url": {
186
- "type": "string",
187
- "format": "url",
188
- "title": "Embedded feature - URL",
189
- "description": "Any URL to display as an iframe in another tab, after Chart/Table/etc.",
190
- "links": [
191
- {
192
- "rel": "More information on the embed URL setting",
193
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#embedded-feature-metadata"
194
- }
195
- ]
196
- },
197
- "expected_disaggregations": {
198
- "options": {"collapsed": true},
199
- "type": "array",
200
- "title": "Expected disaggregations",
201
- "description": "An optional list of disaggregations (ie, data column names) to use when calculating the disaggregation status statistics.",
202
- "items": {
203
- "type": "string",
204
- "title": "Expected disaggregation"
205
- },
206
- "links": [
207
- {
208
- "rel": "More information on the expected disaggregation setting",
209
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
210
- }
211
- ]
212
- },
213
- "footer_fields": {
214
- "options": {"collapsed": true},
215
- "type": "array",
216
- "title": "Footer fields",
217
- "description": "Additional arbitrary information to display beneath the graph/table.",
218
- "items": {
219
- "type": "object",
220
- "title": "Footer field",
221
- "allOf": [
222
- { "$ref": "#/definitions/series_unit_constraint" },
223
- {
224
- "properties": {
225
- "label": {
226
- "type": "string",
227
- "title": "Label",
228
- "description": "The label for the field"
229
- },
230
- "value": {
231
- "type": "string",
232
- "title": "Value",
233
- "description": "The value/content for the field"
234
- }
235
- }
236
- }
237
- ]
238
- }
239
- },
240
- "graph_annotations": {
241
- "options": {"collapsed": true},
242
- "type": "array",
243
- "title": "Graph annotations",
244
- "description": "This can be used to add line annotations to the graph, such as target lines to show the progress towards the 2030 goal for an indicator.",
245
- "items": {
246
- "type": "object",
247
- "title": "Graph annotation",
248
- "allOf": [
249
- { "$ref": "#/definitions/series_unit_constraint" },
250
- {
251
- "properties": {
252
- "value": {
253
- "type": "number",
254
- "minimum": 0,
255
- "title": "Value",
256
- "description": "The value at which to draw the line. For horizontal lines, this number corresponds to your actual data. For vertical lines, this number should be between 0 (the left side of the chart) and the number of years minus 1 (the right side of the chart)."
257
- },
258
- "endValue": {
259
- "type": "number",
260
- "title": "End value",
261
- "description": "Optionally add a different ending value for the line."
262
- },
263
- "description": {
264
- "type": "string",
265
- "title": "Description",
266
- "description": "A description of the annotation to be read by screenreaders."
267
- },
268
- "mode": {
269
- "type": "string",
270
- "title": "Mode",
271
- "description": "Whether the line will be vertical or horizontal.",
272
- "enum": ["horizontal", "vertical"]
273
- },
274
- "borderColor": {
275
- "type": "string",
276
- "format": "color",
277
- "title": "Line color",
278
- "default": "#949494",
279
- "description": "The color of the line.",
280
- "links": [
281
- {
282
- "rel": "More information on the border color setting",
283
- "href": "https://github.com/chartjs/chartjs-plugin-annotation/blob/master/README.md"
284
- }
285
- ]
286
- },
287
- "borderDash": {
288
- "type": "array",
289
- "title": "Line dash type",
290
- "description": "The type of line dash.",
291
- "default": [10, 5],
292
- "items": {
293
- "type": "number"
294
- },
295
- "minItems": 2,
296
- "links": [
297
- {
298
- "rel": "More information on the line dash setting",
299
- "href": "https://github.com/chartjs/chartjs-plugin-annotation/blob/master/README.md"
300
- }
301
- ]
302
- },
303
- "label": {
304
- "type": "object",
305
- "title": "Label",
306
- "description": "A text label for the annotation.",
307
- "properties": {
308
- "position": {
309
- "type": "string",
310
- "title": "Position",
311
- "description": "Placement of the label along the line.",
312
- "enum": [
313
- "start",
314
- "end",
315
- "top",
316
- "bottom",
317
- "left",
318
- "right",
319
- "center"
320
- ]
321
- },
322
- "content": {
323
- "type": "string",
324
- "minLength": 1,
325
- "title": "Content",
326
- "description": "Text of the line label."
327
- },
328
- "fontColor": {
329
- "type": "string",
330
- "format": "color",
331
- "title": "Label color (do not use)",
332
- "description": "[DEPRECATED: USE 'Label color (use this)' INSTEAD]",
333
- "default": "#000000"
334
- },
335
- "color": {
336
- "type": "string",
337
- "format": "color",
338
- "title": "Label color (use this)",
339
- "description": "Color for the label text.",
340
- "default": "#000000"
341
- },
342
- "backgroundColor": {
343
- "type": "string",
344
- "format": "color",
345
- "default": "#ffffff",
346
- "title": "Background color",
347
- "description": "Background color for the label text."
348
- }
349
- }
350
- },
351
- "highContrast": {
352
- "type": "object",
353
- "title": "High contrast options",
354
- "description": "High-contrast overrides of certain color.",
355
- "properties": {
356
- "borderColor": {
357
- "type": "string",
358
- "format": "color",
359
- "default": "#ffffff",
360
- "title": "High-contrast line color",
361
- "description": "The color of the line in high-contrast mode."
362
- },
363
- "label": {
364
- "type": "object",
365
- "title": "High contrast label",
366
- "description": "High-contrast version of the label.",
367
- "properties": {
368
- "fontColor": {
369
- "type": "string",
370
- "format": "color",
371
- "default": "#ffffff",
372
- "title": "High-contrast label color (do not use)",
373
- "description": "[DEPRECATED: USE 'High-contrast label color (use this)' INSTEAD]"
374
- },
375
- "color": {
376
- "type": "string",
377
- "format": "color",
378
- "default": "#ffffff",
379
- "title": "High-contrast label color (use this)",
380
- "description": "Color for the label text in high-contrast mode."
381
- },
382
- "backgroundColor": {
383
- "type": "string",
384
- "format": "color",
385
- "default": "#000000",
386
- "title": "High-contrast background color",
387
- "description": "Background color for the label text in high-contrast mode."
388
- }
389
- }
390
- }
391
- }
392
- }
393
- }
394
- }
395
- ]
396
- },
397
- "links": [
398
- {
399
- "rel": "More information on the graph annotations setting",
400
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#graph-metadata"
401
- }
402
- ]
403
- },
404
- "graph_limits": {
405
- "options": {"collapsed": true},
406
- "type": "array",
407
- "title": "Graph limits",
408
- "description": "A list of min/max limits controlling the lowest/highest values to be shown on the y-axis.",
409
- "items": {
410
- "type": "object",
411
- "title": "Graph limit",
412
- "allOf": [
413
- { "$ref": "#/definitions/series_unit_constraint" },
414
- {
415
- "properties": {
416
- "minimum": {
417
- "type": "number",
418
- "minimum": 0,
419
- "title": "Minimum",
420
- "description": "Minimum value for the y axis."
421
- },
422
- "maximum": {
423
- "type": "number",
424
- "minimum": 0,
425
- "title": "Maximum",
426
- "description": "Maximum value for the y axis."
427
- }
428
- }
429
- }
430
- ]
431
- },
432
- "links": [
433
- {
434
- "rel": "More information on the graph limits setting",
435
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#graph-metadata"
436
- }
437
- ]
438
- },
439
- "graph_series_breaks": {
440
- "options": {"collapsed": true},
441
- "type": "array",
442
- "title": "Graph series breaks",
443
- "description": "A list of series break (ie, a gap among the years) lines to display on the graph.",
444
- "items": {
445
- "type": "object",
446
- "title": "Series break",
447
- "allOf": [
448
- { "$ref": "#/definitions/series_unit_constraint" },
449
- {
450
- "properties": {
451
- "label_content": {
452
- "type": "string",
453
- "title": "Label content",
454
- "default": "indicator.annotation_series_break",
455
- "description": "The text to display for this series break."
456
- },
457
- "value": {
458
- "type": "number",
459
- "title": "Value",
460
- "description": "The numeric value at which to place the series break. This number should be between 0 (the left side of the chart) and the number of years minus 1 (the right side of the chart)."
461
- }
462
- }
463
- }
464
- ]
465
- },
466
- "links": [
467
- {
468
- "rel": "More information on the graph target lines setting",
469
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#graph_series_breaks"
470
- }
471
- ]
472
- },
473
- "graph_stacked_disaggregation": {
474
- "type": "string",
475
- "title": "Stacked disaggregation",
476
- "description": "This can be used with the bar graph type to place a certain disaggregation into the same stacked bars.",
477
- "links": [
478
- {
479
- "rel": "More information on the stacked disaggregation setting",
480
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
481
- }
482
- ]
483
- },
484
- "graph_target_lines": {
485
- "options": {"collapsed": true},
486
- "type": "array",
487
- "title": "Graph target lines",
488
- "description": "A list of target lines to display on the graph.",
489
- "items": {
490
- "type": "object",
491
- "title": "Target line",
492
- "allOf": [
493
- { "$ref": "#/definitions/series_unit_constraint" },
494
- {
495
- "properties": {
496
- "label_content": {
497
- "type": "string",
498
- "title": "Label content",
499
- "default": "indicator.annotation_2030_target",
500
- "description": "The text to display for this target line."
501
- },
502
- "value": {
503
- "type": "number",
504
- "title": "Value",
505
- "description": "The numeric value at which to place the target line."
506
- }
507
- }
508
- }
509
- ]
510
- },
511
- "links": [
512
- {
513
- "rel": "More information on the graph target lines setting",
514
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#graph_target_lines"
515
- }
516
- ]
517
- },
518
- "graph_title": {
519
- "type": "string",
520
- "title": "Graph title",
521
- "description": "The title that displays above the graph/chart.",
522
- "links": [
523
- {
524
- "rel": "More information on the graph title setting",
525
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-for-statistical-indicators"
526
- }
527
- ]
528
- },
529
- "graph_titles": {
530
- "options": {"collapsed": true},
531
- "type": "array",
532
- "title": "Graph titles",
533
- "description": "As an alternative to `graph_title`, this can be used to set specific titles for particular units and/or series.",
534
- "items": {
535
- "type": "object",
536
- "title": "Graph title",
537
- "allOf": [
538
- { "$ref": "#/definitions/series_unit_constraint" },
539
- {
540
- "properties": {
541
- "title": {
542
- "type": "string",
543
- "minLength": 1,
544
- "title": "Title",
545
- "description": "The graph title."
546
- }
547
- }
548
- }
549
- ]
550
- }
551
- },
552
- "graph_type": {
553
- "type": "string",
554
- "title": "Graph type",
555
- "description": "What type of graph to use for the indicator.",
556
- "enum": ["line", "bar", "binary"],
557
- "links": [
558
- {
559
- "rel": "More information on the graph titles setting",
560
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-for-statistical-indicators"
561
- }
562
- ]
563
- },
564
- "indicator_available": {
565
- "type": "string",
566
- "title": "Indicator available",
567
- "description": "An optional sub-title for the indicator, which displays below the indicator name. Intended for cases where the available data is slightly different than the indicator name.",
568
- "links": [
569
- {
570
- "rel": "More information on the indicator available setting",
571
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
572
- }
573
- ]
574
- },
575
- "indicator_name": {
576
- "type": "string",
577
- "title": "Indicator name",
578
- "description": "The name for the indicator, which displays at the top of the indicator page.",
579
- "links": [
580
- {
581
- "rel": "More information on the indicator name setting",
582
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-fields"
583
- }
584
- ]
585
- },
586
- "indicator_number": {
587
- "type": "string",
588
- "title": "Indicator number",
589
- "description": "The number (or 'id') for the indicator.",
590
- "links": [
591
- {
592
- "rel": "More information on the indicator number setting",
593
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-fields"
594
- }
595
- ]
596
- },
597
- "indicator_tabs": {
598
- "options": {"collapsed": true},
599
- "type": "object",
600
- "title": "Indicator tabs",
601
- "description": "Assign content for the indicator tabs, if the override box is checked. Otherwise this indicator will use the assignments set in your site configuration.",
602
- "properties": {
603
- "override": {
604
- "type": "boolean",
605
- "title": "Override site configuration",
606
- "description": "If checked, the site-wide indicator tab configuration will be ignored for this indicator.",
607
- "format": "checkbox"
608
- },
609
- "tab_1": {
610
- "type": "string",
611
- "title": "Tab 1",
612
- "description": "What to display in the first tab",
613
- "$ref": "#/definitions/indicator_tabs_options"
614
- },
615
- "tab_2": {
616
- "type": "string",
617
- "title": "Tab 2",
618
- "description": "What to display in the second tab",
619
- "$ref": "#/definitions/indicator_tabs_options"
620
- },
621
- "tab_3": {
622
- "type": "string",
623
- "title": "Tab 3",
624
- "description": "What to display in the third tab",
625
- "$ref": "#/definitions/indicator_tabs_options"
626
- },
627
- "tab_4": {
628
- "type": "string",
629
- "title": "Tab 4",
630
- "description": "What to display in the fourth tab",
631
- "$ref": "#/definitions/indicator_tabs_options"
632
- }
633
- }
634
- },
635
- "national_geographical_coverage": {
636
- "type": "string",
637
- "title": "National geographical coverage",
638
- "description": "A label used in the absence of any disaggregation.",
639
- "links": [
640
- {
641
- "rel": "More information on the geographical coverage setting",
642
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-for-statistical-indicators"
643
- }
644
- ]
645
- },
646
- "page_content": {
647
- "type": "string",
648
- "format": "markdown",
649
- "title": "Page content",
650
- "description": "Content which displays in the main content area of the indicator page."
651
- },
652
- "permalink": {
653
- "type": "string",
654
- "title": "Permalink",
655
- "description": "Overrides the normal path of the indicator page. Not recommended, execpt for 'standalone' indicators.",
656
- "links": [
657
- {
658
- "rel": "More information the permalink setting",
659
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#standalone-indicators"
660
- }
661
- ]
662
- },
663
- "placeholder": {
664
- "title": "Placeholder indicator",
665
- "type": "string",
666
- "description": "Entering text here identifies this as a 'placeholder' indicator. The text will be displayed on the goal page, in place of a link to the indicator page.",
667
- "format": "textarea",
668
- "links": [
669
- {
670
- "rel": "More information the placeholder setting",
671
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#placeholder"
672
- }
673
- ]
674
- },
675
- "precision": {
676
- "options": {"collapsed": true},
677
- "type": "array",
678
- "title": "Precision rules",
679
- "description": "Control the number of decimal places for data in this indicator.",
680
- "items": {
681
- "type": "object",
682
- "title": "Precision rule",
683
- "allOf": [
684
- { "$ref": "#/definitions/series_unit_constraint" },
685
- {
686
- "properties": {
687
- "decimals": {
688
- "type": "number",
689
- "title": "Decimals",
690
- "description": "The number of decimal places"
691
- }
692
- }
693
- }
694
- ]
695
- }
696
- },
697
- "progress_status": {
698
- "type": "string",
699
- "title": "Progress status",
700
- "enum": ["not_available", "challenges_remain", "approaching_target", "target_achieved"],
701
- "description": "The progress status of the indicator.",
702
- "links": [
703
- {
704
- "rel": "More information on the progress status setting",
705
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#progress-status"
706
- }
707
- ]
708
- },
709
- "proxy": {
710
- "title": "Proxy indicator",
711
- "type": "string",
712
- "description": "Whether the indicator is a 'proxy' (meaning that it is somehow different than the globally-defined SDG indicator).",
713
- "enum": ["", "proxy", "both"],
714
- "options": {
715
- "enum_titles": [
716
- "Not a proxy indicator (default)",
717
- "Proxy indicator",
718
- "Both (contains both a proxy series and a non-proxy series)"
719
- ]
720
- },
721
- "links": [
722
- {
723
- "rel": "More information the proxy setting",
724
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#proxy"
725
- }
726
- ]
727
- },
728
- "proxy_series": {
729
- "options": {"collapsed": true},
730
- "type": "array",
731
- "title": "Proxy indicator - per series",
732
- "description": "A list of each series within this indicator that should be considered a proxy (meaning that it is different somehow from the globally-defined series). Only needed if you chose 'Mixed series' above.",
733
- "items": {
734
- "type": "string",
735
- "title": "Series"
736
- },
737
- "links": [
738
- {
739
- "rel": "More information on the proxy_series setting",
740
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#proxy_series"
741
- }
742
- ]
743
- },
744
- "publications": {
745
- "options": {"collapsed": true},
746
- "type": "array",
747
- "title": "Publications",
748
- "description": "This setting controls the content of the 'Related publications' tab. It can contain any number of publications. You may have much of this information in the indicator metadata, but this configuration is available to supplement the metadata with a more structured way to list multiple publications.",
749
- "items": {
750
- "type": "object",
751
- "title": "Publication",
752
- "properties": {
753
- "title": {
754
- "type": "string",
755
- "title": "Title"
756
- },
757
- "link": {
758
- "type": "string",
759
- "title": "Link"
760
- },
761
- "description": {
762
- "type": "string",
763
- "title": "description",
764
- "format": "markdown"
765
- },
766
- "date": {
767
- "type": "string",
768
- "title": "Date"
769
- }
770
- }
771
- },
772
- "links": [
773
- {
774
- "rel": "More information on the publications setting",
775
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#publications"
776
- }
777
- ]
778
- },
779
- "related_indicators": {
780
- "options": {"collapsed": true},
781
- "type": "array",
782
- "title": "Related indicators",
783
- "description": "This setting controls the 'Related indicators' tab. Specify indicators by using their indicator numbers, such as: 1.1.1",
784
- "items": {
785
- "type": "string",
786
- "title": "Related indicator"
787
- },
788
- "links": [
789
- {
790
- "rel": "More information on the related_indicators setting",
791
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#related_indicators"
792
- }
793
- ]
794
- },
795
- "reporting_status": {
796
- "type": "string",
797
- "title": "Reporting status",
798
- "enum": ["complete", "inprogress", "notstarted", "notapplicable"],
799
- "description": "The reporting status of the indicator.",
800
- "links": [
801
- {
802
- "rel": "More information on the reporting status setting",
803
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#mandatory-fields"
804
- }
805
- ]
806
- },
807
- "sort": {
808
- "type": "string",
809
- "title": "Sort order",
810
- "description": "Override the default order in which this indicator is displayed in lists. This can be left blank, and it will be automatically determined.",
811
- "links": [
812
- {
813
- "rel": "More information on the sort setting",
814
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#sorting-in-lists"
815
- }
816
- ]
817
- },
818
- "sources": {
819
- "options": {"collapsed": true},
820
- "type": "array",
821
- "title": "Sources",
822
- "description": "This setting controls the content of the 'Sources' tab. It can contain any number sources. You may have much of this information in the metadata, but this configuration is available to supplement the metadata with a more structured way to list multiple sources.",
823
- "items": {
824
- "type": "object",
825
- "title": "Source",
826
- "properties": {
827
- "organisation": {
828
- "type": "string",
829
- "title": "Organisation"
830
- },
831
- "periodicity": {
832
- "type": "string",
833
- "title": "Periodicity"
834
- },
835
- "earliest_available": {
836
- "type": "string",
837
- "title": "Earliest available data"
838
- },
839
- "geographical_coverage": {
840
- "type": "string",
841
- "title": "Geographical coverage"
842
- },
843
- "url": {
844
- "type": "string",
845
- "title": "URL"
846
- },
847
- "url_text": {
848
- "type": "string",
849
- "title": "URL text"
850
- },
851
- "release_date": {
852
- "type": "string",
853
- "title": "Release date"
854
- },
855
- "next_release": {
856
- "type": "string",
857
- "title": "Next release"
858
- },
859
- "statistical_classification": {
860
- "type": "string",
861
- "title": "Statistical classification"
862
- },
863
- "contact": {
864
- "type": "string",
865
- "title": "Contact"
866
- },
867
- "other_info": {
868
- "type": "string",
869
- "title": "Other information",
870
- "format": "markdown"
871
- },
872
- "logo": {
873
- "type": "string",
874
- "title": "Path to logo image"
875
- }
876
- }
877
- },
878
- "links": [
879
- {
880
- "rel": "More information on the sources setting",
881
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#sources"
882
- }
883
- ]
884
- },
885
- "standalone": {
886
- "title": "Standalone indicator",
887
- "type": "boolean",
888
- "description": "Whether the indicator is standalone (separate from the SDGs) or not.",
889
- "format": "checkbox",
890
- "links": [
891
- {
892
- "rel": "More information the standalone setting",
893
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#standalone-indicators"
894
- }
895
- ]
896
- },
897
- "tags": {
898
- "options": {"collapsed": true},
899
- "type": "array",
900
- "title": "Tags",
901
- "description": "An optional list of 'tags' to display under an indicator when it is listed on its goal page.",
902
- "items": {
903
- "type": "string",
904
- "title": "Tag"
905
- },
906
- "links": [
907
- {
908
- "rel": "More information on the tags setting",
909
- "href": "https://open-sdg.readthedocs.io/en/latest/metadata-format/#recommended-special-fields"
910
- }
911
- ]
912
- },
913
- "x_axis_label": {
914
- "type": "string",
915
- "title": "X axis label",
916
- "description": "A label beneath the X axis on charts. This overrides the same site configuration setting.",
917
- "links": [
918
- {
919
- "rel": "More information on the X axis label setting",
920
- "href": "https://open-sdg.readthedocs.io/en/latest/indicator-configuration/#x_axis_label"
921
- }
922
- ]
923
- }
924
- },
925
- "additionalProperties": true,
926
- "definitions": {
927
- "series_unit_constraint": {
928
- "type": "object",
929
- "properties": {
930
- "series": {
931
- "type": "string",
932
- "title": "Series",
933
- "description": "Limit to this particular series"
934
- },
935
- "unit": {
936
- "type": "string",
937
- "title": "Unit",
938
- "description": "Limit to this particular unit"
939
- }
940
- }
941
- },
942
- "indicator_tabs_options": {
943
- "enum": ["", "chart", "table", "map", "embed", "hide"],
944
- "options": {
945
- "enum_titles": [
946
- "",
947
- "Chart",
948
- "Table",
949
- "Map",
950
- "Embed",
951
- "Hide this tab"
952
- ]
953
- }
954
- }
955
- }
956
- }