dwc/build
Peter Desmet ea2b293a08 Add configuration for the recommended terms, incl. order, labels, examples 🐲
Created at the Ottawa 2017 hackathon by @tucotuco @baskaufs @peterdesmet @pzermoglio @stijnvanhoey
2017-09-30 00:24:50 -04:00
..
config Add configuration for the recommended terms, incl. order, labels, examples 🐲 2017-09-30 00:24:50 -04:00
README.html Add a simple markdown site generator script, see https://github.com/tdwg/dwc/issues/76 2017-09-29 22:17:46 -04:00
README.md Write script readme and migrate xml guide to new design 2017-09-29 22:16:13 -04:00
buildsite.py Improve site generator to use simple file metadata in capital words at the top of the MD file. Detect menu entry automatically based on path 2017-09-29 22:17:46 -04:00
dc.yaml Update inline link anchor regex to avoid brackets and ending dots 2017-09-29 22:07:50 -04:00
footer.inc Improve site generator to use simple file metadata in capital words at the top of the MD file. Detect menu entry automatically based on path 2017-09-29 22:17:46 -04:00
header.inc Update header.inc 2017-09-29 22:17:46 -04:00
requirements.txt Add a simple markdown site generator script, see https://github.com/tdwg/dwc/issues/76 2017-09-29 22:17:46 -04:00
term_order.yaml update yaml and implement graph/yaml consistency check. Add local bootstrap assets 2017-09-29 18:48:20 -04:00
term_type.yaml Adding generation of resources files to update script 2017-09-29 22:01:07 -04:00
terms.tmpl Correct HTML validation errors 2017-09-29 22:29:13 -04:00
update_terms.py Write script readme and migrate xml guide to new design 2017-09-29 22:16:13 -04:00

README.md

The build folder contains a python script to rebuild the terms index page and all resources. It will use the current terms/dwc_normaltive.rdf and some yaml configurations inside this build folder for term definitions and order.

Run the script

Install the required libraries for this script with PIP once: $ easy_install pip $ sudo pip install -r requirements.txt

To run the script just run it from inside the build folder: $ ./update_terms.py

Adding new terms

Simple changes for definitions should just be done in the RDF file. In case a DwC term has been renamed, removed or added this also needs to be reflected in the following files:

dc.yaml

This file contains the Dublin Core terms to be used in the record level group in the right order and their DwC definitions.

term_order.yaml

This file contains a nested list of all DwC terms to be shown in the terms index. The order and grouping of terms is defined here, but the definitions and other metadata is taken from the dwc_normative.rdf

term_type.yaml

In order to generate the postgres sql table definition the script needs to know all data types different from the default text. This file contains a list of those terms with the exact data type as used in postgres.

TODO

  • add DOI explanations