2014-11-13 14:39:18 +00:00
# Darwin Core
2020-11-07 23:36:28 +00:00
Darwin Core is a standard maintained by the [Darwin Core Maintenance Interest Group ](https://www.tdwg.org/standards/dwc/#maintenance%20group ). It includes a glossary of terms (in other contexts these might be called properties, elements, fields, columns, attributes, or concepts) intended to **facilitate the sharing of information about biological diversity** by providing identifiers, labels, and definitions. Darwin Core is primarily based on taxa, their occurrence in nature as documented by observations, specimens, samples, and related information.
2014-11-13 14:39:18 +00:00
2017-09-30 16:11:01 +00:00
## Getting started
2017-02-03 16:03:06 +00:00
2023-02-03 12:59:43 +00:00
[Darwin Core Quick Reference Guide ](https://dwc.tdwg.org/terms/ )
2014-11-13 14:39:18 +00:00
2017-09-30 16:11:01 +00:00
Documents:
2024-02-19 15:03:07 +00:00
- [List of terms document ](https://dwc.tdwg.org/list/ ): Comprehensive metadata for current and obsolete terms in human readable form
2023-02-03 12:59:43 +00:00
- [Complete term history table ](vocabulary/term_versions.csv ): A CSV file with the full version history of Darwin Core terms
- [Distribution documents ](dist/ ): Simple CSV files to start using Darwin Core
- [Website documents ](docs/ ): Markdown files that form the source for the [Darwin Core website ](https://dwc.tdwg.org/ )
2017-09-30 16:11:01 +00:00
Community:
2023-02-03 12:59:43 +00:00
- [How to contribute ](.github/CONTRIBUTING.md ): a guide on how to contribute to Darwin Core
- [Darwin Core Q&A ](https://github.com/tdwg/dwc-qa ): an open forum on the use of Darwin Core
2014-11-13 14:39:18 +00:00
2017-09-30 03:49:10 +00:00
## Repo structure
The repository structure is described below. Files/directories indicated with `GENERATED` should not be edited manually.
```
2020-11-07 23:36:28 +00:00
├── .github
│ ├── ISSUE_TEMPLATE : Directory of issue templates generated by GitHub
2024-02-19 15:03:07 +00:00
│ └── CONTRIBUTING.md : Guide on how to contribute, create issues, etc.
2017-09-30 16:11:36 +00:00
│
2020-11-07 23:36:28 +00:00
├── build
2024-02-19 15:03:07 +00:00
│ ├── doe-cv-build : Directory of build scripts for the degreeOfEstablishment controlled vocabulary
│ ├── dwc_terms_guides_rdf : Directory containing editable template for generating RDF guide
│ ├── dwc_terms_guides_text : Directory containing editable template for generating text guide
│ ├── dwc_terms_guides_xml : Directory containing editable template for generating XML guide
│ ├── dwc_terms_namespace : Directory containing editable template for generating namespace policy
│ ├── dwc_terms_simple : Directory containing editable template for generating Simple DwC guide
│ ├── doe-cv-build : Directory of build scripts for the degreeOfEstablishment controlled vocabulary
│ ├── em-cv-build : Directory of build scripts for the establishmentMeans controlled vocabulary
│ ├── pw-cv-build : Directory of build scripts for the pathway controlled vocabulary
│ ├── xml : Directory of build script and configs for XML extension definitions
│ ├── ext : Directory for GENERATED XML extension definitions
2020-11-07 23:36:28 +00:00
│ ├── README.md : Workflow for generating a new version of the vocabulary
2023-09-17 20:50:51 +00:00
│ ├── build_other_doc_header.py : Script to build non-list of terms documents from their editable templates
│ ├── build-termlist.ipynb : Obsolete Juyter notebook to construct the term list (morphed to .py version)
2020-11-07 23:36:28 +00:00
│ ├── build-temlist.py : Script to build Markdown pages that provide term metadata for complex vocabularies
│ ├── build.py : Build script to generate distribution files from the normative document
│ ├── generate_term_versions.py : Script to build the terms_versions.csv file
│ ├── qrg-list.csv : List of the term IRIs in the order that they are to appear in the Quick Reference Guide
│ ├── requirements.txt : List of libraries required by the build scripts
│ ├── termlist-footer.md : Footer to append to the generated term list document
│ ├── termlist-header.md : Header to prepend to the generated term list document
│ ├── terms.tmpl : A Jinja2 template to format the Quick Reference Guide
2023-09-17 20:50:51 +00:00
│ ├── update_previous_doc.py : Script to move current doc to a version and update version links in it
2020-11-07 23:36:28 +00:00
│ └── workflow_diagram.png : Figure used in README.md to show how to create a new version of the standard
2024-02-19 15:03:07 +00:00
│
2020-11-07 23:36:28 +00:00
├── dist : GENERATED Distribution files generated by build.py
2024-02-19 15:03:07 +00:00
│ ├── all_dwc_vertical.csv : GENERATED CSV file with all Darwin Core terms as a column
│ ├── simple_dwc_horizontal.csv : GENERATED CSV file with Simple Darwin Core terms as a row
│ └── simple_dwc_vertical.csv : GENERATED CSV file with Simple Darwin Core terms as a column
2017-09-30 16:11:36 +00:00
│
2023-09-17 20:50:51 +00:00
├── docs (GENERATED except for index.md)
2020-11-07 23:36:28 +00:00
│ ├── doe : Degree of Establishment Controlled Vocabulary List of Terms
│ ├── em : Establishment Means Controlled Vocabulary List of Terms
│ ├── list : Darwin Core List of Terms documents
│ ├── namespace : Darwin Core namespace policy
│ ├── pw : Pathway Controlled Vocabulary List of Terms
│ ├── rdf : Darwin Core RDF Guide
│ ├── simple : Simple Darwin Core Guide
2023-04-04 10:32:55 +00:00
│ ├── terms : GENERATED Quick Reference Guide
2020-11-07 23:36:28 +00:00
│ ├── text : Darwin Core Text Guide (Darwin Core Archive specification)
│ ├── xml : Darwin Core XML Guide
2023-04-04 10:32:55 +00:00
│ ├── _data : Website navigation and footer
│ ├── _config.yml : Jekyll site configuration
2020-11-07 23:36:28 +00:00
│ ├── CNAME : Canonical Name record for dwc.tdwg.org
2023-09-17 20:50:51 +00:00
│ └── index.md : Website home page (manually maintained)
2017-09-30 03:49:10 +00:00
│
2020-11-07 23:36:28 +00:00
├── vocabulary
2024-02-19 15:03:07 +00:00
│ └── term_versions.csv : GENERATED Darwin Core term versions, contains the complete history of the terms
2017-09-30 03:49:10 +00:00
│
2020-11-07 23:36:28 +00:00
├── .gitignore : Files and directories to be ignored by git
├── LICENSE : Repository license
└── README.md : Description of this repository
2017-09-30 03:49:10 +00:00
```
2017-09-30 15:08:31 +00:00
## Contributors
[List of contributors ](https://github.com/tdwg/dwc/contributors )
2014-11-13 14:39:18 +00:00
## License
2017-09-30 15:11:20 +00:00
[Creative Commons Attribution 4.0 International License ](http://creativecommons.org/licenses/by/4.0/ )
2014-11-13 14:39:18 +00:00
2017-09-30 15:15:24 +00:00
## Recommended citation
2014-11-13 14:39:18 +00:00
2017-09-30 15:15:24 +00:00
For Darwin Core in general, consider the peer-reviewed article on Darwin Core:
2014-11-13 14:39:18 +00:00
2017-09-30 15:15:24 +00:00
> Wieczorek J, Bloom D, Guralnick R, Blum S, Döring M, et al. (2012) Darwin Core: An Evolving Community-Developed Biodiversity Data Standard. PLoS ONE 7(1): e29715. https://doi.org/10.1371/journal.pone.0029715
2014-11-13 14:39:18 +00:00
2017-09-30 15:15:24 +00:00
For this repository:
2014-11-13 14:39:18 +00:00
2020-11-07 23:36:28 +00:00
> Darwin Core Maintenance Interest Group, Biodiversity Information Standards (TDWG) (2014). Darwin Core. Zenodo. https://doi.org/10.5281/zenodo.592792
2017-09-30 15:15:24 +00:00
The citation above represents all versions of the repository. Specific [versions/releases ](https://github.com/tdwg/dwc/releases ) from 2011 onwards are also deposited on Zenodo.
