🟢 Annotation Vocabulary (AV)

Maturity: 🟢 Released

IRI: https://spec.industrialontologies.org/ontology/core/meta/AnnotationVocabulary/

The IOF Annotation Vocabulary provides a set of OWL annotation properties for annotating IOF or other content with metadata to facilitate user and ontology developer understanding.

Annotations

Change Note

2022-03-31: added new annotation properties as per “Annotations Vocabulary Version 1.”
2022-09-30: added new annotations and supporting constructs, and modified others to match revised guidance in the IOF Confluence page entitled: “Annotations Vocabulary Version 2”
2022-10-31: revised the IRI structure to correspond to the approved approach to IRI representation documented in https://oagiscore.atlassian.net/wiki/spaces/IOF/pages/3564372109/IRI+Structure+and+Format and ran the RDF serialiser (from FIBO) over the content.
2022-11-30: changed various annotation properties to match revised guidance for formalizing terms as per “Annotations Vocabulary Version 2.1”

Contributor

Elisa Kendall, Thematix Partners LLC

Copyright

Creator

Evan Wallace, NIST
IOF Technical Oversight Board (TOB)
Todd Schneider, Engineering Semantics, LLC

License

http://opensource.org/licenses/MIT

Publisher

Industrial Ontology Foundry

References

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

Title

Industrial Ontology Foundry (IOF) Annotation Vocabulary

Usage Note

The intention of using annotations is to a) help a potential user decide if the ontology or a notion therein meets his or her needs and b) help a user or developer understand the ‘elements’ in the ontology and how to interpret them consistent with the intended interpretation of the IOF. 2. Annotation Usage Conditions The particular annotations that are required or used will depend on the representation language used. IOF ontologies are published using either OWL or Common Logic. As example, the iof-av:firstOrderLogicDefinition should not be used in ontologies using Common Logic. 3. Formal Definition – A statement or expression made using a formal language. A Formal Language can be considered as composed of symbols (aka the alphabet, aka signature), logical symbols (for conjunction, disjunction, implication, equivalence, and quantification), non-logical symbols, and a set of rules for creating (well formed) statements/expressions in the language. In the case of OWL there are non-logical symbols for classes, object properties, and data properties and these non-logical symbols are usually natural language terms or phrases. a) For the IOF these formal languages include First Order Logic (FOL), Common Logic (CL), and OWL. Note that the last two are used for ontology development. b) For classes, the only Formal statements or expressions in an IOF ontology are the First Order Logic Definition annotation and the OWL or Common Logic (class or relation) axioms. Note, in the case of a primitive or axiomatic notion there will be no (complete) necessary and sufficient formal definition or axioms. c) One point to bear in mind in the way the IOF is using formal languages is that the majority of the symbols used are not from the Greek alphabet nor single characters (usually) but are derived from natural language terms or phrases. This distinction must be kept in mind. 4. There will be some notions (e.g. classes) that are taken as primitive. They will not have Formal definitions, but may have formal axioms to constrain the intended interpretation.

Classes (1)

Class	Definition
maturity level	classifier used to specify the state of a resource in its development process

Annotation Properties (28)

Property	Definition
abbreviation	synonym that is an alternate short label for the resource
acronym	an abbreviation usually formed from the initial components of a longer name or phrase
adapted from	source for the resource that was modified to create the subject resource
copyright	exclusive legal right, given to an originator or an assignee to print, publish, perform, film, or record literary, artistic, or mu…
counter example	example that refutes or disproves a concept in some scenario and is intended to demonstrate how the concept might be misused
direct source	definitive source of the subject resource
elucidation	—
excerpted from	source of a resource that was imported unmodified from an external ontology
explanatory note	note that provides additional explanatory information about a given notion or resource
first order logic definition	logic definition that expresses the axioms of a class or an object property in first order logic
first-order logic axiom	logic axiom annotation written in first order logic
is primitive	boolean flag indicating that necessary and sufficient conditions are not provided
logic axiom	logical statements constraining the interpretation of the notion represented by the construct that do not provide necessary and su…
logic definition	definition in the form of a logical expression
maintainer	entity responsible for maintaining the resource
maturity	annotation property used to indicate the development status of a resource
natural language definition	definition written in plain text for human understanding
primitive rationale	reason why necessary and sufficient conditions could not be provided
replaced by	reference to the IRI of the target of a deprecated construct
semi-formal natural language axiom	logic axiom expressed in natural language
semi-formal natural language definition	logic definition that expresses a first order logic definition or common logic definition in natural language
subject matter expert explanation	definition of the term expressed in natural language that has the minimal usage of ontological terms and is intended to be a self-…
symbol	abbreviation that is a design, mark, or character(s) used conventionally to represent something, such as currency, quantity, or va…
synonym	alternative label (designation) used for the resource in some community
usage note	note that provides information about how a given notion or resource is used in the ontology’s context
was defined by	identifies the occurrence time and former location for a construct, annotation, or individual
was moved from	part of a iof-av:wasDefinedBy annotation indicating the previous ontology a construct, annotation, or individual was located
was moved on	part of a iof-av:wasDefinedBy annotation indicating the date and time a construct, annotation, or individual’s location was change…