OWLDoc

OWLDoc is a tool that generates JavaDoc style html page documentation for an OWL ontology. OWLDoc has been implemented so that it may be used with Protege-OWL in order to generate documentation for OWL ontologies. OWLDoc offers various configuration options. For example it is possible to include the Absract Syntax representation of classes, properties and individuals . OWLDoc also supports the possibility of localising the labels used in the pages it generates - different languages can be 'plugged' in.

An example using the pizza ontology.



 Screenshots



 Download OWLDoc

OWLDoc (build 9) for use with Protege 3.2 beta (build301 tested)

To install OWLDoc, unzip the zip file into the Protege plugins folder.

Last updated: 12th Apr 2006


 Documentation

To use OWLDoc, select "Generate OWLDoc..." from the Tools menu. The OWLDoc dialog shown below will appear. Specify a folder that the OWLDoc will be generated into. If the ontology that you're generating OWLDoc for imports other ontologies then you can specify whether or not you want OWLDoc to be generated for the imported ontologies.



OWLDoc currently offers the following options:
  • Use Browser Text For Index - If selected, causes the indexes that OWLDoc generates to display the browser name (such as rdfs:label) instead of the class ID (rdf:ID)
  • Generate Abstract Syntax - If selected causes the OWL Abstract Syntax representation of the class, property or individual being documented to be inserted into its documentation page.
  • Generate Usage - If selected, causes links to classes, individuals and properties to be inserted that point to descriptions/definitions where the class is used.
  • Label Language - Selects the language that is used for titles and labels in the generated OWLDoc pages. If you would like to add a language, or would like to customise the labels, you need to create an xml language specification file and place it in the languages folder that resides inside the OWLDoc plugin folder. Please see the example labes-es.xml file that contains Spanish labels for an example on how to do this. If you would like to contribute a langauge file for the distribution, please post a message to the Protege-OWL mailing list.
  • Open in browser when finished - If selected, causes the index page to be displayed in the default web browser. Please note that this option is not available on unix/linux.




 Author

Matthew Horridge, The University Of Manchester

Contributions by:

  • Lin Zhang (simplified Chinese language pack)
  • Pekka Valta (Finnish language pack)
  • Jakob Beetz (css linking)
  • Mikel Egaņa Aranguren (Spanish language pack)


 Level of Support

All comments and suggestions/feature request will be appreciated! Please post questions and requests to the Protege OWL mailing list where I will respond to them.


 License

OWLDoc is licensed under the Lesser GNU Public License. The source code is available here as a zip archive.

Copyright University Of Manchester 2004