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).

...

The following rules MUST be followed when reviewing this document, these are taken from IETF https://datatracker.ietf.org/doc/html/rfc2119 RFC 2119 (simplified):

1. MUST: This word means that the definition is an absolute requirement of the specification.

2. MUST NOT: This phrase means that the definition is an absolute prohibition of the specification.

3. SHOULD: This word means that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications MUST be understood and carefully weighed before choosing a different course.

4. SHOULD NOT: This phrase means that there may exist valid reasons in particular circumstances when the particular behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label.

5. MAY: This word means that an item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because the vendor feels that it enhances the product while another vendor may omit the same item.

...

IRI Path

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.

IRI Path Root

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

Topic Area

...

• .../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/

...