generated from netwerk-digitaal-erfgoed/requirements-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
SHA: fdcc72c Reason: push, by ddeboer Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
2347d38
commit 61babd3
Showing
1 changed file
with
20 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1490,7 +1490,7 @@ | |
</style> | ||
<meta content="Bikeshed version d765c696b, updated Fri Mar 8 15:58:52 2024 -0800" name="generator"> | ||
<link href="https://netwerk-digitaal-erfgoed.github.io/requirements-datasets/" rel="canonical"> | ||
<meta content="e58d39c9b984e16debc5211bb2d5258698703277" name="revision"> | ||
<meta content="fdcc72c42c05891fe7aba4a3a1720b1280cd7918" name="revision"> | ||
<meta content="dark light" name="color-scheme"> | ||
<style>/* Boilerplate: style-autolinks */ | ||
.css.css, .property.property, .descriptor.descriptor { | ||
|
@@ -2317,7 +2317,8 @@ <h2 class="no-num no-toc no-ref" id="contents">Table of Contents</h2> | |
<li> | ||
<a href="#creator-publisher-information"><span class="secno">4.3</span> <span class="content">Creator/publisher information</span></a> | ||
<ol class="toc"> | ||
<li><a href="#dataset-publisher"><span class="secno">4.3.1</span> <span class="content">Dataset publisher</span></a> | ||
<li><a href="#contact"><span class="secno">4.3.1</span> <span class="content">Contact information</span></a> | ||
<li><a href="#dataset-publisher"><span class="secno">4.3.2</span> <span class="content">Dataset publisher</span></a> | ||
</ol> | ||
<li> | ||
<a href="#dataset-distributions"><span class="secno">4.4</span> <span class="content">Distributions</span></a> | ||
|
@@ -2765,10 +2766,17 @@ <h3 class="heading settled" data-level="4.3" id="creator-publisher-information"> | |
<c- p>}</c-> | ||
</pre> | ||
</div> | ||
<h4 class="heading settled" data-level="4.3.1" id="dataset-publisher"><span class="secno">4.3.1. </span><span class="content">Dataset publisher</span><a class="self-link" href="#dataset-publisher"></a></h4> | ||
<h4 class="heading settled" data-level="4.3.1" id="contact"><span class="secno">4.3.1. </span><span class="content">Contact information</span><a class="self-link" href="#contact"></a></h4> | ||
<p>Publishers <em>SHOULD</em> include contact information so <a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑥">consumers</a> can reach them with questions or feedback. | ||
The e-mail address <em>SHOULD</em> be functional (i.e. non-personal) because of GDPR reasons.</p> | ||
<div class="example" id="example-bb059d17"> | ||
<a class="self-link" href="#example-bb059d17"></a> A publisher with contact information. | ||
<pre class="highlight line-numbered"><span class="line-no" data-line="1"></span><span class="line"><c- p>{</c-></span><span class="line-no" data-line="2"></span><span class="line"> <c- nd>"@context"</c-><c- p>:</c-> <c- u>"https://schema.org/"</c-><c- p>,</c-></span><span class="line-no" data-line="3"></span><span class="line"> <c- nd>"@type"</c-><c- p>:</c-> <c- u>"Dataset"</c-><c- p>,</c-></span><span class="line-no" data-line="4"></span><span class="line"> <c- f>"publisher"</c-><c- p>:</c-> <c- p>{</c-></span><span class="line-no" data-line="5"></span><span class="line"> <c- nd>"@type"</c-><c- p>:</c-> <c- u>"Organization"</c-><c- p>,</c-></span><span class="line-no" data-line="6"></span><span class="line"> <c- nd>"@id"</c-><c- p>:</c-> <c- u>"https://www.kb.nl"</c-><c- p>,</c-></span><span class="line-no" data-line="7"></span><span class="line"> <c- f>"name"</c-><c- p>:</c-> <c- u>"Koninklijke Bibliotheek"</c-><c- p>,</c-></span><span class="line-no" data-line="8"></span><span class="line"> <c- f>"alternateName"</c-><c- p>:</c-> <c- u>"KB"</c-><c- p>,</c-></span><span class="line-no highlight-line" data-line="9"></span><span class="line highlight-line"> <c- f>"contactPoint"</c-><c- p>:</c-> <c- p>{</c-></span><span class="line-no highlight-line" data-line="10"></span><span class="line highlight-line"> <c- nd>"@type"</c-><c- p>:</c-> <c- u>"ContactPoint"</c-><c- p>,</c-></span><span class="line-no highlight-line" data-line="11"></span><span class="line highlight-line"> <c- f>"name"</c-><c- p>:</c-> <c- u>"Datasets Department"</c-><c- p>,</c-></span><span class="line-no highlight-line" data-line="12"></span><span class="line highlight-line"> <c- f>"email"</c-><c- p>:</c-> <c- u>"[email protected]"</c-><c- p>,</c-></span><span class="line-no highlight-line" data-line="13"></span><span class="line highlight-line"> <c- f>"telephone"</c-><c- p>:</c-> <c- u>"+31 6 12345678"</c-></span><span class="line-no highlight-line" data-line="14"></span><span class="line highlight-line"> <c- p>}</c-></span><span class="line-no" data-line="15"></span><span class="line"> <c- p>}</c-></span><span class="line-no" data-line="16"></span><span class="line"><c- p>}</c-></span></pre> | ||
</div> | ||
<h4 class="heading settled" data-level="4.3.2" id="dataset-publisher"><span class="secno">4.3.2. </span><span class="content">Dataset publisher</span><a class="self-link" href="#dataset-publisher"></a></h4> | ||
<p>The person/organization data is then included as the dataset’s publisher:</p> | ||
<div class="example" id="example-85d8ccd9"> | ||
<a class="self-link" href="#example-85d8ccd9"></a> A dataset with an organization as publisher. The publisher has some optional attributes. | ||
<div class="example" id="example-2e03a297"> | ||
<a class="self-link" href="#example-2e03a297"></a> A dataset with an organization as publisher. | ||
<pre class="highlight"><c- p>{</c-> | ||
<c- nd>"@context"</c-><c- p>:</c-> <c- u>"https://schema.org/"</c-><c- p>,</c-> | ||
<c- nd>"@type"</c-><c- p>:</c-> <c- u>"Dataset"</c-><c- p>,</c-> | ||
|
@@ -2779,16 +2787,16 @@ <h4 class="heading settled" data-level="4.3.1" id="dataset-publisher"><span clas | |
<c- f>"alternateName"</c-><c- p>:</c-> <c- u>"KB"</c-><c- p>,</c-> | ||
<c- f>"contactPoint"</c-><c- p>:</c-> <c- p>{</c-> | ||
<c- nd>"@type"</c-><c- p>:</c-> <c- u>"ContactPoint"</c-><c- p>,</c-> | ||
<c- f>"name"</c-><c- p>:</c-> <c- u>"Dataset manager’s name"</c-><c- p>,</c-> | ||
<c- f>"name"</c-><c- p>:</c-> <c- u>"Datasets Department"</c-><c- p>,</c-> | ||
<c- f>"email"</c-><c- p>:</c-> <c- u>"[email protected]"</c-><c- p>,</c-> | ||
<c- f>"telephone"</c-><c- p>:</c-> <c- u>"+31 6 12345678"</c-> | ||
<c- p>}</c-> | ||
<c- p>}</c-> | ||
<c- p>}</c-> | ||
</pre> | ||
</div> | ||
<div class="example" id="example-ffb48885"> | ||
<a class="self-link" href="#example-ffb48885"></a> A dataset with a person as publisher. The publisher has some optional attributes. | ||
<div class="example" id="example-aa9ed6a8"> | ||
<a class="self-link" href="#example-aa9ed6a8"></a> A dataset with a person as publisher. | ||
<pre class="highlight"><c- p>{</c-> | ||
<c- nd>"@context"</c-><c- p>:</c-> <c- u>"https://schema.org/"</c-><c- p>,</c-> | ||
<c- nd>"@type"</c-><c- p>:</c-> <c- u>"Dataset"</c-><c- p>,</c-> | ||
|
@@ -2801,7 +2809,7 @@ <h4 class="heading settled" data-level="4.3.1" id="dataset-publisher"><span clas | |
</pre> | ||
</div> | ||
<h3 class="heading settled" data-level="4.4" id="dataset-distributions"><span class="secno">4.4. </span><span class="content">Distributions</span><a class="self-link" href="#dataset-distributions"></a></h3> | ||
<p><a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑥">Consumers</a> that are interested in a dataset should be able to access the data in it. <a data-link-type="dfn" href="#distribution" id="ref-for-distribution②">Distributions</a> tell consumers where and how they can get the data.</p> | ||
<p><a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑦">Consumers</a> that are interested in a dataset should be able to access the data in it. <a data-link-type="dfn" href="#distribution" id="ref-for-distribution②">Distributions</a> tell consumers where and how they can get the data.</p> | ||
<blockquote> | ||
<p>Therefore, publishers <em>SHOULD</em> add at least one distribution. | ||
Each distribution <em>MUST</em> have at least a MIME format and the URL where the distribution can be accessed.</p> | ||
|
@@ -2907,7 +2915,7 @@ <h4 class="heading settled" data-level="4.4.2" id="developer-docs"><span class=" | |
</div> | ||
<p>See also <a href="https://w3c.github.io/dwbp/usecasesv1.html#R-APIDocumented">Data on the Web Best Practices Use Cases & Requirements § R-APIDocumented</a>.</p> | ||
<h3 class="heading settled" data-level="4.5" id="data-catalog-info"><span class="secno">4.5. </span><span class="content">Data catalog</span><a class="self-link" href="#data-catalog-info"></a></h3> | ||
<p>A <a data-link-type="dfn" href="#data-catalog" id="ref-for-data-catalog">data catalog</a> provides <a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑦">consumers</a> with a complete overview of available <a data-link-type="dfn" href="#dataset-description" id="ref-for-dataset-description⑤">dataset descriptions</a>, | ||
<p>A <a data-link-type="dfn" href="#data-catalog" id="ref-for-data-catalog">data catalog</a> provides <a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑧">consumers</a> with a complete overview of available <a data-link-type="dfn" href="#dataset-description" id="ref-for-dataset-description⑤">dataset descriptions</a>, | ||
which improves discoverability.</p> | ||
<blockquote> | ||
<p>Therefore, publishers <em>SHOULD</em> provide a catalog.</p> | ||
|
@@ -3101,7 +3109,7 @@ <h4 class="heading settled" data-level="4.6.2" id="organization-overview"><span | |
<td>Recommended | ||
<tr> | ||
<th scope="row"><a href="https://schema.org/contactPoint">schema:contactPoint</a> | ||
<td>Where <a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑧">consumers</a> can reach the organization for questions and suggestions about the dataset. | ||
<td>Where <a data-link-type="dfn" href="#consumer" id="ref-for-consumer⑨">consumers</a> can reach the organization for questions and suggestions about the dataset. | ||
<td>1 | ||
<td>Recommended (scheduled to become Required for schema:publisher) | ||
</table> | ||
|
@@ -3677,7 +3685,7 @@ <h2 class="no-num no-ref heading settled" id="issues-index"><span class="content | |
"use strict"; | ||
{ | ||
let dfnPanelData = { | ||
"consumer": {"dfnID":"consumer","dfnText":"Consumer","external":false,"refSections":[{"refs":[{"id":"ref-for-consumer"}],"title":"1. Introduction"},{"refs":[{"id":"ref-for-consumer\u2460"}],"title":"4.1.1. Durable identifiers"},{"refs":[{"id":"ref-for-consumer\u2461"}],"title":"4.1.2. Information remains available"},{"refs":[{"id":"ref-for-consumer\u2462"}],"title":"4.2. Dataset information"},{"refs":[{"id":"ref-for-consumer\u2463"}],"title":"4.2.2. License"},{"refs":[{"id":"ref-for-consumer\u2464"}],"title":"4.2.4. Version"},{"refs":[{"id":"ref-for-consumer\u2465"}],"title":"4.4. Distributions"},{"refs":[{"id":"ref-for-consumer\u2466"}],"title":"4.5. Data catalog"},{"refs":[{"id":"ref-for-consumer\u2467"}],"title":"4.6.2. Organization attributes"}],"url":"#consumer"}, | ||
"consumer": {"dfnID":"consumer","dfnText":"Consumer","external":false,"refSections":[{"refs":[{"id":"ref-for-consumer"}],"title":"1. Introduction"},{"refs":[{"id":"ref-for-consumer\u2460"}],"title":"4.1.1. Durable identifiers"},{"refs":[{"id":"ref-for-consumer\u2461"}],"title":"4.1.2. Information remains available"},{"refs":[{"id":"ref-for-consumer\u2462"}],"title":"4.2. Dataset information"},{"refs":[{"id":"ref-for-consumer\u2463"}],"title":"4.2.2. License"},{"refs":[{"id":"ref-for-consumer\u2464"}],"title":"4.2.4. Version"},{"refs":[{"id":"ref-for-consumer\u2465"}],"title":"4.3.1. Contact information"},{"refs":[{"id":"ref-for-consumer\u2466"}],"title":"4.4. Distributions"},{"refs":[{"id":"ref-for-consumer\u2467"}],"title":"4.5. Data catalog"},{"refs":[{"id":"ref-for-consumer\u2468"}],"title":"4.6.2. Organization attributes"}],"url":"#consumer"}, | ||
"data-catalog": {"dfnID":"data-catalog","dfnText":"Data catalog","external":false,"refSections":[{"refs":[{"id":"ref-for-data-catalog"}],"title":"4.5. Data catalog"},{"refs":[{"id":"ref-for-data-catalog\u2460"}],"title":"4.5.1. Pagination"}],"url":"#data-catalog"}, | ||
"dataset": {"dfnID":"dataset","dfnText":"Dataset","external":false,"refSections":[{"refs":[{"id":"ref-for-dataset"}],"title":"1. Introduction"},{"refs":[{"id":"ref-for-dataset\u2460"},{"id":"ref-for-dataset\u2461"},{"id":"ref-for-dataset\u2462"},{"id":"ref-for-dataset\u2463"}],"title":"2. Definitions"},{"refs":[{"id":"ref-for-dataset\u2464"}],"title":"3. Conceptual model"},{"refs":[{"id":"ref-for-dataset\u2465"}],"title":"4.1.1. Durable identifiers"},{"refs":[{"id":"ref-for-dataset\u2466"}],"title":"4.2. Dataset information"},{"refs":[{"id":"ref-for-dataset\u2467"}],"title":"4.3. Creator/publisher information"}],"url":"#dataset"}, | ||
"dataset-description": {"dfnID":"dataset-description","dfnText":"Dataset description","external":false,"refSections":[{"refs":[{"id":"ref-for-dataset-description"}],"title":"1. Introduction"},{"refs":[{"id":"ref-for-dataset-description\u2460"}],"title":"2. Definitions"},{"refs":[{"id":"ref-for-dataset-description\u2461"}],"title":"4.1. Available in RDF"},{"refs":[{"id":"ref-for-dataset-description\u2462"}],"title":"4.2.3. Creation, publication and modification dates"},{"refs":[{"id":"ref-for-dataset-description\u2463"}],"title":"4.2.4. Version"},{"refs":[{"id":"ref-for-dataset-description\u2464"}],"title":"4.5. Data catalog"},{"refs":[{"id":"ref-for-dataset-description\u2465"}],"title":"4.6.5. Full example"}],"url":"#dataset-description"}, | ||
|