Skip to content

Generator of Html templates to be completed with the documentation of your ontology. It uses the LODE environment to create part of the template. It also adds rdf-a descriptions with the metadata.

License

oxgiraldo/Widoco

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WIzard for DOCumenting Ontologies (Widoco)

Author: Daniel Garijo

Contributors: Idafen Santana, Almudena Ruiz, Miguel Angel García and Oscar Corcho.

Description This project has been created to help you to create a complete documentation of your ontology. The purpose of this project is not to cover any of the functionalities created by other tools like LODE (which describe the classes and properties of a given ontology). Instead, this project reuses LODE (if the user wants to) to create a template that will later be filled with all the details of the ontology. The structure of the template is as follows:

* Basic Metadata: 

	* Title and release
	
	* Current version of the ontology  
	
	* Latest version of the ontology
	
	* Previous version of the ontology
	
	* Revision number
	
	* Authors
	
	* Contributors
	
	* Imported Ontologies
	
	* Extended Ontologies
	
* Abstract

* Table of Contents

* 1. Introduction

	* 1.1 Namespace declarations
	
* 2. Ontology overview

* 3. Ontology description

* 4. Cross reference section (Using LODE)

* 5. References

* 6. Acknowledgements

How to use Widoco

Download all the files of the "JAR" folder into the same folder. Then just double click the .jar file.

For customizing the metadata of your ontology, edit the project properties of /config/config.properties.

The character ";" is used for lists (for instance first author; second author; third author)

Browser problems

The result of executing Widoco is an html file. If you test the file locally, it will NOT work on Chrome (but will work on Firefox and Internet Explorer). However if you place the file on a server, it will work correctly for all the browsers (this is because Chrome doesn't allow doesn't allow XMLHttpRequest without HTTP).

Encoding issues

If you have problems with accents or strange characters, please use the -Dfile.encoding=utf-8 option when running the .jar.

Current updates: Make the application a wizard, being able to load separate sections independently, publish the provenance of the vocabulary, possibility of adding a diagram, possibility of checking the ontology with OOPS

About

Generator of Html templates to be completed with the documentation of your ontology. It uses the LODE environment to create part of the template. It also adds rdf-a descriptions with the metadata.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published