Skip to content

Latest commit

 

History

History
152 lines (103 loc) · 10.1 KB

README.md

File metadata and controls

152 lines (103 loc) · 10.1 KB
Raw

WIzard for DOCumenting Ontologies (WIDOCO)

DOI

Logo

Author: Daniel Garijo Verdejo (@dgarijo)

Contributors: María Poveda, Idafen Santana, Almudena Ruiz, Miguel Angel García, Oscar Corcho, Daniel Vila, Sergio Barrio, Martin Scharm, Maxime Lefrancois, Alfredo Serafini, @kartgk.

Citing WIDOCO: If you used WIDOCO in your work, please cite the ISWC 2017 paper: https://iswc2017.semanticweb.org/paper-138

@inproceedings{garijo2017widoco,
  title={WIDOCO: a wizard for documenting ontologies},
  author={Garijo, Daniel},
  booktitle={International Semantic Web Conference},
  pages={94--102},
  year={2017},
  organization={Springer, Cham},
  doi = {10.1007/978-3-319-68204-4_9},
  funding = {USNSF ICER-1541029, NIH 1R01GM117097-01},
  url={http://dgarijo.com/papers/widoco-iswc2017.pdf}
}

If you want to cite the latest version of the software, you can do so by using: https://zenodo.org/badge/latestdoi/11427075.

Downloading the executable

To download WIDOCO, you need to download a JAR executable file. Check the latest release for more details: (https://github.com/dgarijo/WIDOCO/releases/latest).

Importing WIDOCO as a dependency

Just add the dependency and repository to your pom.xml file as follows. See the WIDOCO JitPack page to find alternative means to incorporate WIDOCO to your project.

<dependencies>
  <dependency>
      <groupId>com.github.dgarijo</groupId>
      <artifactId>Widoco</artifactId>
      <version>v1.4.13</version>
  </dependency>
</dependencies>

[ ... ]

<repositories>
	<repository>
	    <id>jitpack.io</id>
	    <url>https://jitpack.io</url>
	</repository>
</repositories>

Description

WIDOCO helps you to publish and create an enriched and customized documentation of your ontology, by following a series of steps in a wizard. We extend the LODE framework by Silvio Peroni to describe the classes, properties and data properties of the ontology, the OOPS! webservice by María Poveda to print an evaluation and the Licensius service by Victor Rodriguez Doncel to determine the license URI and title being used. In addition, we use WebVowl to visualize the ontology and have extended Bubastis to show a complete changelog between different versions of your ontology.

Features of WIDOCO:

  • Automatic documentation of the terms in your ontology (based on LODE). Now you can use Markdown on your class descriptions (see example)
  • Automatic annotation in JSON-LD snippets of the html produced.
  • Association of a provenance page which includes the history of your vocabulary (W3C PROV-O compliant).
  • Metadata extraction from the ontology plus the means to complete it on the fly when generating your ontology. Check the best practice document to know more about the terms recognized by WIDOCO.
  • Guidelines on the main sections that your document should have and how to complete them.
  • Integration with diagram creators (WebVOWL).
  • Automatic changelog of differences between the actual and the previous version of the ontology (based on Bubastis).
  • Separation of the sections of your html page so you can write them independently and replace only those needed.
  • Content negotiation and serialization of your ontology according to W3C best practices

Examples

Examples of the features of WIDOCO can be seen on the gallery

Tutorial

A tutorial explaining the main features of the GUI can be found here

How to use WIDOCO

Download the latest .jar WIDOCO available release (it will be something like widoco-VERSION-jar-with-dependencies.jar). Then just double click the .jar file.

You may also execute WIDOCO through the command line. Usage:

java -jar widoco-VERSION-jar-with-dependencies.jar [OPTIONS]

OPTIONS:

-ontFile PATH [required (unless -ontURI is used)]: Load a local ontology file (from PATH) to document. This option is incompatible with -ontURI

-ontURI URI [required (unless -ontFile is used)]: Load an ontology to document from its URI. This option is incompatible with -ontFile

-outFolder folderName: Specifies the name of the folder where to save the documentation. By default is 'myDocumentation'

-confFile PATH: Load your own configuration file for the ontology metadata. Incompatible with -getOntologyMetadata

-getOntologyMetadata: Extract ontology metadata from the given ontology

-oops: Create an html page with the evaluation from the OOPS service (http://oops.linkeddata.es/)

-rewriteAll: Replace any existing files when documenting an ontology (e.g., from a previous execution)

-crossRef: ONLY generate the overview and cross reference sections. The index document will NOT be generated. The htaccess, provenance page, etc., will not be generated unless requested by other flags. This flag is intended to be used only after a first version of the documentation exists.

-saveConfig PATH: Save a configuration file on PATH with the properties of a given ontology

-useCustomStyle: Export the documentation using alternate css files (by Daniel Vila).

-lang LANG1-LANG2: Generate documentation in multiple languages (separated by "-"). Note that if the language is not supported, the system will load the labels in english. For example: en-pt-es

-includeImportedOntologies: Indicates whether the terms of the imported ontologies of the current ontology should be documented as well or not. -htaccess: Create a bundle for publication ready to be deployed on your Apache server.

-webVowl: Create a visualization based on WebVowl (http://vowl.visualdataweb.org/webvowl/index.html#) in the documentation.

-licensius: Use the Licensius web services (http://licensius.com/apidoc/index.html) to retrieve license metadata. Only works if the -getOntologyMetadata flag is enabled.

-ignoreIndividuals: Individuals will not be included in the documentation. -includeAnnotationProperties: Include annotation properties defined in your ontology in the documentation (by default they are not included)

-analytics CODE: Add a code snippet for Google analytics to track your HTML documentation. You need to add your CODE next to the flag. For example: UA-1234

-doNotDisplaySerializations: The serializations of the ontology will not be displayed.

-displayDirectImportsOnly: Only those imported ontologies that are directly imported in the ontology being documented.

-rewriteBase PATH: Change the default rewrite base path. The default value is "/". This flag can only be used with the htaccess option.

-excludeIntroduction: Skip the introduction section in the documentation.

-uniteSections: Write all HTML sections into a single HTML document.

--help: Shows a help message and exits.

How can I make WIDOCO automatically recognize my vocabulary annotations?

There are two ways for making WIDOCO get your vocabulary metadata annotations and use them automatically to document the ontology.

  • Add them in your OWL file. For guidelines on which ones to include, follow our best practices document, which indicates which ones we recommend.
  • Edit the project properties of /config/config.properties. This is a key-value pair file with metadata properties. Some people consider it easier than adding the property annotations to the OWL file, although I recommend doing the former option. Note that the character ";" is used for lists (for instance first author; second author; third author).

Browser issues (Why can't I see the generated documentation / visualization?)

WIDOCO separates the contents of different sections in HTML files, which are then loaded in the index.html file. WIDOCO was designed this way because it's easier to edit your introduction or description sections independently without being all aggregated together in a huge HTML document. When all the contents generated by WIDOCO are stored in a server, you will be able to see the documentation of your ontology using any browser. However, if you open the index.html file on your local browser, you may see a document missing most of the sections in your documentation. This happens because browsers don't allow loading separate content when opening a file locally for security reasons. If you want to explore how your ontology would look locally, you have two options:

  • a) Execute WIDOCO with the -uniteSections flag; or select the option add al sections in a single document in the "load sections" step in the WIDOCO GUI. This will make all the sections of WIDOCO to be in the index.html; and you will be able to see it in your browser. Note that the LODE visualization will not be available when exploring your ontology locally.
  • b) Create a local server: Set up a local server (e.g., using XAMPP or Tomcat) and serve the files WIDOCO generates (in the htdocs folder for Apache servers).

If you place the files generated by WIDOCO in a server and access them via its URL (for example, a Github page), you should be able to see your documentation appropriately.

Current improvements

For a complete list of the current improvements and next features, check the project open issues and milestones in the repository.

Requirements

You will need Java 1.8 or higher (SDK 1.8 or JRE 8) for WIDOCO to work Otherwise, you will probably experience an "Unsupported major.minor version 52.0" exception when executing the JAR file.

Contribution guidelines

Contributions to address any of the current issues are welcome. In order to push your contribution, just push your pull request to the develop branch. The master branch has only the code associated to the latest release.