Spreadsheet fixes

docs/about/changelog.md

@@ -54,6 +54,12 @@ This page lists changes to the Risk Data Library Standard.
 - [#168](https://github.com/GFDRR/rdl-standard/pull/168) - Add version number and `links` field.
 - [#163](https://github.com/GFDRR/rdl-standard/pull/163) - fix typos within rdl_schema_0.1.json
 - [#180](https://github.com/GFDRR/rdl-standard/pull/180) - Refactors schema, moves `hazard`, `exposure`, `vulnerability` and `loss` to top level and removes 'anyOf'.
+- [#181](https://github.com/GFDRR/rdl-standard/pull/181) - Various fixes:
+  - Codelist filename in `Classification.scheme`
+  - {\{version}} placeholder replacement in built schema
+  - `version` type
+  - Required fields in `Event_set`, `Hazard` and `Footprint`
+  - Markdown syntax in `Attribution.role` description
 - [#190](https://github.com/GFDRR/rdl-standard/pull/190) - Deletes type key from properties with `$ref` components.
 
 ### Codelists

docs/conf.py

@@ -22,6 +22,9 @@
 # sys.path.insert(0, os.path.abspath('.'))
 import json
 import os
+import shutil
+
+from distutils.dir_util import copy_tree
 from pygit2 import Repository
 
 # -- General configuration ------------------------------------------------
@@ -177,13 +180,13 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static', '../schema']
+html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
 #
-# html_extra_path = []
+html_extra_path = ['../.temp']
 
 # If not None, a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
@@ -368,6 +371,10 @@
 togglebutton_hint = ""
 
 
+def create_directory(path):
+    output_dir = os.path.dirname(path)
+    os.makedirs(output_dir, exist_ok=True)  
+
 def replace_substring_in_json(file_path, search_substring, replace_string, output_path=None):
     # Read the JSON file
     with open(file_path, 'r') as file:
@@ -381,14 +388,12 @@ def replace_substring_in_json(file_path, search_substring, replace_string, outpu
         output_path = file_path
 
     # Create the directory if it does not exist
-    output_dir = os.path.dirname(output_path)
-    os.makedirs(output_dir, exist_ok=True)    
+    create_directory(output_path)
 
     # Write the modified JSON data to the output file
     with open(output_path, 'w') as file:
         json.dump(data, file, indent=4)
 
-
 def _replace_substring_in_json(data, search_substring, replace_string):
     if isinstance(data, dict):
         for key, value in data.items():
@@ -406,17 +411,25 @@ def _replace_substring_in_json(data, search_substring, replace_string):
 
 def setup(app):
     # Connect handlers to events
+    app.connect('config-inited', config_inited)
     app.connect('env-before-read-docs', env_before_read_docs)
+    app.connect('build-finished', build_finished)
 
 
-def env_before_read_docs(app, env, docnames):
+def config_inited(app, config):
+    shutil.copytree('../schema', '../.temp')
+
     rtd_version = os.getenv('READTHEDOCS_VERSION')
 
-    # Process schema and write to _readthedocs/html
+    # Replace {{version}} placeholders
     if rtd_version is not None:
-        # Replace {{version}} placeholders
-        replace_substring_in_json('../schema/rdls_schema.json', '{{version}}', rtd_version, output_path='_readthedocs/html/rdls_schema.json')
-    else:
-        # Don't replace {{version}} placeholders
-        replace_substring_in_json('../schema/rdls_schema.json', 'https://rdl-standard.readthedocs.io/en/{{version}}', 'https://rdl-standard.readthedocs.io/en/{{version}}', output_path='_readthedocs/html/rdls_schema.json')
-
+        replace_substring_in_json('../.temp/rdls_schema.json', '{{version}}', rtd_version)
+
+
+def env_before_read_docs(app, env, docnames):
+    create_directory('_readthedocs/html/')
+    shutil.copyfile('../.temp/rdls_schema.json', '_readthedocs/html/rdls_schema.json')
+
+
+def build_finished(app, exception):
+    shutil.rmtree('../.temp')

docs/reference/browser.md

@@ -2,4 +2,4 @@
 
 This page presents the schema in an interactive browser. Click on schema elements to expand the tree, or use the '+' icon to expand all elements. Use { } to view the underlying schema for any section. Required fields are indicated in **bold**. You can also [view the schema in reference tables](schema.md).
 
-<script src="../../_static/docson/widget.js" data-schema="../rdls_schema.json"></script>
+<script src="../../_static/docson/widget.js" data-schema="../../rdls_schema.json"></script>

docs/reference/codelists.md

@@ -31,7 +31,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/IMT.csv
+file: ../../schema/codelists/open/IMT.csv
 ---
 ```
 
@@ -43,7 +43,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/classification_scheme.csv
+file: ../../schema/codelists/open/classification_scheme.csv
 ---
 ```
 
@@ -55,7 +55,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/damage_scale_name.csv
+file: ../../schema/codelists/open/damage_scale_name.csv
 ---
 ```
 
@@ -67,7 +67,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/data_formats.csv
+file: ../../schema/codelists/open/data_formats.csv
 ---
 ```
 
@@ -83,7 +83,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/engineering_demand_parameter.csv
+file: ../../schema/codelists/open/engineering_demand_parameter.csv
 ---
 ```
 
@@ -99,7 +99,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/impact_metric.csv
+file: ../../schema/codelists/open/impact_metric.csv
 ---
 ```
 
@@ -115,7 +115,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/impact_unit.csv
+file: ../../schema/codelists/open/impact_unit.csv
 ---
 ```
 
@@ -131,7 +131,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/license.csv
+file: ../../schema/codelists/open/license.csv
 ---
 ```
 
@@ -143,7 +143,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/location_gazetteers.csv
+file: ../../schema/codelists/open/location_gazetteers.csv
 ---
 ```
 
@@ -155,7 +155,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/media_type.csv
+file: ../../schema/codelists/open/media_type.csv
 ---
 ```
 
@@ -173,7 +173,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/open/roles.csv
+file: ../../schema/codelists/open/roles.csv
 ---
 ```
 
@@ -191,7 +191,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/analysis_type.csv
+file: ../../schema/codelists/closed/analysis_type.csv
 ---
 ```
 
@@ -208,7 +208,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/cost_type.csv
+file: ../../schema/codelists/closed/cost_type.csv
 ---
 ```
 
@@ -220,7 +220,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/country.csv
+file: ../../schema/codelists/closed/country.csv
 ---
 ```
 
@@ -234,7 +234,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/currency.csv
+file: ../../schema/codelists/closed/currency.csv
 ---
 ```
 
@@ -250,7 +250,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/data_calculation_type.csv
+file: ../../schema/codelists/closed/data_calculation_type.csv
 ---
 ```
 
@@ -267,7 +267,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/exposure_category.csv
+file: ../../schema/codelists/closed/exposure_category.csv
 ---
 ```
 
@@ -279,7 +279,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/frequency_distribution.csv
+file: ../../schema/codelists/closed/frequency_distribution.csv
 ---
 ```
 
@@ -298,7 +298,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/function_approach.csv
+file: ../../schema/codelists/closed/function_approach.csv
 ---
 ```
 
@@ -310,7 +310,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/geometry_type.csv
+file: ../../schema/codelists/closed/geometry_type.csv
 ---
 ```
 
@@ -326,7 +326,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/hazard_type.csv
+file: ../../schema/codelists/closed/hazard_type.csv
 ---
 ```
 
@@ -342,7 +342,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/impact_type.csv
+file: ../../schema/codelists/closed/impact_type.csv
 ---
 ```
 
@@ -354,7 +354,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/loss_type.csv
+file: ../../schema/codelists/closed/loss_type.csv
 ---
 ```
 
@@ -368,7 +368,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/process_type.csv
+file: ../../schema/codelists/closed/process_type.csv
 ---
 ```
 
@@ -387,7 +387,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/relationship_type.csv
+file: ../../schema/codelists/closed/relationship_type.csv
 ---
 ```
 
@@ -399,7 +399,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/risk_data_type.csv
+file: ../../schema/codelists/closed/risk_data_type.csv
 ---
 ```
 
@@ -411,7 +411,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/seasonality.csv
+file: ../../schema/codelists/closed/seasonality.csv
 ---
 ```
 
@@ -427,7 +427,7 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/source_type.csv
+file: ../../schema/codelists/closed/source_type.csv
 ---
 ```
 
@@ -443,6 +443,6 @@ This codelist has the following codes:
 ---
 header-rows: 1
 widths: auto
-file: ../../codelists/closed/spatial_scale.csv
+file: ../../schema/codelists/closed/spatial_scale.csv
 ---
 ```

manage.py

@@ -15,9 +15,9 @@
 from pathlib import Path
 
 basedir = Path(__file__).resolve().parent
-codelistdir = basedir / 'codelists'
 referencedir = basedir / 'docs' / 'reference'
 schemadir = basedir / 'schema'
+codelistdir = schemadir / 'codelists'
 
 
 def read_lines(filename):
@@ -164,7 +164,7 @@ def generate_codelist_markdown(codelist, type, references, definitions, defs_pat
     "```{csv-table-no-translate}\n",
     ":header-rows: 1\n",
     ":widths: auto\n",
-    f":file: ../../codelists/{type}/{codelist}.csv\n",
+    f":file: ../../schema/codelists/{type}/{codelist}.csv\n",
     "```\n\n"
   ])