Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

When specified, a sub-topic MUST appear after the version date in a versioned IRI or after the topic in a non-versioned IRI. In this case, metadata associated with the supplychain ontology is placed in the meta location. The sub-topic MUST be lowercase with no separation or punctuation between words. Sub-topics MAY have multiple ontologies.

The meta sub-topic area MUST be used for annotations. For example:

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

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

Ontology

...

Name

A module MUST represent an ontology resource without a specific representation. A file is a module An ontology is encoded in a specific representation, such as RDF/XML, Turtle, or CLIF. A given HTTP server delivers an ontology in multiple representations, for example, OWL XML, RDF Schema, Turtle, or JSON-LDa serialization using the HTTP/1.1 Accept header of the request. See Section 14 of IETF RFC 2616 for HTTP/1.1 Accept header use and HTTP/1.1 server requirements. The serialized representation is referred to as an ontology file.

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

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

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

    • The Stasis ontology

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

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

  • https://www.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://www.industrialontologies.org/ontology/supplychain/SupplyChainReferenceOntology/SupplyChainShippingProcess

    • Class SupplyChainShippingProcess of the supply chain topic.

The module ontology name MUST be in Upper Camel Case, each word capitalized with no separation between words. All acronyms MUST be spelled out except when in the dictionary, like RADAR.

The module ontology name MUST NOT have any extensions in the IRI. The following parts of the IRI, class and property names, MUST be separated from the file name by a forward slash / and the IRI MUST end with a forward slash /. owl:imports rdf:resource reference MUST use the IRI with a trailing /.

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

Class Names

Class names MUST be given in Upper Camel Case, each word capitalized, and no separation or punctuation between words. As with the module names, no acronyms MUST NOT occur except those in the dictionary, such as RADAR.

...

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

...