diff --git a/build/README.md b/build/README.md index ddf917e..c00226f 100644 --- a/build/README.md +++ b/build/README.md @@ -21,11 +21,12 @@ 17. Go to the `docs/list/` directory and change the name of the `index.md` file to the date of the version being replaced (e.g. `2020-08-12.md`). Open that file and add a "Replaced by" label and value to the IRI of the new version (see an older version for an example). Save the file. 18. Run the script [build-termlist.py](https://github.com/tdwg/dwc/blob/master/build/build-termlist.py). Be patient since some steps take a few seconds. When the `Done` message appears, it's finished. 19. Check the diff for the newly generated `index.md` file in the [docs/list/](https://github.com/tdwg/dwc/tree/master/docs/list) directory and make sure that the changes are appropriate. -20. Run the [generate_term_versions.py](https://github.com/tdwg/dwc/blob/master/build/generate_term_versions.py) script to generate a new version of [term_versions.csv](https://github.com/tdwg/dwc/blob/master/vocabulary/term_versions.csv). This file serves as the source of data for the build script in the next step. At some point, that script may be modified to eliminate this intermediate step. -21. Run the [build.py](https://github.com/tdwg/dwc/blob/master/build/build.py) script to build the Quick Reference Guide. -22. Create a pull request for the new branch. -23. When the branch has been reviewed carefully, merge the branch. The new pages shuld be live as soon as Jekyll rebuilds them on GitHub. -24. Term dereferencing to human and machine readable representations is handled by a server managed by GBIF. The new metadata gets fed into the production version of the server when there is a new release of the `rs.tdwg.org` repo, so when everything is done, make sure there a new release has been made. Because dereferencing of current terms to human-readable web pages is handled by a redirect, there won't be any noticeable difference whether the data are reloaded in this step or not. But dereferencing the term versions, or dereferencing to acquire machine readable metadata will not reflect the new changes until the release process completes. +20. The structure and order of listing of terms in the Quick Reference Guide is controlled by the file [qrg-list.csv](https://github.com/tdwg/dwc/blob/master/build/qrg-list.csv). It is very sensitive to the position of the class terms, which controls the division of the QRG into sections. Also, `http://purl.org/dc/terms/language` must be the first term in the section that will be labeled "Use with IRI". So it must be edited with some care. If new terms are added, their IRIs must be added in the proper place in this document in order for them to appear in the QRG. +21. Run the [generate_term_versions.py](https://github.com/tdwg/dwc/blob/master/build/generate_term_versions.py) script to generate a new version of [term_versions.csv](https://github.com/tdwg/dwc/blob/master/vocabulary/term_versions.csv). This file serves as the source of data for the build script in the next step. At some point, that script may be modified to eliminate this intermediate step. +22. Run the [build.py](https://github.com/tdwg/dwc/blob/master/build/build.py) script to build the Quick Reference Guide. +23. Create a pull request for the new branch. +24. When the branch has been reviewed carefully, merge the branch. The new pages shuld be live as soon as Jekyll rebuilds them on GitHub. +25. Term dereferencing to human and machine readable representations is handled by a server managed by GBIF. The new metadata gets fed into the production version of the server when there is a new release of the `rs.tdwg.org` repo, so when everything is done, make sure there a new release has been made. Because dereferencing of current terms to human-readable web pages is handled by a redirect, there won't be any noticeable difference whether the data are reloaded in this step or not. But dereferencing the term versions, or dereferencing to acquire machine readable metadata will not reflect the new changes until the release process completes. ## Build script diff --git a/build/generate_term_versions.py b/build/generate_term_versions.py index 19aaae2..7322194 100644 --- a/build/generate_term_versions.py +++ b/build/generate_term_versions.py @@ -119,6 +119,7 @@ for row_index,row in accumulated_frame.iterrows(): normative_doc_row.append(row[column_mapping['accum']]) normative_doc_list.append(normative_doc_row) +''' NO LONGER NEEDED FOR HANDLING OF IRI VALUED TERMS # special handling for http://rs.tdwg.org/dwc/terms/attributes/UseWithIRI. Eventually we want to eliminate this. use_with_iri_row = ['http://rs.tdwg.org/dwc/terms/attributes/UseWithIRI-2017-10-06', 'UseWithIRI', @@ -135,6 +136,7 @@ use_with_iri_row = ['http://rs.tdwg.org/dwc/terms/attributes/UseWithIRI-2017-10- 'not in ABCD', ''] normative_doc_list.append(use_with_iri_row) +''' # Turn list of lists into dataframe normative_doc_df = pd.DataFrame(normative_doc_list, columns = column_headers) diff --git a/build/qrg-list.csv b/build/qrg-list.csv index eabfe92..9383747 100644 --- a/build/qrg-list.csv +++ b/build/qrg-list.csv @@ -205,7 +205,6 @@ http://rs.tdwg.org/dwc/terms/relationshipOfResource http://rs.tdwg.org/dwc/terms/relationshipAccordingTo http://rs.tdwg.org/dwc/terms/relationshipEstablishedDate http://rs.tdwg.org/dwc/terms/relationshipRemarks -http://rs.tdwg.org/dwc/terms/attributes/UseWithIRI http://purl.org/dc/terms/language http://rs.tdwg.org/dwc/iri/inDescribedPlace http://rs.tdwg.org/dwc/iri/identifiedBy