Update layout of QRG

- Content width contained (no longer `container-fluid`), which improves readability as it avoids long lines
- Replace `theme-label` class with custom style to have the same affect (i.e. first col = 120px)
- Use primary colours for term buttons (primary indicated action item)
- Use regular rather than small tables
- Don't use outer border on tables
- Drop the `property` badge (keep the `class` badge). The property badge was annoying when copying term names, as it was always added, e.g. basisOfRecordproperty
- Update badge-background to bg-background (Bootstrap 5)
- Use 2 space tabs in template
- Use <span> rather than <a> for term anchors
- Use h2 for "Cite Darwin Core" so it is mentioned in the menu
- Style citations as block quotes
This commit is contained in:
peterdesmet 2023-02-03 16:16:59 +01:00
parent 7cd258fd0e
commit 9f65be2ea1
2 changed files with 3073 additions and 2622 deletions

View File

@ -1,13 +1,16 @@
{#
This template is NOT used by jekyll, but by the Darwin Core build script
to create the terms/index.md file, which mostly contains html.
This template is NOT used by jekyll, but by the Darwin Core build script
to create the terms/index.md file, which mostly contains html.
#}
---
container: fluid
---
# Darwin Core Quick Reference Guide
<style>
.table tr td:first-of-type {
width: 120px;
}
</style>
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/).
This page is not part of the standard, but combines the normative term names and definitions with the non-normative comments and examples that are meant to help people to use the terms consistently. Capitalized terms, such as Occurrence, are Darwin Core classes, which are special category terms used to group sets of terms for convenience. Comprehensive metadata for current and obsolete terms in human readable form are found in the document [List of Darwin Core terms](../list/).
@ -27,52 +30,55 @@ This category contains terms that are generic in that they might apply to any ty
For more information on `UseWithIRI`, see [Section 2.5 of the RDF Guide](https://dwc.tdwg.org/rdf/#25-terms-in-the-dwciri-namespace-normative).
{% endif %}
<div class="my-4">
{% for term in class_group.terms %}
<a class="btn btn-sm btn-outline-secondary m-1" href="#{{ term.namespace }}:{{ term.label }}">{{ term.label }}</a>
{% endfor %}
{% for term in class_group.terms %}
<a class="btn btn-sm btn-outline-primary m-1" href="#{{ term.namespace }}:{{ term.label }}">{{ term.label }}</a>
{% endfor %}
</div>
{% if class_group.label != 'Record-level' and class_group.label != 'UseWithIRI' %}
{# Class #}
<table class="table table-sm table-bordered">
<tbody>
<tr class="table-primary"><th colspan="2">{{ class_group.label }} <span class="badge badge-primary float-right">Class</span></th></tr>
<tr><td class="theme-label">Identifier</td><td><a href="{{ class_group.iri }}">{{ class_group.iri }}</a></td></tr>
<tr><td class="theme-label">Definition</td><td>{{ class_group.definition }}</td></tr>
<tr><td class="theme-label">Comments</td><td>{{ class_group.comments }}</td></tr>
<tr><td class="theme-label">Examples</td><td>{{ class_group.examples }}</td></tr>
</tbody>
<table class="table">
<tbody>
<tr class="table-primary"><th colspan="2">{{ class_group.label }} <span class="badge bg-primary float-end">Class</span></th></tr>
<tr><td>Identifier</td><td><a href="{{ class_group.iri }}">{{ class_group.iri }}</a></td></tr>
<tr><td>Definition</td><td>{{ class_group.definition }}</td></tr>
<tr><td>Comments</td><td>{{ class_group.comments }}</td></tr>
<tr><td>Examples</td><td>{{ class_group.examples }}</td></tr>
</tbody>
</table>
{%endif %}
{% for term in class_group.terms %}
{# Term #}
<p class="invisible">
<a id="{{ term.namespace }}:{{ term.label }}"></a>{% if term.namespace != "dwciri" %}<a id="{{ term.label }}"></a>{% endif %}
<span id="{{ term.namespace }}:{{ term.label }}"></span>
{% if term.namespace != "dwciri" %}
<span id="{{ term.label }}"></span>
{% endif %}
</p>
<table class="table table-sm table-bordered">
<tbody>
<tr class="table-secondary"><th colspan="2">{{ term.label }} <span class="badge badge-secondary float-right">Property</span></th></tr>
<tr><td class="theme-label">Identifier</td><td><a href="{{ term.iri }}">{{ term.iri }}</a></td></tr>
<tr><td class="theme-label">Definition</td><td>{{ term.definition }}</td></tr>
<tr><td class="theme-label">Comments</td><td>{{ term.comments }}</td></tr>
<tr><td class="theme-label">Examples</td><td>{{ term.examples }}</td></tr>
</tbody>
<table class="table">
<tbody>
<tr class="table-secondary"><th colspan="2">{{ term.label }}</th></tr>
<tr><td>Identifier</td><td><a href="{{ term.iri }}">{{ term.iri }}</a></td></tr>
<tr><td>Definition</td><td>{{ term.definition }}</td></tr>
<tr><td>Comments</td><td>{{ term.comments }}</td></tr>
<tr><td>Examples</td><td>{{ term.examples }}</td></tr>
</tbody>
</table>
{% endfor %}
{% endfor %}
# Cite Darwin Core
## 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>
> 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>
To cite the standard document upon which this page is built, use the following:
Darwin Core Maintenance Group. 2021. List of Darwin Core terms. Biodiversity Information Standards (TDWG). <http://rs.tdwg.org/dwc/doc/list/>
> Darwin Core Maintenance Group. 2021. List of Darwin Core terms. Biodiversity Information Standards (TDWG). <http://rs.tdwg.org/dwc/doc/list/>
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/>

File diff suppressed because it is too large Load Diff