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

Merge pull request #366 from tdwg/fix_dcterms 

fixed dcterms: versions in QRG
This commit is contained in:
John Wieczorek 2021-08-04 17:51:09 -03:00 committed by GitHub
parent 8d38cba021 6a595447e4
commit c86e206c60
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
build/README.md
View File

@ -9,10 +9,10 @@
5. If a new term is being added, fill in a new row anywhere below the header row. 5. If a new term is being added, fill in a new row anywhere below the header row.
6. Special care must be taken if columns are added (i.e. metadata properties are added). This is not for the faint of heart! The new columns must be added to every file used as source data for the various scripts and the column header mapping files also need to be edited. See [this page](for more details). This should be a rare event. DO NOT ever delete columns! If you want to elimite values for a property, just leave empty strings in all of the cells of that property's column. 6. Special care must be taken if columns are added (i.e. metadata properties are added). This is not for the faint of heart! The new columns must be added to every file used as source data for the various scripts and the column header mapping files also need to be edited. See [this page](for more details). This should be a rare event. DO NOT ever delete columns! If you want to elimite values for a property, just leave empty strings in all of the cells of that property's column.
7. Create a new branch (or fork if you don't have push rights) of the [rs.tdwg.org repo](https://github.com/tdwg/rs.tdwg.org). Save your edited CSV file using some notable name in the [process](https://github.com/tdwg/rs.tdwg.org/tree/master/process) directory. 7. Create a new branch (or fork if you don't have push rights) of the [rs.tdwg.org repo](https://github.com/tdwg/rs.tdwg.org). Save your edited CSV file using some notable name in the [process](https://github.com/tdwg/rs.tdwg.org/tree/master/process) directory.
8. Open the [simplified_process_rs_tdwg_org.ipynb](https://github.com/tdwg/rs.tdwg.org/blob/master/process/simplified_process_rs_tdwg_org.ipynb) Jupyter notebook and follow [these instructions](https://github.com/tdwg/rs.tdwg.org/blob/master/process/process-vocabulary.md#21-setup) to edit the configuration section of the script. 8. Repeat this process for all namespaces that will be changed. I've been saving copies of the changes in [this directory](https://github.com/tdwg/rs.tdwg.org/tree/master/process/dwc-revisions) so that we can easily see what's been done in the past. Modify the [configuration file](https://github.com/tdwg/rs.tdwg.org/blob/master/process/config.json) so that it points to each CSV for each namespace. Look at the example to see what needs to be there.
9. Run the script, paying careful attention to whether particular sections are appropriate for what you are trying to accomplish. NOTE: there are still some kinks to be worked out for the borrowed terms (`dc:` and `dcterms:` namespaces), but changes there should be rare. It is useful to monitor the diffs that are generated as sections of the script are run and make sure that the changes are reasonable. This is easily monitored if you are using the GitHub desktop client. 9. Run the [processing script](https://github.com/tdwg/rs.tdwg.org/blob/master/process/process.py), which needs to be in the same directory as the configuration file.
10. If there are changes to more than one namespace, repeat all of the previous steps with the second namespace before continuing on. 10. There are some manual edits that need to be made if there are changes to either of the Dublin Core namespace terms. The versions don't get handled very automatically, so make the same changes to the [dcterms: version CSV](https://github.com/tdwg/rs.tdwg.org/blob/master/dcterms-for-dwc-versions/dcterms-for-dwc-versions.csv) or [dc: version CSV](https://github.com/tdwg/rs.tdwg.org/blob/master/dc-for-dwc-versions/dc-for-dwc-versions.csv) as were made to the main term CSVs.
11. When you are satisfied that all of the term, term list, vocabulary, and standards metadata changes are sensible, discard the changes made to the Jupyter notebook so that it will remain in it's "example" stage when the branch (or fork) is merged. Alternately, you can download the "example" notebook from GitHub to write over the version that you modified, and commit it to the branch. 11. The versions also need to be manually added for the new termlist version in the [termlist versions members CSV](https://github.com/tdwg/rs.tdwg.org/blob/master/term-lists-versions/term-lists-versions-members.csv). In the future, this may get automated.
12. As of 2020-08-20, updating rs.tdwg.org document metadata must be done manually. Steve Baskauf knows how to do it and will try to eventually write a script to automate the process. It's best to ask him to do the updating before merging the branch. 12. As of 2020-08-20, updating rs.tdwg.org document metadata must be done manually. Steve Baskauf knows how to do it and will try to eventually write a script to automate the process. It's best to ask him to do the updating before merging the branch.
13. Push the branch to GitHub and create a pull request. It is best for someone to review the changes carefully before merging. 13. Push the branch to GitHub and create a pull request. It is best for someone to review the changes carefully before merging.
14. Once the branch has been merged the data are available via HTTP to the other scripts that use those data. 14. Once the branch has been merged the data are available via HTTP to the other scripts that use those data.
@ -25,7 +25,7 @@
21. Run the [build.py](https://github.com/tdwg/dwc/blob/master/build/build.py) script to build the Quick Reference Guide. 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. 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. 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. Ask Matt Blissett to reload the data from the `rs.tdwg.org` repo into the server (he has a script to do it.). 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 server is reloaded. 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.
## Build script ## Build script
@ -65,4 +65,4 @@ It generates the file `term_versions.csv`, which is used as the input for the `b
The Python script `build-termlist.py` 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`. The Python script `build-termlist.py` 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`.
------ ------
Last edited: 2020-08-20 Last edited: 2021-08-04

8
docs/terms/index.md
View File

@ -112,8 +112,8 @@ This category contains terms that are generic in that they might apply to any ty
<tr class="table-secondary"><th colspan="2">bibliographicCitation <span class="badge badge-secondary float-right">Property</span></th></tr> <tr class="table-secondary"><th colspan="2">bibliographicCitation <span class="badge badge-secondary float-right">Property</span></th></tr>
<tr><td class="theme-label">Identifier</td><td><a href="http://purl.org/dc/terms/bibliographicCitation">http://purl.org/dc/terms/bibliographicCitation</a></td></tr> <tr><td class="theme-label">Identifier</td><td><a href="http://purl.org/dc/terms/bibliographicCitation">http://purl.org/dc/terms/bibliographicCitation</a></td></tr>
<tr><td class="theme-label">Definition</td><td>A bibliographic reference for the resource as a statement indicating how this record should be cited (attributed) when used.</td></tr> <tr><td class="theme-label">Definition</td><td>A bibliographic reference for the resource as a statement indicating how this record should be cited (attributed) when used.</td></tr>
<tr><td class="theme-label">Comments</td><td>Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible.</td></tr> <tr><td class="theme-label">Comments</td><td>From Dublin Core, "Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible." The intended usage of this term in Darwin Core is to provide the preferred way to cite the resource itself - "how to cite this record". Note that the intended usage of dcterms:references in Darwin Core, by contrast, is to point to the definitive source representation of the resource - "where to find the as-close-to-original reference, if one is available.</td></tr>
<tr><td class="theme-label">Examples</td><td>Specimen example: <code>Museum of Vertebrate Zoology, UC Berkeley. MVZ Mammal Collection (Arctos). Record ID: <a href="http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356">http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356</a>. Source: <a href="http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal">http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal</a></code>. Taxon example: <code>Oliver P. Pearson. 1985. Los tuco-tucos (genera Ctenomys) de los Parques Nacionales Lanin y Nahuel Huapi, Argentina Historia Natural, 5(37):337-343.</code>.</td></tr> <tr><td class="theme-label">Examples</td><td>Occurrence example: <code>Museum of Vertebrate Zoology, UC Berkeley. MVZ Mammal Collection (Arctos). Record ID: <a href="http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356">http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356</a>. Source: <a href="http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal">http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal</a>.</code> Taxon example: <code><a href="https://www.gbif.org/species/2439608">https://www.gbif.org/species/2439608</a> Source: GBIF Taxonomic Backbone</code>, Event example: <code>Rand, K.M., Logerwell, E.A. The first demersal trawl survey of benthic fish and invertebrates in the Beaufort Sea since the late 1970s. Polar Biol 34, 475–488 (2011). <a href="https://doi.org/10.1007/s00300-010-0900-2">https://doi.org/10.1007/s00300-010-0900-2</a></code></td></tr>
</tbody> </tbody>
</table> </table>
<p class="invisible"> <p class="invisible">
@ -123,8 +123,8 @@ This category contains terms that are generic in that they might apply to any ty
<tr class="table-secondary"><th colspan="2">references <span class="badge badge-secondary float-right">Property</span></th></tr> <tr class="table-secondary"><th colspan="2">references <span class="badge badge-secondary float-right">Property</span></th></tr>
<tr><td class="theme-label">Identifier</td><td><a href="http://purl.org/dc/terms/references">http://purl.org/dc/terms/references</a></td></tr> <tr><td class="theme-label">Identifier</td><td><a href="http://purl.org/dc/terms/references">http://purl.org/dc/terms/references</a></td></tr>
<tr><td class="theme-label">Definition</td><td>A related resource that is referenced, cited, or otherwise pointed to by the described resource.</td></tr> <tr><td class="theme-label">Definition</td><td>A related resource that is referenced, cited, or otherwise pointed to by the described resource.</td></tr>
<tr><td class="theme-label">Comments</td><td></td></tr> <tr><td class="theme-label">Comments</td><td>From Dublin Core, "This property is intended to be used with non-literal values. This property is an inverse property of Is Referenced By." The intended usage of this term in Darwin Core is to point to the definitive source representation of the resource (e.g.,Taxon, Occurrence, Event in Darwin Core), if one is available. Note that the intended usage of dcterms:bibliographicCitation in Darwin Core, by contrast, is to provide the preferred way to cite the resource itself.</td></tr>
<tr><td class="theme-label">Examples</td><td><code><a href="http://arctos.database.museum/guid/MVZ:Mamm:165861">http://arctos.database.museum/guid/MVZ:Mamm:165861</a></code>, <code><a href="http://www.catalogueoflife.org/annual-checklist/show_species_details.php?record_id=6197868">http://www.catalogueoflife.org/annual-checklist/show_species_details.php?record_id=6197868</a></code></td></tr> <tr><td class="theme-label">Examples</td><td>MaterialSample example: <code><a href="http://arctos.database.museum/guid/MVZ:Mamm:165861">http://arctos.database.museum/guid/MVZ:Mamm:165861</a></code>, Taxon example: <code><a href="https://www.catalogueoflife.org/data/taxon/32664">https://www.catalogueoflife.org/data/taxon/32664</a></code></td></tr>
</tbody> </tbody>
</table> </table>
<p class="invisible"> <p class="invisible">

4
vocabulary/term_versions.csv
View File

@ -5,8 +5,8 @@ http://dublincore.org/usage/terms/history/#language-007,language,Language,A lang
http://dublincore.org/usage/terms/history/#license-002,license,License,A legal document giving official permission to do something with the resource.,,"`http://creativecommons.org/publicdomain/zero/1.0/legalcode`, `http://creativecommons.org/licenses/by/4.0/legalcode`",http://purl.org/dc/terms/,2008-01-14,recommended,http://dublincore.org/usage/terms/history/#rightsT-001,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/license,not in ABCD,simple http://dublincore.org/usage/terms/history/#license-002,license,License,A legal document giving official permission to do something with the resource.,,"`http://creativecommons.org/publicdomain/zero/1.0/legalcode`, `http://creativecommons.org/licenses/by/4.0/legalcode`",http://purl.org/dc/terms/,2008-01-14,recommended,http://dublincore.org/usage/terms/history/#rightsT-001,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/license,not in ABCD,simple
http://dublincore.org/usage/terms/history/#rightsHolder-002,rightsHolder,Rights Holder,A person or organization owning or managing rights over the resource.,,`The Regents of the University of California`,http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/rightsHolder,not in ABCD,simple http://dublincore.org/usage/terms/history/#rightsHolder-002,rightsHolder,Rights Holder,A person or organization owning or managing rights over the resource.,,`The Regents of the University of California`,http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/rightsHolder,not in ABCD,simple
http://dublincore.org/usage/terms/history/#accessRights-002,accessRights,Access Rights,Information about who can access the resource or an indication of its security status.,"Access Rights may include information regarding access or restrictions based on privacy, security, or other policies.","`not-for-profit use only`, `https://www.fieldmuseum.org/field-museum-natural-history-conditions-and-suggested-norms-use-collections-data-and-images`",http://purl.org/dc/terms/,2008-01-14,recommended,http://rs.tdwg.org/dwc/terms/version/AccessConstraints-2008-11-19,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/accessRights,not in ABCD,simple http://dublincore.org/usage/terms/history/#accessRights-002,accessRights,Access Rights,Information about who can access the resource or an indication of its security status.,"Access Rights may include information regarding access or restrictions based on privacy, security, or other policies.","`not-for-profit use only`, `https://www.fieldmuseum.org/field-museum-natural-history-conditions-and-suggested-norms-use-collections-data-and-images`",http://purl.org/dc/terms/,2008-01-14,recommended,http://rs.tdwg.org/dwc/terms/version/AccessConstraints-2008-11-19,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/accessRights,not in ABCD,simple
http://dublincore.org/usage/terms/history/#bibliographicCitation-002,bibliographicCitation,Bibliographic Citation,A bibliographic reference for the resource as a statement indicating how this record should be cited (attributed) when used.,Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible.,"Specimen example: `Museum of Vertebrate Zoology, UC Berkeley. MVZ Mammal Collection (Arctos). Record ID: http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356. Source: http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal`. Taxon example: `Oliver P. Pearson. 1985. Los tuco-tucos (genera Ctenomys) de los Parques Nacionales Lanin y Nahuel Huapi, Argentina Historia Natural, 5(37):337-343.`.",http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/bibliographicCitation,not in ABCD,simple http://dublincore.org/usage/terms/history/#bibliographicCitation-002,bibliographicCitation,Bibliographic Citation,A bibliographic reference for the resource as a statement indicating how this record should be cited (attributed) when used.,"From Dublin Core, ""Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible."" The intended usage of this term in Darwin Core is to provide the preferred way to cite the resource itself - ""how to cite this record"". Note that the intended usage of dcterms:references in Darwin Core, by contrast, is to point to the definitive source representation of the resource - ""where to find the as-close-to-original reference, if one is available.","Occurrence example: `Museum of Vertebrate Zoology, UC Berkeley. MVZ Mammal Collection (Arctos). Record ID: http://arctos.database.museum/guid/MVZ:Mamm:165861?seid=101356. Source: http://ipt.vertnet.org:8080/ipt/resource.do?r=mvz_mammal.` Taxon example: `https://www.gbif.org/species/2439608 Source: GBIF Taxonomic Backbone`, Event example: `Rand, K.M., Logerwell, E.A. The first demersal trawl survey of benthic fish and invertebrates in the Beaufort Sea since the late 1970s. Polar Biol 34, 475–488 (2011). https://doi.org/10.1007/s00300-010-0900-2`",http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/bibliographicCitation,not in ABCD,simple
http://dublincore.org/usage/terms/history/#references-003,references,References,"A related resource that is referenced, cited, or otherwise pointed to by the described resource.",,"`http://arctos.database.museum/guid/MVZ:Mamm:165861`, `http://www.catalogueoflife.org/annual-checklist/show_species_details.php?record_id=6197868`",http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/references,not in ABCD,simple http://dublincore.org/usage/terms/history/#references-003,references,References,"A related resource that is referenced, cited, or otherwise pointed to by the described resource.","From Dublin Core, ""This property is intended to be used with non-literal values. This property is an inverse property of Is Referenced By."" The intended usage of this term in Darwin Core is to point to the definitive source representation of the resource (e.g.,Taxon, Occurrence, Event in Darwin Core), if one is available. Note that the intended usage of dcterms:bibliographicCitation in Darwin Core, by contrast, is to provide the preferred way to cite the resource itself.","MaterialSample example: `http://arctos.database.museum/guid/MVZ:Mamm:165861`, Taxon example: `https://www.catalogueoflife.org/data/taxon/32664`",http://purl.org/dc/terms/,2008-01-14,recommended,,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://purl.org/dc/terms/references,not in ABCD,simple
http://rs.tdwg.org/dwc/terms/version/institutionID-2017-10-06,institutionID,Institution ID,An identifier for the institution having custody of the object(s) or information referred to in the record.,"For physical specimens, the recommended best practice is to use an identifier from a collections registry such as the Global Registry of Biodiversity Repositories (http://grbio.org/).","`http://biocol.org/urn:lsid:biocol.org:col:34777`, `http://grbio.org/cool/km06-gtbn`",http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/institutionID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/institutionID,DataSets/DataSet/Units/Unit/SourceInstitutionID,simple http://rs.tdwg.org/dwc/terms/version/institutionID-2017-10-06,institutionID,Institution ID,An identifier for the institution having custody of the object(s) or information referred to in the record.,"For physical specimens, the recommended best practice is to use an identifier from a collections registry such as the Global Registry of Biodiversity Repositories (http://grbio.org/).","`http://biocol.org/urn:lsid:biocol.org:col:34777`, `http://grbio.org/cool/km06-gtbn`",http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/institutionID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/institutionID,DataSets/DataSet/Units/Unit/SourceInstitutionID,simple
http://rs.tdwg.org/dwc/terms/version/collectionID-2017-10-06,collectionID,Collection ID,An identifier for the collection or dataset from which the record was derived.,"For physical specimens, the recommended best practice is to use an identifier from a collections registry such as the Global Registry of Biodiversity Repositories (http://grbio.org/).","`http://biocol.org/urn:lsid:biocol.org:col:1001`, `http://grbio.org/cool/p5fp-c036`",http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/collectionID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/collectionID,DataSets/DataSet/Units/Unit/SourceID,simple http://rs.tdwg.org/dwc/terms/version/collectionID-2017-10-06,collectionID,Collection ID,An identifier for the collection or dataset from which the record was derived.,"For physical specimens, the recommended best practice is to use an identifier from a collections registry such as the Global Registry of Biodiversity Repositories (http://grbio.org/).","`http://biocol.org/urn:lsid:biocol.org:col:1001`, `http://grbio.org/cool/p5fp-c036`",http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/collectionID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/collectionID,DataSets/DataSet/Units/Unit/SourceID,simple
http://rs.tdwg.org/dwc/terms/version/datasetID-2017-10-06,datasetID,Dataset ID,An identifier for the set of data. May be a global unique identifier or an identifier specific to a collection or institution.,,`b15d4952-7d20-46f1-8a3e-556a512b04c5`,http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/datasetID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/datasetID,DataSets/DataSet/DataSetGUID,simple http://rs.tdwg.org/dwc/terms/version/datasetID-2017-10-06,datasetID,Dataset ID,An identifier for the set of data. May be a global unique identifier or an identifier specific to a collection or institution.,,`b15d4952-7d20-46f1-8a3e-556a512b04c5`,http://rs.tdwg.org/dwc/terms/,2017-10-06,recommended,http://rs.tdwg.org/dwc/terms/version/datasetID-2009-09-11,http://www.w3.org/1999/02/22-rdf-syntax-ns#Property,http://rs.tdwg.org/dwc/terms/datasetID,DataSets/DataSet/DataSetGUID,simple

Can't render this file because it is too large.