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.

Start the program

• Checkout the OntologyDocumentation source code from the repository.
• Edit edu.uga.ccrc.ontology.doc.OntologyDocumentation
• Line 14: Change xmlFile to the configuration file of your project
• Line 15: In new OntologyHandler replace the ontology name with your ontology (first parameter), base URI of your ontology (second parameter)
• Line 16: Change the name of the output file to the name you would like to use ("ontology/documentation.docx")
• Run the java class

Configuration file

The configuration file controls the output in the Word file. It consists of three major sections.

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