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 www.industrialontologies.org is used for illustrative purposes only. When decided, this document MUST be revised with the normative authority.

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 www.industrialontologies.org unless it is not possible due to technical reasons. Otherwise, the authority may begin with an alternative such as www.industrialontologies.org or onto.industrialontologies.org.

...

In accordance with IETF RFC 3987, the Path component of the IRI MUST immediately follow the authority starting with a forward-slash (/), and the Path parts MUST be separated by forward-slashes (/). The first part of the Path is referred to as the Path Root.

• The protocol: https

• The authority: www.industrialontologies.org

• The path: /ontology/supplychain

IRI Path Root

The IRI Path Root MUST be /ontology. The Root provides the ability to have documentation and other supporting resources referenced in alternate Root resources, such as /documentation or /references. The IOF MUST designate each root resource for a specified use.

...

A topic represents a domain area of concern addressed by one or more working groups. The topic organizes sub-topics and modules. The IOF provides the ontology organization rules for topics, sub-topics, and modules in publication (a reference to organization topic/domain structure document). All content within a topic MUST be released with a common version. The version of one topic does not constrain another topic’s version.

...

• https://www.industrialontologies.org/ontology/foundation/meta/AnnotationVocabulary

• https://www.industrialontologies.org/ontology/foundation/20210601/meta/AnnotationVocabulary

Ontology Module Name

Def of module. file grouping without representation.

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

...

A data property MUST be a verb phrase starting with has or is for boolean and MUST SHOULD end with Value. Examples:

• hasTagValue

• hasDateValue

...

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

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

...

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

• /ontology/supplychain/

...