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

Update README.md

This commit is contained in:
John Wieczorek 2020-11-07 20:36:28 -03:00 committed by GitHub
parent 87bfd242c6
commit 9c19d91516
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 44 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
README.md
View File

@ -1,6 +1,6 @@
# Darwin Core
Darwin Core is a standard maintained by the Darwin Core maintenance group. 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.
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.
## Getting started
@ -23,39 +23,52 @@ Community:
The repository structure is described below. Files/directories indicated with `GENERATED` should not be edited manually.
```
├── README.md : Description of this repository
├── LICENSE : Repository license
│
├── standard : All content considered part of the Darwin Core standard
│ ├── vocabularies
│ │ └── term_versions.csv : Darwin Core term versions history
│ │
│ └── documents
│   ├── simple : Simple Darwin Core guide
│  ├── rdf : RDF guide
│  ├── text : Text guide
│   └── xml : XML guide
│
├── www : GENERATED Darwin Core website
│ └── guides
│   └── index.html : GENERATED Darwin Core quick reference guide
│
├── dist : GENERATED Distribution files generated by build.py
│   ├── dwc_terms.csv : GENERATED CSV file with the recommended Darwin Core terms, definitions, etc.
│   ├── 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
├── .github
│ ├── ISSUE_TEMPLATE : Directory of issue templates generated by GitHub
│ ├── CONTRIBUTING.md : Guide on how to contribute, create issues, etc.
│
├── build
│   ├── build.py           : Build script to generate distribution files from the normative document
│ └── config : Configuration files for build.py
│   ├── index.tmpl       : Template for index.html
│ └── terms.csv : Configuration for the recommended terms, incl. order, labels, examples
│ ├── 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
│ ├── README.md : Workflow for generating a new version of the vocabulary
│ ├── build-termlist.ipynb : Juyter notebook to construct the term list
│ ├── 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
│ └── workflow_diagram.png : Figure used in README.md to show how to create a new version of the standard
├── dist : GENERATED Distribution files generated by build.py
│   ├── 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
│
├── .github
│ ├── CONTRIBUTING.md : Guide on how to contribute to Darwin Core
│ └── ISSUE_TEMPLATE.md : Template for issues
├── docs
│ ├── 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
│ ├── terms
│ │ └── index.md : Content for Quick Reference Guide generation using Jekyll
│ │
│ ├── text : Darwin Core Text Guide (Darwin Core Archive specification)
│ ├── xml : Darwin Core XML Guide
│ ├── _config.yml : Jekyll site configuration for Quick Reference Guide
│ ├── CNAME : Canonical Name record for dwc.tdwg.org
│ └── index.md : Header for Darwin Core web site generation using Jekyll
│
└── .gitignore : Files and directories to be ignored by git
├── vocabulary
│ └── term_versions.csv : Darwin Core term versions, contains the complete history of the terms
│
├── .gitignore : Files and directories to be ignored by git
├── LICENSE : Repository license
└── README.md : Description of this repository
```
## Contributors
@ -74,6 +87,6 @@ For Darwin Core in general, consider the peer-reviewed article on Darwin Core:
For this repository:
> Darwin Core maintenance group, Biodiversity Information Standards (TDWG) (2014). Darwin Core. Zenodo. https://doi.org/10.5281/zenodo.592792
> Darwin Core Maintenance Interest Group, Biodiversity Information Standards (TDWG) (2014). Darwin Core. Zenodo. https://doi.org/10.5281/zenodo.592792
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.