Keywords for theme:¶
The tables below lists the keywords for the theme {'ddoc:datadoc'}.
The meaning of the columns are as follows:
- Keyword: The keyword referring to a property used for the data documentation.
- Range: Refer to the class for the values of the keyword.
- Conformance: Whether the keyword is mandatory, recommended or optional when documenting the given type of resources.
- Definition: The definition of the keyword.
- Usage note: Notes about how to use the keyword.
Special keywords (from JSON-LD)¶
See the [JSON-LD specification] for more details.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| @id | IRI | mandatory | IRI identifying the resource to document. | |
| @type | IRI | recommended | Ontological class defining the class of a node. | |
| @context | dict|list | optional | Context defining namespace prefixes and additional keywords. | |
| @base | namespace | optional | Base IRI against which relative IRIs are resolved. | |
| @vocab | namespace | optional | Used to expand properties and values in @type with a common prefix IRI. | |
| @graph | list | optional | Used for documenting multiple resources. |
Properties on DataService¶
A collection of operations that provides access to one or more datasets or data processing functions.
- subClassOf: rdfs:Resource
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| endpointURL | rdfs:Literal (xsd:anyURI) |
mandatory | The root location or primary endpoint of the service (an IRI). | |
| endpointDescription | rdfs:Resource | recommended | A description of the services available via the end-points, including their operations, parameters etc. | |
| servesDataset | dcat:Dataset | recommended | This property refers to a collection of data that this data service can distribute. | |
| parser | oteio:Parser | A parser that can parse the distribution. |
Properties on Dataset¶
A collection of data, published or curated by an agent, and available for access or download in one or more representations.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| distribution | dcat:Distribution | recommended | An available distribution for the dataset. | |
| geographicalCoverage | dcterms:Location | recommended | A geographic region that is covered by the dataset. | |
| temporalCoverage | dcterms:PeriodOfTime | recommended | A temporal period that the Dataset covers. | |
| otherIdentifier | adms:Identifier | optional | A secondary identifier of the Dataset | |
| sample | dcat:Distribution | optional | A sample distribution of the dataset. | |
| inSeries | dcat:DatasetSeries | optional | A dataset series of which the dataset is part. | |
| spatialResolution | rdfs:Literal (xsd:decimal) |
optional | The minimum spatial separation resolvable in a dataset, measured in meters. | |
| temporalResolution | rdfs:Literal (xsd:duration) |
optional | The minimum time period resolvable in the dataset. | |
| frequency | dcterms:Frequency | optional | The frequency at which the Dataset is updated. | |
| source | dcat:Dataset | optional | A related Dataset from which the described Dataset is derived. | |
| wasDerivedFrom | dcat:Resource | optional | A derivation is a transformation of an entity into another, an update of an entity resulting in a new one, or the construction of a new entity based on a pre-existing entity. | Relates a resource to another resource it was derived from. |
| wasGeneratedBy | prov:Activity | optional | An activity that generated, or provides the business context for, the creation of the dataset. | |
| isInputOf | emmo:EMMO_43e9a05d_98af_41b4_92f6_00f79a09bfce | A process that this dataset is the input to. | ||
| isOutputOf | emmo:EMMO_43e9a05d_98af_41b4_92f6_00f79a09bfce | A process that this dataset is the output to. | ||
| hasDatum | emmo:EMMO_50d6236a_7667_4883_8ae1_9bb5d190423a | Relates a dataset to its datum parts. | hasDatum relations are normally NOT specified manually, since they are generated from the DLite data model. |
|
| isDescriptionFor | dcat:Resource | An object (e.g. a material) that this dataset describes. | ||
| datamodel | oteio:Datamodel | URI of DLite datamodel for the dataset. | ||
| datamodelStorage | rdfs:Literal (xsd:anyURI) |
URL to DLite storage plugin where the datamodel is stored. | ||
| mappings | rdfs:Literal (rdf:JSON) |
A list of subject-predicate-object triples mapping the datamodel to ontological concepts. | ||
| mappingFormat | rdfs:Literal | File format for mappingURL. Defaults to "turtle". |
||
| mappingURL | rdfs:Literal (xsd:anyURI) |
URL to a document defining the mappings of the datamodel. The file format is given by mappingFormat. Defaults to turtle. |
Properties on Distribution¶
A physical embodiment of the Dataset in a particular format.
- subClassOf: dcat:Resource
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| accessURL | rdfs:Resource | mandatory | A URL that gives access to a Distribution of the Dataset. E.g. landing page, feed, SPARQL endpoint. Use for all cases except a simple download link, in which case downloadURL is preferred. | The resource at the access URL may contain information about how to get the Dataset. |
| mediaType | dcterms:MediaType | recommended | The media type of the Distribution as defined in the official register of media types managed by IANA. | |
| availability | rdfs:Literal (xsd:date) |
recommended | An indication how long it is planned to keep the Distribution of the Dataset available. | |
| accessService | dcat:DataService | optional | A data service that gives access to the distribution of the dataset. | |
| byteSize | rdfs:Literal (xsd:nonNegativeInteger) |
optional | The size of a Distribution in bytes. | |
| compressFormat | dcterms:MediaType | optional | The format of the file in which the data is contained in a compressed form, e.g. to reduce the size of the downloadable file. | It SHOULD be expressed using a media type as defined in the official register of media types managed by IANA. |
| downloadURL | rdfs:Literal (xsd:anyURI) |
optional | A URL that is a direct link to a downloadable file in a given format. The format is indicated by the distribution's 'dterms:format' and/or 'dcat:mediaType'. | |
| packageFormat | dcterms:MediaType | optional | The format of the file in which one or more data files are grouped together, e.g. to enable a set of related files to be downloaded together. | It SHOULD be expressed using a media type as defined in the official register of media types managed by IANA and prefixed with https://www.iana.org/assignments/media-types/. |
| status | skos:Concept | optional | The status of the distribution in the context of maturity lifecycle. | It MUST take one of the values: 'stat:Completed', 'stat:Deprecated', 'stat:UnderDevelopment', 'stat:Withdrawn'. |
| format | dcterms:MediaTypeOrExtent | optional | The file format of the Distribution. | dcat:mediaType SHOULD be used if the type of the distribution is defined by IANA. |
| checksum | spdx:Checksum | optional | A mechanism that can be used to verify that the contents of a distribution have not changed. | The checksum is related to the downloadURL. |
| generator | oteio:Generator | A generator that can create the distribution. |
Properties on Relationship¶
An association class for attaching additional information to a relationship between DCAT Resources.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| relatedResource | rdfs:Resource | optional | A resource with an unspecified relationship to the cataloged resource. | |
| hasRole | dcat:Role | A function of an entity or agent with respect to another entity or resource. |
Properties on Resource¶
Resource published or curated by an agent.
- subClassOf: rdfs:Resource
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| description | rdfs:Literal (rdf:langString) |
mandatory | A free-text account of the resource. | This property can be repeated for parallel language versions of the description. |
| title | rdfs:Literal (rdf:langString) |
mandatory | A name given to the resource. | This property can be repeated for parallel language versions of the name. |
| contactPoint | vcard:Kind | recommended | Contact information that can be used for sending comments about the resource. | |
| keyword | rdfs:Literal (rdf:langString) |
recommended | A keyword or tag describing the resource. | |
| theme | skos:Concept | recommended | A category of the resource. A resource may be associated with multiple themes. | The set of themes used to categorize the resources are organized in a skos:ConceptScheme, skos:Collection, owl:Ontology or similar, describing all the categories and their relations in the catalog. |
| publisher | foaf:Agent | recommended | Agent responsible for making the resource available. | |
| versionNotes | rdfs:Literal | optional | A description of the differences between this version and a previous version of the resource. | This property can be repeated for parallel language versions of the version notes. |
| hasVersion | rdfs:Resource | optional | A related resource that is a version, edition, or adaptation of the described resource. | This property is intended for relating a non-versioned or abstract resource to several versioned resources, e.g., snapshots. |
| landingPage | foaf:Document | optional | A web page that provides access to the resource and/or additional information (e.g. the distribution for a dataset). | It is intended to point to a landing page at the original |
| data provider, not to a page on a site of a third party, | ||||
| such as an aggregator. |
For distributions, if they are accessible only through a
landing page (i.e. direct download URLs are not known), then
the landing page link should be duplicated as accessURL on a
distribution.
|
| qualifiedRelation | dcat:Relationship | optional | A description of a relationship with another resource. | |
| version | rdfs:Literal | optional | Version indicator (name or identifier) of a resource. | DCAT does not prescribe how a version name / identifier should be specified, and refers for guidance to [DWBP]'s Best Practice 7: Provide a version indicator. |
| applicableLegislation | eli:LegalResource | optional | The legislation that mandates the creation or management of the resource. | |
| accessRights | dcterms:RightsStatement | optional | Information about who can access the resource or an indication of its security status. | Access Rights may include information regarding access or restrictions based on privacy, security, or other policies. The following preferred Rights Statement individuals are defined: accr:PUBLIC, accr:NON_PUBLIC, accr:CONFIDENTIAL, accr:RESTRICTED, accr:SENSITIVE |
| conformsTo | dcterms:Standard | optional | An implementing rule or other specification. | |
| contributor | foaf:Agent | optional | An entity responsible for making contributions to the resource. | |
| creator | foaf:Agent | optional | An entity responsible for producing the resource. | |
| hasPart | rdfs:Resource | optional | A related resource that is included either physically or logically in the described resource. | |
| isReferencedBy | rdfs:Resource | optional | A related resource, such as a publication, that references, cites, or otherwise points to the documented resource. | |
| releaseDate | rdfs:Literal
(xsd:date) | optional | The date of formal issuance (e.g., publication) of the resource. | |
| language | rdfs:Literal
(xsd:string) | optional | A language of the resource. | Recommended practice is to use either a non-literal value
representing a language from a controlled vocabulary such as
ISO 639-2 or ISO 639-3, or a literal value consisting of an
IETF Best Current Practice 47
[IETF-BCP47] language
tag.
Example values: "en", "it", "no", "da"
This property can be repeated if the resource is expressed
with multiple languages.
|
| license | dcterms:LicenseDocument | optional | A licence under which the resource is made available. | |
| modificationDate | rdfs:Literal
(xsd:date) | optional | The most recent date on which the resource was changed or modified. | |
| documentation | foaf:Document | optional | A page or document about this resource. | |
| qualifiedAttribution | prov:Attribution | optional | An Agent having some form of responsibility for the resource. | |
| abstract | rdfs:Literal
(rdf:langString) | | A summary of the resource. | |
| bibliographicCitation | rdfs:Literal | | A bibliographic reference for the resource. | Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible. |
| conformance | ddoc:ConformanceLevel | | Whether the annotation is mandatory, recommended or optional. | It MUST take one of the values 'ddoc:mandatory', 'ddoc:recommended' or 'ddoc:optional'. |
| curationDate | xsd:date | | Date of curation. | |
| curator | foaf:Agent | | The agent that curated the resource. | Use ddoc:curationDate to refer to the date of curation. |
| statements | rdfs:Literal
(rdf:JSON) | | A list of subject-predicate-object triples with additional RDF statements documenting the resource. | |
| deprecated | rdfs:Literal
(xsd:boolean) | | The annotation property that indicates that a given entity has been deprecated. It should equal to "true"^^xsd:boolean. | |
| comment | rdfs:Literal | | A description of the subject resource. Use description instead. | |
| domain | rdfs:Resource | | A domain of the subject property. | |
| isDefinedBy | skos:Concept | | Indicate a resource defining the subject resource. This property may be used to indicate an RDF vocabulary in which a resource is described. | |
| label | rdfs:Literal | | Provides a human-readable version of a resource's name. | |
| range | rdfs:Resource | | A range of the subject property. | |
| seeAlso | skos:Concept | | Indicates a resource that might provide additional information about the subject resource. | |
| subPropertyOf | rdf:Property | | The subject is a subproperty of a property. | |
Properties on LicenseDocument¶
A legal document giving official permission to do something with a resource.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| type | skos:Concept | optional | A type of the resource. | A recommended controlled vocabulary data-type is foreseen. For agents, the value should be chosen from ADMS publisher type. |
Properties on Location¶
A spatial region or named place.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| bbox | rdfs:Literal | recommended | The geographic bounding box of a resource. | |
| centroid | rdfs:Literal | recommended | The geographic center (centroid) of a resource. | |
| geometry | locn:Geometry | optional | The geographic center (centroid) of a resource. |
Properties on Agent¶
An agent (eg. person, group, software or physical artifact).
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| name | rdfs:Literal (xsd:string) |
mandatory | A name of the agent. | |
| identifier | rdfs:Literal | optional | URI or other unique identifier of the resource being described. | Recommended practice is to identify the resource by means of a string conforming to an identification system. Examples include International Standard Book Number (ISBN), Digital Object Identifier (DOI), and Uniform Resource Name (URN). Persistent identifiers should be provided as HTTP URIs. |
Properties on Generator¶
A generator that can serialise an instance of a datamodel into a distribution.
- subClassOf: oteio:Parser
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| generatorType | rdfs:Literal | Generator type. Ex: application/vnd.dlite-generate. |
Properties on Parser¶
A parser that can parse a distribution into an instance of a datamodel.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| configuration | rdfs:Literal (rdf:JSON) |
A JSON string with configurations specific to the parser or generator. | ||
| parserType | rdfs:Literal | Parser type. Ex: application/vnd.dlite-parse. |
Properties on Restriction¶
The class of property restrictions.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| maxQualifiedCardinality | rdfs:Literal (xsd:nonNegativeInteger) |
The property that determines the cardinality of a maximum qualified cardinality restriction. | ||
| minQualifiedCardinality | rdfs:Literal (xsd:nonNegativeInteger) |
The property that determines the cardinality of a minimum qualified cardinality restriction. | ||
| qualifiedCardinality | rdfs:Literal (xsd:nonNegativeInteger) |
The property that determines the cardinality of an exact qualified cardinality restriction. |
Properties on Class¶
The class of classes.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| conceptualisation | rdfs:Literal (rdf:langString) |
A comment that helps the reader to understand how the world has been conceptualised by the ontology authors. | ||
| elucidation | rdfs:Literal (rdf:langString) |
Short enlightening explanation aimed to facilitate the user in drawing the connection (interpretation) between a OWL entity and the real world object(s) for which it stands. It should address the real world entities using the concepts introduced by the conceptualisation. | ||
| subClassOf | rdfs:Class | The subject is a subclass of a class. | ||
| altLabel | rdfs:Literal (rdf:langString) |
An alternative lexical label for a resource. | ||
| hiddenLabel | rdfs:Literal (rdf:langString) |
A lexical label for a resource that should be hidden when generating visual displays of the resource, but should still be accessible to free text search operations. | ||
| prefLabel | rdfs:Literal (rdf:langString) |
A preferred label of the concept. |
Properties on Resource¶
Resource published or curated by an agent.
- subClassOf: rdfs:Resource
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| datatype | rdfs:Datatype | A datatype for annotations and data properties. | ||
| usageNote | rdfs:Literal (rdf:langString) |
A reference that provides information on how this resource is to be used. |
Properties on Checksum¶
A preferred label of the concept.
| Keyword | Range | Conformance | Definition | Usage note |
|---|---|---|---|---|
| algorithm | spdx:ChecksumAlgorithm | The algorithm used to produce the subject Checksum. | ||
| checksumValue | rdfs:Literal (xsd:hexBinary) |
A lower case hexadecimal encoded digest value produced using a specific algorithm. |
Properties on Kind¶
A description following the vCard specification, e.g. to provide telephone number and e-mail address for a contact point.