OntologyDocumentation

OntologyDocumentation

The OntologyDocumentation is a little side project that was created by Rene Ranzinger to auto-generate a Word documentation file out of the information in the ontology. This generator was used for most of the ontology versions to generate the documentation. But the program code is general enough to be used for other ontologies, too.

Word output format

The Word documentation file starts with the headline from the configuration file followed by the list of namespaces defined in the configuration file in form of a table (Prefix used in the documentation and URI). For each specified in the configuration the following information is provided:

• Name of the class as headline (label from the ontology otherwise URI)
• Description of the class in the ontology as text below the headline
• URI of the class
• Superclass
• Instances of the class (if instances in the configuration file is set to true)
• • URI of the instance
• • Label of the instance
• • Description of the instance
• List of predicates that have this class as domain
• • Predicate URI
• • Range
• • Functional (yes or empty)
• • Description of the predicate