...

Document Approved: 2021-06-18 (Quorum achieved on 2021-06-11)

Overview

The IRI structure of the IOF references the OWL documents providing a versioned and not-versioned form. The latter form will always refer to the latest released version of the documents. For the IRI syntax, please refer to RFC 3987 from The Internet Engineering Task Force (IETF).

...

All IOF IRIs MUST be resolvable and refer to a resource that can be retrieved from the internet. The form of the IRI MUST specify the protocol as HTTPS and the authority MUST be a domain administered and owned by the IOF or its parent organization. The IOF MUST choose a single authority for all ontologies released by the IOF. The authority wwwpurl.industrialontologies.org is used for illustrative purposes only. When decided, this document MUST be revised with the normative authority.

• For the given IRI: https://wwwpurl.industrialontologies.org/ontology/supplychain

• The protocol: https

• The authority: wwwpurl.industrialontologies.org

The authority MUST be a domain administered and owned by the IOF or its parent organization. The IOF MUST choose a single authority for all ontologies released by the IOF. The authority MUST be wwwpurl.industrialontologies.org unless it is not possible due to technical reasons. Otherwise, the authority may begin with an alternative such as wwwpurl.industrialontologies.org or onto.industrialontologies.org.

...

• For the given IRI: https://wwwpurl.industrialontologies.org/ontology/supplychain

• The path component: /ontology/supplychain

...

• For the given IRI: https://wwwpurl.industrialontologies.org/ontology/supplychain

• The root part: /ontology

...

The topic areas MUST form the path part of the IRI. The topic areas MUST be all lower case with no separation or punctuation between words. All acronyms MUST be spelled out, except for words defined in the dictionary like radar (RADAR) always given in lowercase. The following are examples of topic areas:

• https://wwwpurl.industrialontologies.org/ontology/supplychain

• https://wwwpurl.industrialontologies.org/ontology/foundation

• https://wwwpurl.industrialontologies.org/ontology/productionprocess

...

The non-versioned IRI MUST always reference the latest released version of the ontology.

• Versioned IRI: https://wwwpurl.industrialontologies.org/ontology/supplychain/20210621/meta

• Non-Versioned IRI: https://wwwpurl.industrialontologies.org/ontology/supplychain/meta

...

The meta sub-topic area MUST be used for ontologies consisting solely of annotations properties. For example:

• IRI:

• https://wwwpurl.industrialontologies.org/ontology/core/meta/AnnotationVocabulary/

• Version IRI:

• https://wwwpurl.industrialontologies.org/ontology/core/20210601/meta/AnnotationVocabulary/

...

Following the topic and sub-topic resource locations, the ontology name MUST be given without extension as follows:

• https://wwwpurl.industrialontologies.org/ontology/core/meta/AnnotationVocabulary/

• https://wwwpurl.industrialontologies.org/ontology/core/domainindependent/Stasis/

  • The Stasis ontology of the domainindependent sub-topic of the core topic

• https://wwwpurl.industrialontologies.org/ontology/core/domainindependent/Stasis/Stasis

  • Class Stasis in the Stasis ontology of the domainindependent sub-topic of the core topic.

• https://wwwpurl.industrialontologies.org/ontology/core/domainindependent/Stasis/triggers

  • Object property triggers in the Stasis ontology of the domain independent sub-topic of the core topic.

• https://wwwpurl.industrialontologies.org/ontology/supplychain/SupplyChainReferenceOntology/SupplyChainShippingProcess

  • Class SupplyChainShippingProcess of the SupplyChainReferenceOntology ontology of the supplychain topic.

...

• <owl:imports rdf:resource="<https://wwwpurl.industrialontologies.org/ontology/core/domainindependent/Stasis/>"/>

...

• .../ontology/foundation/20210611/meta/AnnotationVocabulary/usageNote

• .../ontology/foundation/20210611/meta/AnnotationVocabulary/adaptedFrom

TOB Vote:

Old notes for reference…

IRI Structural Rules in the following order

• Authority: www.industrialontologies.org

• Top: /ontology

• Topic areas are lowercase with no punctuation or separation:

  • /supplychain

  • /foundation

• Versioned IRI:

  • Release date after highest level topic area

  • Date format: YYYYMMDD

  • /supplychain/20210601

  • /foundation/20210601/meta

• File-name Upper Camel Case with no punctuation: AnnotationVocabulary

  • Uppercase first letter of each word, no separation

  • All acronyms are spelled out

    • Exceptions like RADAR, words appearing in the dictionary

• Class and properties separated from path with a /

  • /ontology/foundation/meta/AnnotationVocabulary/usageNote

• Class name Upper Camel Case:

  • Uppercase first letter of each word, no separation

  • All acronyms are spelled out

    • Exceptions like RADAR, words appearing in the dictionary

• Object property Lower Camel Case:

  • Lowercase first letter, uppercase each following word

  • All property names MUST be verb or verb phrase

  • hasParticipant

• Data properties and annotation names Lower Camel Case

  • Lowercase first letter, uppercase each following word

  • Verb phrase starting with has

  • hasTag

  • hasDateValue

• Annotation properties

  • Lowercase first letter, uppercase each following word

  • usageNote

  • adaptedFrom

• Versioned and unversioned forms MUST be provided.

Examples

...

Unversioned: /ontology/foundation/meta/AnnotationVocabulary/usageNote

...

Versioned: /ontology/foundation/20210601/meta/AnnotationVocabulary/usageNote

...