What does OnToology generate

Once you push changes to Github, OnToology will do the below for each changed ontology

  • Generate documentation into HTML using Widoco.
  • Generate diagrams using AR2DTool. It will generate two kinds of diagrams:
    • Class diagram.
    • Taxonomy diagram.
  • Generate evaluation report using OOPS! which is an evaluation of ontology showing pitfalls in a nice organized HTML.
  • Create an issue in Github with evaluation summary.
  • Default configuration file for each ontology, to enable/disable the generation of documentation, diagrams and/or evaluation report.
  • Default configuration files for Widoco and AR2DTool. It also allows you to modify the configuration of these tools.
  • Generate a landing page for a chosen repository (previsualization) with all ontologies in that repository
  • A downloadable bundle for an ontology including documentation, diagrams, evaluation and .htaccess for hosting the ontology
  • Publish an ontology with permanent id (w3id.org) hosted on our server with redirection


Configuration file

The configuation file is per ontology (a repository can has multiple ontologies). It will be created automatically if it does not exist. It is used to enable/disable the generation of documentation, diagrams and/or evaluation.The configuration file has three sections, "widoco", "ar2dtool" and "oops", for documentation, diagrams and evaluation, respectivly. Each of the sections has a key called "enable" and can has the values "true" or "false".

A sample configuration file


Sequence Diagram

What does OnToology do

It generates documentation, diagrams and evaluation report for your ontologies. It also creates an issue in Github with evaluation summary.Once you register your repository OnToology will track your ontologies (in the registered repository) for changes. Whenever a change in an ontology is pushed, OnToology will generate documentation, diagrams and evaluation report for the changed ontologies. After that, OnToology will create a pull request with the generated files. You can enable/disable documentation, visualization or/and evaluation via a configuration file.


Output Structure

OnToology will create a folder named "OnToology" in the top level. Inside this folder, in will create the same structure of the repository. Inside the folder that is named after ontology file, there will be three folders, "documentation", "diagrams" and "evaluation". There will be configuration file "OnToology.cfg" beside these folders.

An example of a repository before OnToology is triggered

After OnToology is triggered


Permission and Security

OnToology will ask for permission depends on the added repository, if the added repository is public, then it will ask permission to access public info, and if the added reposity is private, then it will ask permission to access private information. Also note that OnToology does not store/keep access tokens, it askes permission from GitHub everytime.


Limitations

  • Does not support OWL functional-style syntax
  • Does not support repositories under a Github organization
  • Only works with the master branch
  • Limited by Github repository size
  • Evaluation of large ontologies may not work due to OOPS! webservice timing out (but will still generate documentation and diagrams)







Fork me on GitHub