From bc54b5c4033620b094de0e516b1b04dc7d94a1b0 Mon Sep 17 00:00:00 2001 From: peterdesmet Date: Fri, 3 Feb 2023 13:59:43 +0100 Subject: [PATCH] Consistently write Quick Reference Guide in title case --- README.md | 14 +++++++------- build/README.md | 8 ++++---- build/build.py | 4 ++-- build/generate_term_versions.py | 2 +- build/terms.tmpl | 5 +++-- docs/index.md | 10 +++++----- docs/terms/index.md | 4 ++-- 7 files changed, 24 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 35db7de..93ffb78 100644 --- a/README.md +++ b/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 diff --git a/build/README.md b/build/README.md index b3945a3..d1d3a42 100644 --- a/build/README.md +++ b/build/README.md @@ -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 diff --git a/build/build.py b/build/build.py index eaab4ea..377822c 100644 --- a/build/build.py +++ b/build/build.py @@ -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() diff --git a/build/generate_term_versions.py b/build/generate_term_versions.py index 7322194..67ec46c 100644 --- a/build/generate_term_versions.py +++ b/build/generate_term_versions.py @@ -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(): diff --git a/build/terms.tmpl b/build/terms.tmpl index 74cc11b..96365ca 100644 --- a/build/terms.tmpl +++ b/build/terms.tmpl @@ -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. @@ -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). +Darwin Core Maintenance Group. 2021. Darwin Core Quick Reference Guide. Biodiversity Information Standards (TDWG). diff --git a/docs/index.md b/docs/index.md index 67a1798..ff49e1f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 diff --git a/docs/terms/index.md b/docs/terms/index.md index a3b62fe..9587c39 100644 --- a/docs/terms/index.md +++ b/docs/terms/index.md @@ -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). \ No newline at end of file +Darwin Core Maintenance Group. 2021. Darwin Core Quick Reference Guide. Biodiversity Information Standards (TDWG). \ No newline at end of file