tmdinosaurcenter
/
dwc
mirror of https://github.com/tdwg/dwc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Minor text corrections

This commit is contained in:
peterdesmet 2020-08-13 10:14:51 +02:00
parent 5ff90b28d3
commit f9cdb7f071
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
build/README.md
View File

@ -5,9 +5,9 @@ The build script `build.py` uses as input:
* [vocabulary/term_versions.csv](../vocabulary/term_versions.csv): the list of terms
* [terms.tmpl](terms.tmpl): a Jinja2 template for the quick reference guide
To create:
And creates:
* The quick reference guide as a Markdown file at [docs/terms/index.md](../docs/terms/index.md). The guide is build as Markdown (with a lot of included html) rather than html, so it can incorporated by Jekyll in the Darwin Core website (including a header, footer and table of content).
* The quick reference guide is a Markdown file at [docs/terms/index.md](../docs/terms/index.md). The guide is build as Markdown (with a lot of included html) rather than html, so it can incorporated by Jekyll in the Darwin Core website (including a header, footer and table of content).
* Two simple Darwin Core CSV files in [dist/](../dist/)
## Run the build script
@ -26,12 +26,12 @@ To create:
## Generating the "normative document"
The script `generate_normative_csv.py` pulls source data from the rs.tdwg.org GitHub repo. The local file `qrg-list.csv` contains a list of the term IRIs in the order that they are to appear in the Quick Reference Guide. This list needs to be changed whenever terms are added to or deprecated from Darwin Core.
The script `generate_normative_csv.py` pulls source data from the [rs.tdwg.org](http://github.com/tdwg/rs.tdwg.org) repository. The local file `qrg-list.csv` contains a list of the term IRIs in the order that they are to appear in the Quick Reference Guide. This list needs to be changed whenever terms are added to or deprecated from Darwin Core.
It outputs the file `term_versions.csv`, which is used as the input for the `build.py` script above.
## Generating the "list of terms" document
The Jupyter notebook 'build-termlist.ipynb` inputs the header information from `termlist-header.md`, then builds the list of terms and their metadata from data in the rs.tdwg.org TDWG GitHub repo. (The script also inputs `termlist-footer.md` and appends it to the end of the generated document, but currently it has no content.) The constructed Markdown document is saved in the /docs/list/ directory as index.md .
The Jupyter notebook `build-termlist.ipynb` inputs the header information from `termlist-header.md`, then builds the list of terms and their metadata from data in the [rs.tdwg.org](http://github.com/tdwg/rs.tdwg.org) repository. The script also inputs `termlist-footer.md` and appends it to the end of the generated document, but currently it has no content. The constructed Markdown document is saved as `/docs/list/index.md`.
When this is all working, the code can be pulled from the Jupyter notebook cells and just be saved as a `.py` Python script.
Note: when this is all working, the code can be pulled from the Jupyter notebook cells and just be saved as a `.py` Python script.