Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapt dcat page #272

Merged
merged 14 commits into from
Dec 19, 2023
144 changes: 120 additions & 24 deletions source/content/glossar/bibliothek/dcat-ap-ch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Translatable elements are marked as such under usage notes.

* - property
- URI
- usage notes
- usage notes
* - :ref:`dataset <dcat-catalog-dataset>`
- dcat:dataset
- **mandatory**
Expand Down Expand Up @@ -246,9 +246,9 @@ Translatable elements are marked as such under usage notes.
* - :ref:`modified <dcat-dataset-modified>`
- dct:modified
- conditional
* - :ref:`theme <dcat-dataset-theme>`
* - :fa:`exclamation` :ref:`theme <dcat-dataset-theme>`
- dcat:theme
- conditional
- conditional, :fa:`exclamation` new vocabulary to use
* - :fa:`exclamation` :ref:`landing page <dcat-dataset-landing-page>`
- dcat:landingPage
- conditional, :fa:`exclamation` import format changed
Expand All @@ -272,10 +272,16 @@ Translatable elements are marked as such under usage notes.
- optional, :fa:`exclamation` import format changed
* - :ref:`related resource <dcat-dataset-relation>`
- dct:relation
- optional
* - :ref:`see also <dcat-dataset-see-also>`
- rdfs:seeAlso
- optional
- :fa:`exclamation` optional, **mandatory** for federal level, the legal basis must be indicated here
* - :fa:`exclamation` :ref:`qualifiedRelation <dcat-dataset-qualified-relation>`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qualifiedRelation (in the ref) -> qualified relation

- dcat:qualifiedRelation
- optional :fa:`exclamation` replaces the property rdfs:seeAlso
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

optional -> optional,

* - :fa:`exclamation` :ref:`documentation <dcat-dataset-documentation>`
- foaf:page
- optional, :fa:`exclamation` new property
* - :fa:`exclamation` :ref:`conforms to <dcat-dataset-conforms-to>`
- dct:conformsTo
- optional, :fa:`exclamation` new property


.. list-table:: Properties of dcat:Distribution
Expand All @@ -292,9 +298,9 @@ Translatable elements are marked as such under usage notes.
* - :ref:`access url <dcat-distribution-access-url>`
- dcat:accessURL
- **mandatory**
* - :ref:`rights <dcat-distribution-rights>`
- dct:rights
- **mandatory**
* - :fa:`exclamation` :ref:`license <dcat-distribution-license>`
- dct:license
- **mandatory**, replaces dct:rights
* - :ref:`title <dcat-distribution-title>`
- dct:title
- conditional, multilingual
Expand All @@ -305,20 +311,20 @@ Translatable elements are marked as such under usage notes.
- dct:byteSize
- conditional
* - :ref:`media type <dcat-distribution-media-type>`
- dct:mediaType
- dcat:mediaType
- conditional
* - :ref:`format <dcat-distribution-format>`
* - :fa:`exclamation` :ref:`format <dcat-distribution-format>`
- dct:format
- conditional
- conditional, :fa:`exclamation` use a Controlled Vocabulary (CV)
* - :fa:`exclamation` :ref:`rights <dcat-distribution-rights>`
- dct:rights
- optional, :fa:`exclamation` for exceptional use only
* - :ref:`language <dcat-distribution-language>`
- dct:language
- conditional
* - :ref:`modified <dcat-distribution-modified>`
- dct:modified
- conditional
* - :ref:`license <dcat-distribution-license>`
- dcat:license
- optional
* - :ref:`identifier <dcat-distribution-identifier>`
- dct:identifier
- optional
Expand All @@ -328,6 +334,9 @@ Translatable elements are marked as such under usage notes.
* - :ref:`coverage <dcat-distribution-coverage>`
- dct:coverage
- optional
* - :fa:`exclamation` :ref:`documentation <dcat-distribution-documentation>`
- foaf:page
- optional, :fa:`exclamation` new property

.. _dcat-ap-ch-catalog:

Expand Down Expand Up @@ -577,6 +586,16 @@ dcat:theme (DCAT)

.. include:: dcat-examples/dataset-theme-rdf.rst

.. toggle-header::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use correct links in the dcat-examples/dataset-theme-ttl.rst (above)

:header: Deprecated: Property ``dcat:theme`` of ``dcat:Dataset`` in Turtle

.. include:: dcat-examples/deprecated/dataset-theme-ttl.rst

.. toggle-header::
:header: Deprecated: Property ``dcat:theme`` of ``dcat:Dataset`` in Rdf/xml

.. include:: dcat-examples/deprecated/dataset-theme-rdf.rst

.. _dcat-dataset-language:

dct:language (DCAT)
Expand Down Expand Up @@ -645,6 +664,44 @@ dct:relation (DCAT)

.. include:: dcat-examples/dataset-relation-rdf.rst

.. _dcat-dataset-documentation:

foaf:page (DCAT)
^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: Mapping

.. include:: dcat-definitions/dataset-documentation.rst

.. toggle-header::
:header: Property ``foaf:page`` of ``dcat:Dataset`` in Turtle

.. include:: dcat-examples/dataset-documentation-ttl.rst
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please use this for the ttl (but remove spaces I put to make "<" visible):

< https://bag/covid-19 > a dcat:Dataset ;
foaf:Document < https://www.covid19.admin.ch/api/data/documentation > ,
< https://de.wikipedia.org/wiki/Datenmanagement > .


.. toggle-header::
:header: Property ``foaf:page`` of ``dcat:Dataset`` in Rdf/xml

.. include:: dcat-examples/dataset-documentation-rdf.rst

.. _dcat-dataset-conforms-to:

dct:conformsTo (DCAT)
^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: Mapping

.. include:: dcat-definitions/dataset-conforms-to.rst

.. toggle-header::
:header: Property ``dct:conformsTo`` of ``dcat:Dataset`` in Turtle

.. include:: dcat-examples/dataset-conforms-to-ttl.rst

.. toggle-header::
:header: Property ``dct:conformsTo`` of ``dcat:Dataset`` in Rdf/xml

.. include:: dcat-examples/dataset-conforms-to-rdf.rst

.. _dcat-dataset-keyword:

dcat:keyword (DCAT)
Expand Down Expand Up @@ -750,24 +807,34 @@ dct:accrual-periodicity (DCAT)

.. include:: dcat-examples/deprecated/dataset-accrual-periodicity-rdf.rst

.. _dcat-dataset-see-also:
.. _dcat-dataset-qualified-relation:

dcat:seeAlso (DCAT)
dcat:qualifiedRelation (DCAT)
^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: Mapping

.. include:: dcat-definitions/dataset-see-also.rst
.. include:: dcat-definitions/dataset-qualified-relation.rst

.. toggle-header::
:header: Property ``rdfs:seeAlso`` of ``dcat:Dataset`` in Turtle
:header: :fa:`exclamation` Property ``dcat:qualifiedRelation`` of ``dcat:Dataset`` in Turtle

.. include:: dcat-examples/dataset-see-also-ttl.rst
.. include:: dcat-examples/dataset-qualified-relation-ttl.rst

.. toggle-header::
:header: Property ``rdfs:seeAlso`` of ``dcat:Dataset`` in Rdf/xml
:header: :fa:`exclamation` Property ``dcat:qualifiedRelation`` of ``dcat:Dataset`` in Rdf/xml

.. include:: dcat-examples/dataset-see-also-rdf.rst
.. include:: dcat-examples/dataset-qualified-relation-rdf.rst

.. toggle-header::
:header: Deprecated: Property ``rdfs:seeAlso`` of ``dcat:Dataset`` in Turtle

.. include:: dcat-examples//deprecated/dataset-see-also-ttl.rst

.. toggle-header::
:header: Deprecated: Property ``rdfs:seeAlso`` of ``dcat:Dataset`` in Rdf/xml

.. include:: dcat-examples//deprecated/dataset-see-also-rdf.rst

.. _dcat-ap-ch-distribution:

Expand Down Expand Up @@ -872,7 +939,7 @@ dct:rights (DCAT)

.. _dcat-distribution-media-type:

dct:mediaType (DCAT)
dcat:mediaType (DCAT)
^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: Mapping
Expand Down Expand Up @@ -1049,3 +1116,32 @@ dct:license (DCAT)
.. container:: Mapping

.. include:: dcat-definitions/distribution-license.rst

.. toggle-header::
:header: Property ``dct:license`` of ``dcat:Distribution`` in Turtle

.. include:: dcat-examples/distribution-license-ttl.rst

.. toggle-header::
:header: Property ``dct:license`` of ``dcat:Distribution`` in Rdf/xml

.. include:: dcat-examples/distribution-license-rdf.rst

.. _dcat-distribution-documentation:

foaf:page (DCAT)
^^^^^^^^^^^^^^^^^^^^^^^^

.. container:: Mapping

.. include:: dcat-definitions/distribution-documentation.rst

.. toggle-header::
:header: Property ``foaf:page`` of ``dcat:Distribution`` in Turtle

.. include:: dcat-examples/distribution-documentation-ttl.rst

.. toggle-header::
:header: Property ``foaf:page`` of ``dcat:Distribution`` in Rdf/xml

.. include:: dcat-examples/distribution-documentation-rdf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:DCAT URI: dct:conformsTo
:Domain: dcat:Dataset
:Value: ``dct:Standard``
:Requirement Level: Optional
:Cardinality: 0..n
:Description: This property refers to an implementing rule or other specification.
:Usage Notes: This property SHOULD be used to indicate the model, schema, ontology, view or profile that this representation of a dataset conforms to. This is (generally) a complementary concern to the format or media-type.
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:DCAT URI: foaf:page
:Domain: dcat:Dataset
:Value: ``foaf:Document``
:Requirement Level: Optional
:Cardinality: 0..n
:Description: documentation
:Usage Notes: This property refers to a page or document about this Dataset
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:DCAT URI: `dcat:qualifiedRelation <https://www.w3.org/TR/vocab-dcat/#Property:resource_qualified_relation>`__
:Domain: dcat:Dataset
:Value: `rdfs:Resource <https://www.w3.org/TR/vocab-dcat/#Class:Relationship>`__
:Requirement Level: Optional
:Cardinality: 0..n
:Description: Link to related datasets on opendata.swiss.
:Usage Notes: Contains the identifier of the related dataset. The perma link must be used:

``https://ogdch-abnahme.clients.liip.ch/perma/adb280a9-381d-4fb3-ae43-b40ace826dc7@stadt-zurich"``
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
:DCAT URI: dcat:qualifiedRelation
:Domain: dcat:Dataset
:Value: `rdfs:Resource <https://www.w3.org/TR/vocab-dcat/#Class:Relationship>`__
:Requirement Level: Optional
:Cardinality: 0..n
:Description: Link to related datasets on opendata.swiss.
:Usage Notes: Contains the identifier of the linked dataset. You have to used
the perma link for this:

``https://ogdch-abnahme.clients.liip.ch/perma/adb280a9-381d-4fb3-ae43-b40ace826dc7@stadt-zurich"``

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:DCAT URI: dcat:theme
:Domain: dcat:Dataset
:Value: DCAT-AP-CH has its own
`controlled vocabulary for the themes <https://dcat-ap.ch/vocabulary/themes>`__
:Value: skos:Concept
:Requirement Level: optional
:Cardinality: 0..n
:Description: Categories that match the topic of the dataset
:Description: This property refers to a theme/category of the dataset. A dataset can be associated
with multiple themes. CV to be used: `[VOCAB-EU-THEME] <https://publications.europa.eu/resource/authority/data-theme>`__
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
:DCAT URI: foaf:page
:Domain: dcat:Distribution
:Value: ``foaf:Document``
:Requirement Level: Optional
:Cardinality: 0..n
:Description: documentation
:Usage Notes: This property refers to a page or document about this Distribution.
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
:DCAT URI: dct:format
:Domain: dcat:Distribution
:Value: ``dct:MediaTypeOrExtent`` http://www.iana.org/assignments/media-types/media-types.xhtml
:Requirement Level: conditional, required if the distribution is accessible by a ``dcat:downloadURL``
:Value: `dct:MediaTypeOrExtent <https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/MediaTypeOrExtent>`__
:Requirement Level: Recommended, required if the distribution is accessible by a ``dcat:downloadURL``
:Cardinality: 0..1
:Description: Format of the distribution
:Usage Notes: If neither the ``downloadURL`` nor the ``mediaType`` provide a
valid format, this value is used to display the format of the distribution.
:Description: This property refers to the file format of the distribution
:Usage Notes: CV to be used: [`VOCAB-EU-FILE-TYPE <https://dcat-ap.ch/releases/2.0/dcat-ap-ch.html#bib-vocab-eu-file-type>`__]

If a format is not available:

#. media type [`IANA-MEDIA-TYPES <https://dcat-ap.ch/releases/2.0/dcat-ap-ch.html#bib-iana-media-types>`__] should be used

#. if required, please contact `Geschäftsstelle OGD <mailto:[email protected]>`__.
Original file line number Diff line number Diff line change
@@ -1,7 +1,40 @@
:DCAT URI: dct:license
:DCAT URI: `dct:license <https://www.w3.org/TR/vocab-dcat/#Property:distribution_license>`__
:Domain: dcat:Distribution
:Value: ``dct:LicenseDocument``
:Requirement Level: optional
:Cardinality: 0..1
:Description: Rights statement of this distribution. It relates to the ``dcat:accessURL``
:Usage Notes: Not used, see ``dct:rights``. This field ensures compatibility to other metadata standards.
:Value: `dct:LicenseDocument <https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#LicenseDocument>`__
:Requirement Level: Mandatory
:Cardinality: 1..1
:Description: The `rights statement / terms of use <https://opendata.swiss/de/terms-of-use>`__ indicates for what purpose and in what context
the data of a distribution can be used: for commercial or for non commercial purposes.
Does it need to be referenced, when it is used? Must permission be obtained for commercial use.
These conditions are included in the rights statements. See the list below for the exact values.

:Usage Notes: Terms of use are no longer referenced under ``dct:rights``, but under ``dct:license``.

Exception: If other licenses, such as CC-licenses, are used for the dataset besides the terms of use, the
terms of use are referenced under dct:rights. Only the terms of use are displayed on opendata.swiss. If other
licenses are included, they are passed on to the portal data.europa.eu.

CV to be used: `DCAT-AP CH license vocabulary <https://dcat-ap.ch/vocabulary/licenses/20210623.html>`__

This field ensures compatibility to other metadata standards such as DCAT-AP.

.. code-block::
:caption: Values **acceptable** for opendata.swiss
:emphasize-lines: 1,2,3,4

NonCommercialAllowed-CommercialAllowed-ReferenceNotRequired
NonCommercialAllowed-CommercialAllowed-ReferenceRequired
NonCommercialAllowed-CommercialWithPermission-ReferenceNotRequired
NonCommercialAllowed-CommercialWithPermission-ReferenceRequired

.. code-block::
:caption: Values **not acceptable** for opendata.swiss

NonCommercialAllowed-CommercialNotAllowed-ReferenceNotRequired
NonCommercialAllowed-CommercialNotAllowed-ReferenceRequired
NonCommercialNotAllowed-CommercialNotAllowed-ReferenceNotRequired
NonCommercialNotAllowed-CommercialNotAllowed-ReferenceRequired
NonCommercialNotAllowed-CommercialAllowed-ReferenceNotRequired
NonCommercialNotAllowed-CommercialAllowed-ReferenceRequired
NonCommercialNotAllowed-CommercialWithPermission-ReferenceNotRequired
NonCommercialNotAllowed-CommercialWithPermission-ReferenceRequired
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:DCAT URI: dct:mediaType
:DCAT URI: dcat:mediaType
:Domain: dcat:Distribution
:Value: `dct:MediaTypeOrExtent`` must be a MIME type of http://www.iana.org/assignments/media-types/media-types.xhtml
:Value: ``dct:MediaType`` must be a MIME type of `[IANA-MEDIA-TYPES] <http://www.iana.org/assignments/media-types/media-types.xhtml>`_
:Requirement Level: conditional, required if the distribution is a file accessible by a ``dcat:downloadURL``
:Cardinality: 0..1
:Description: Resource format of the data provided by the ``dcat:downloadURL``
Expand Down
Loading
Loading