Contributors:

Terminology used in this document

Overview

The IOF AnnotationVocabulary (AV) OWL file (AnnotationVocabulary) is the normative source for IOF annotation properties. It includes a superset of the annotation properties discussed in this document along with the metadata about them. This document’s purpose is to provide the requirements and instructions for authors of IOF ontologies. The AV should be imported into IOF ontologies under development to make these annotation properties available; however, since the IOF Core imports IOF AV, using AV requires no explicit owl:imports statement.

The rules in this document changed some of the annotations needed by IOF ontologies as compared to those used in Core beta and before, deprecating at least one annotation property and adding a few additional. A revision of the AV consistent with this document was uploaded to the iofoundry/CoreDev GitHub repo (only) 2 Aug 2022, but older versions of the AV will not provide complete support.

All approved ontologies MUST adhere to the following annotation requirements for all constructs.

The following rules MUST be followed when using this document; these are taken from IETF 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 user 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.

Summary of Annotation Requirements

The following annotations MUST be provided for all IOF ontologies:

The following annotations MUST be given in all ontologies:

The following annotations MUST be given for all constructs:

The following annotations SHOULD be given for all constructs and annotation properties:

Annotation Properties

In cases where a text annotation is needed, an American English language version of that annotation is required and MUST use the American English language tag ( xml:lang="en-US"). Spelling in American English annotations MUST conform to an American dictionary, such as Merriam-Webster. Additional annotations covering the same material but expressed in a different natural language are allowed as long as they incorporate the proper language tag. Text annotations that include a language tag have a default datatype of rdf:langString. By definition from the RDFS 1.1 specification, one MUST NOT include an explicit datatype when adding an annotation.

Ontology Annotations

The following is an example of the Ontology annotations from Core. Annotations in the “Active Ontology” tab in Protégé.

	<owl:Ontology rdf:about="https://purl.industrialontologies.org/ontology/core/Core/">
		<rdfs:label xml:lang="en">Core Ontology</rdfs:label>		
		<dcterms:abstract>The IOF Core Ontology contains terms and concepts found to be common across multiple domains of industry and represents an OWL implementation of them. The ontology itself utilizes the Basic Formal Ontology or BFO as a philosophical foundation but also imports terms from various domain-independent or &quot;mid-level&quot; ontologies. The purpose of the ontology is to serve or is intended to serve as a core for IOF&apos;s domain-specific ontologies, with a goal being to ensure consistency and interoperability across the suite of ontologies the IOF publishes.</dcterms:abstract>
		<dcterms:contributor xml:lang="en">Elisa Kendall, Thematix Partners LLC</dcterms:contributor>
		<dcterms:contributor xml:lang="en">Will Sobel, W. V. Sobel LLC</dcterms:contributor>
		<dcterms:creator xml:lang="en">Chris Will, National Center for Ontological Research (NCOR)</dcterms:creator>
		<dcterms:creator xml:lang="en">IOF Core Working Group</dcterms:creator>
		<dcterms:license rdf:datatype="&xsd;anyURI">http://opensource.org/licenses/MIT</dcterms:license>
		<dcterms:publisher xml:lang="en">Industrial Ontology Foundry</dcterms:publisher>
		<dcterms:references rdf:resource="http://purl.org/dc/terms/"/>
		<dcterms:references rdf:resource="http://www.w3.org/2004/02/skos/core#"/>
		<dcterms:title>Industrial Ontology Foundry (IOF) Core Ontology</dcterms:title>

Label

Natural Language

Primitive Term Annotations

Logical Annotations

Symbol

Meaning

UTF-8 Code

Conjunction

U+2227

Disjunction

U+2228

¬

Negation

U+00AC

Existential Quantification

U+2203

Universal Quantification

U+27C7

Implication/Conditional

U+2192

Equivalence/Bi-Implication

U+2194

( )

Left/Right Parentheses

Left: U+0028, Right: U+0029

[ ]

Left/Right Square Brackets

Left: U+005B, Right: U+005D

{ }

Left/Right Braces

Left: U+007B, Right: U+007D

Example Annotations

Source Annotations

Addressing Citations

A source is a related resource from which the described resource is derived. Since annotations can be applied to annotations, the appropriate source annotation property described below SHOULD be attached to the element where the influence of the source manifests. This element could be an entire construct or an annotation on a construct such as a natural language definition. A source annotation SHOULD be concise, but may be in the form of a URL, bibliographic citation, or other standard description.

Notes

Synonyms and Abbreviations

Ontology Annotations

The following annotations apply to an entire IOF ontology and not to individual constructs of the ontology

Prefixes and Namespaces

This document identifies each annotation property using an abbreviated form of its full IRI with the structure <prefix>:<local name>, where the prefix represents the namespace IRI, and the local name is the identifier for the resource within the namespace. The full IRI is the concatenation of the local name to the namespace IRI; for example, skos:scopeNote represents http://www.w3.org/2004/02/skos/core#scopeNote. An ontology author may never use this expanded form directly. However, for completeness, a table below is provided that enumerates all the prefixes used in the document along with the namespaces that they represent.

Prefix

Namespace

dcterms

http://purl.org/dc/terms/

iof-av

https://purl.industrialontologies.org/ontology/core/meta/AnnotationVocabulary/

owl

http://www.w3.org/2002/07/owl#

rdfs

http://www.w3.org/2000/01/rdf-schema

skos

http://www.w3.org/2004/02/skos/core#

Reference Documents

6.2.3.2 Upper case characters, mathematical symbols, typographical signs and syntactic signs (e.g. punctuation marks, hyphens, parentheses, square brackets and other connectors or delimiters) as well as their character styles (i.e. fonts and bold, italic, bold italic, or other style conventions) shall be used in a term only if they constitute part of the normal written form of the term as conventionally used in running text. Syntactic signs shall not be used to show alternative terms. For complex terms (e.g. compounds and multiword terms), the natural word order shall be retained.

Annex

Semi-Formal Natural Language Discussion

To be added

Barry’s comments: