mirror of https://github.com/tdwg/dwc.git
Consistently write Quick Reference Guide in title case
This commit is contained in:
peterdesmet
parent
ec634bc63f
commit
bc54b5c403
14
README.md
14
README.md
|
|
@ -4,19 +4,19 @@ Darwin Core is a standard maintained by the [Darwin Core Maintenance Interest Gr
|
|||
|
||||
## Getting started
|
||||
|
||||
[Darwin Core quick reference guide](https://dwc.tdwg.org/terms/)
|
||||
[Darwin Core Quick Reference Guide](https://dwc.tdwg.org/terms/)
|
||||
|
||||
Documents:
|
||||
|
||||
* [List of terms document](https://dwc.tdwg.org/list/): Comprehensive metadata for current and obsolete terms in human readable form
|
||||
* [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/)
|
||||
- [List of terms document](https://dwc.tdwg.org/list/): Comprehensive metadata for current and obsolete terms in human readable form
|
||||
- [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/)
|
||||
|
||||
Community:
|
||||
|
||||
* [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
|
||||
- [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
|
||||
|
||||
## Repo structure
|
||||
|
||||
|
|
|
|||
|
|
@ -33,13 +33,13 @@
|
|||
|
||||
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
|
||||
- [vocabulary/term_versions.csv](../vocabulary/term_versions.csv): the list of terms
|
||||
- [terms.tmpl](terms.tmpl): a Jinja2 template for the Quick Reference Guide
|
||||
|
||||
And creates:
|
||||
|
||||
* The quick reference guide is a Markdown file at [docs/terms/index.md](../docs/terms/index.md). The guide is built as Markdown (with a lot of included html) rather than html, so it can be incorporated by Jekyll in the Darwin Core website (including a header, footer and table of contents).
|
||||
* Two simple Darwin Core CSV files in [dist/](../dist/)
|
||||
- The Quick Reference Guide is a Markdown file at [docs/terms/index.md](../docs/terms/index.md). The guide is built as Markdown (with a lot of included html) rather than html, so it can be incorporated by Jekyll in the Darwin Core website (including a header, footer and table of contents).
|
||||
- Two simple Darwin Core CSV files in [dist/](../dist/)
|
||||
|
||||
## Run the build script
|
||||
|
||||
|
|
|
|||
|
|
@ -307,13 +307,13 @@ class DwcDigester(object):
|
|||
dwc_header_file.write("\n")
|
||||
|
||||
def main():
|
||||
"""Building up the quick reference html and derivatives"""
|
||||
"""Building up the Quick Reference Guide html and derivatives"""
|
||||
|
||||
term_versions_file = "../vocabulary/term_versions.csv"
|
||||
|
||||
print("Running build process:")
|
||||
my_dwc = DwcDigester(term_versions_file)
|
||||
print("Building quick reference guide")
|
||||
print("Building Quick Reference Guide")
|
||||
my_dwc.create_html()
|
||||
print("Building simple DwC CSV files")
|
||||
my_dwc.create_dwc_list()
|
||||
|
|
|
|||
|
|
@ -156,7 +156,7 @@ built_rows_df = normative_doc_df.iloc[1:0].copy()
|
|||
# DataFrame to hold remaining rows
|
||||
remaining_rows_df = normative_doc_df.copy()
|
||||
|
||||
# Load the ordered list of terms in the quick reference guide (single column named recommended_term_iri)
|
||||
# Load the ordered list of terms in the Quick Reference Guide (single column named recommended_term_iri)
|
||||
print('ordering rows for output document')
|
||||
qrg_df = pd.read_csv('qrg-list.csv', na_filter=False)
|
||||
for qrg_index,qrg_row in qrg_df.iterrows():
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
container: fluid
|
||||
---
|
||||
|
||||
# Darwin Core quick reference guide
|
||||
# Darwin Core Quick Reference Guide
|
||||
|
||||
This document is intended to be an easy-to-read reference of the currently (as of 2021-07-15) recommended terms maintained as part of the [Darwin Core standard](https://www.tdwg.org/standards/dwc/) and is maintained by the [Darwin Core Maintenance Group](https://www.tdwg.org/community/dwc/).
|
||||
|
||||
|
|
@ -64,6 +64,7 @@ For more information on `UseWithIRI`, see [Section 2.5 of the RDF Guide](https:/
|
|||
{% endfor %}
|
||||
|
||||
# Cite Darwin Core
|
||||
|
||||
To cite Darwin Core in general, use the peer-reviewed article on Darwin Core:
|
||||
|
||||
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>
|
||||
|
|
@ -74,4 +75,4 @@ Darwin Core Maintenance Group. 2021. List of Darwin Core terms. Biodiversity Inf
|
|||
|
||||
To cite this document specifically, use the following:
|
||||
|
||||
Darwin Core Maintenance Group. 2021. Darwin Core quick reference guide. Biodiversity Information Standards (TDWG). <https://dwc.tdwg.org/terms/>
|
||||
Darwin Core Maintenance Group. 2021. Darwin Core Quick Reference Guide. Biodiversity Information Standards (TDWG). <https://dwc.tdwg.org/terms/>
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ layout: home
|
|||
|
||||
## Getting started
|
||||
|
||||
* [Quick reference guide](terms/)
|
||||
* Usage guides: how to use Darwin Core as [Simple Darwin Core](simple/), [Text (Darwin Core Archives)](text/), [XML](xml/) or [RDF](rdf/)
|
||||
* [GitHub repository](https://github.com/tdwg/dwc): where Darwin Core is maintained
|
||||
* [Normative term list](list/): the document containing the full history of normative Darwin Core term definitions
|
||||
* [Distribution files](https://github.com/tdwg/dwc/tree/master/dist): convenient files to start using Darwin Core
|
||||
- [Quick Reference Guide](terms/)
|
||||
- Usage guides: how to use Darwin Core as [Simple Darwin Core](simple/), [Text (Darwin Core Archives)](text/), [XML](xml/) or [RDF](rdf/)
|
||||
- [GitHub repository](https://github.com/tdwg/dwc): where Darwin Core is maintained
|
||||
- [Normative term list](list/): the document containing the full history of normative Darwin Core term definitions
|
||||
- [Distribution files](https://github.com/tdwg/dwc/tree/master/dist): convenient files to start using Darwin Core
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
container: fluid
|
||||
---
|
||||
|
||||
# Darwin Core quick reference guide
|
||||
# Darwin Core Quick Reference Guide
|
||||
|
||||
This document is intended to be an easy-to-read reference of the currently (as of 2021-07-15) recommended terms maintained as part of the [Darwin Core standard](https://www.tdwg.org/standards/dwc/) and is maintained by the [Darwin Core Maintenance Group](https://www.tdwg.org/community/dwc/).
|
||||
|
||||
|
|
@ -3242,4 +3242,4 @@ Darwin Core Maintenance Group. 2021. List of Darwin Core terms. Biodiversity Inf
|
|||
|
||||
To cite this document specifically, use the following:
|
||||
|
||||
Darwin Core Maintenance Group. 2021. Darwin Core quick reference guide. Biodiversity Information Standards (TDWG). <https://dwc.tdwg.org/terms/>
|
||||
Darwin Core Maintenance Group. 2021. Darwin Core Quick Reference Guide. Biodiversity Information Standards (TDWG). <https://dwc.tdwg.org/terms/>
|
||||
Loading…
Reference in New Issue