Skip to content

Commit

Permalink
Merge remote-tracking branch 'refs/remotes/origin/develop'
Browse files Browse the repository at this point in the history
  • Loading branch information
dgarijo committed May 13, 2017
2 parents b0bdc27 + 57f34da commit 5fbc900
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 15 deletions.
32 changes: 18 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
WIzard for DOCumenting Ontologies (Widoco)
WIzard for DOCumenting Ontologies (WIDOCO)
===================
[![DOI](https://zenodo.org/badge/11427075.svg)](https://zenodo.org/badge/latestdoi/11427075)

Expand All @@ -9,25 +9,29 @@ Contributors: Idafen Santana, Almudena Ruiz, Miguel Angel García, Oscar Corcho,
Download the executable
===================

To download Widoco JAR, check the latest release (https://github.com/dgarijo/Widoco/releases/latest).
To download WIDOCO JAR, check the latest release (https://github.com/dgarijo/WIDOCO/releases/latest).

Citing Widoco
Citing WIDOCO
===================

Please cite the latest version of Widoco in Zenodo: https://zenodo.org/badge/latestdoi/11427075
Please cite the latest version of WIDOCO in Zenodo: https://zenodo.org/badge/latestdoi/11427075

Description
==========
Widoco helps you to publish and create a complete 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 webowl to visualize the ontology and have extended Bubastis to show a complete changelog between different versions of your ontology.
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.

The purpose of Widoco is to reuse and integrate existing tools for documentation and diagram creation, plus the set of features listed below:
* Separation of the sections of your html page so you can write them independently and replace only those needed.
Features of WIDOCO:
* Automatic documentation of the terms in your ontology (based on LODE)
* 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.
* Metadata extraction from the ontology plus the means to complete it on the fly when generating your ontology. Check the [best practice document](http://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html) 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.
* 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

[See some examples](http://dgarijo.github.io/WIDOCO/doc/gallery/)

The structure of the template is as follows:

Expand Down Expand Up @@ -56,27 +60,27 @@ The structure of the template is as follows:
* 7. Acknowledgements


How to use Widoco
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).

Now you can execute Widoco through the console. Usage:
Now you can execute WIDOCO through the console. Usage:

java -jar widoco.jar [-ontFile file] or [-ontURI uri] [-outFolder folderName] [-confFile propertiesFile] or [-getOntologyMetadata] [-oops] [-rewriteAll] [-crossRef] [-saveConfig configOutFile] [-useCustomStyle] [-lang lang1-lang2] [-includeImportedOntologies] [-htaccess] [-webVowl] [-licensius] [-ignoreIndividuals]
java -jar WIDOCO.jar [-ontFile file] or [-ontURI uri] [-outFolder folderName] [-confFile propertiesFile] or [-getOntologyMetadata] [-oops] [-rewriteAll] [-crossRef] [-saveConfig configOutFile] [-useCustomStyle] [-lang lang1-lang2] [-includeImportedOntologies] [-htaccess] [-webVowl] [-licensius] [-ignoreIndividuals]

The ontFile and ontURI options allow you to choose the ontology file or ontology URI of your ontology.

The -outFolder option specifies where you want to place the output.

The -confFile allows you to choose your own configuration file for the ontology metadata. However you can tell Widoco to try to extract some of the metadata from the ontology with getOntologyMetadata.
The -confFile allows you to choose your own configuration file for the ontology metadata. However you can tell WIDOCO to try to extract some of the metadata from the ontology with getOntologyMetadata.

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

The -rewriteAll option will tell Widoco to rewrite files if the new generate files are replacing existing files. Otherwise the tool will promt a window asking the user.
The -rewriteAll option will tell WIDOCO to rewrite files if the new generate files are replacing existing files. Otherwise the tool will promt a window asking the user.

The -crossRef option will 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 in intended to be used only after a first version of the documentation exists.

Expand All @@ -98,7 +102,7 @@ The -ignoreIndividuals allows you to ignore the named individuals in the ontolog

Browser problems
==========
The result of executing Widoco is an html file. We have tested it in Mozilla, IE and Chrome, and when the page is stored in a server all the browsers work correctly. If you view the file locally, we recommend you to use Mozilla Firefox or Safari (or Internet Explorer, if you must). Google Chrome will not show the contents correctly, as it doesn't allow XMLHttpRequest without HTTP. If you want to view the page locally with Google Chrome you have two possibilities:
The result of executing WIDOCO is an html file. We have tested it in Mozilla, IE and Chrome, and when the page is stored in a server all the browsers work correctly. If you view the file locally, we recommend you to use Mozilla Firefox or Safari (or Internet Explorer, if you must). Google Chrome will not show the contents correctly, as it doesn't allow XMLHttpRequest without HTTP. If you want to view the page locally with Google Chrome you have two possibilities:

a) Place the file in a server and access it via its URL (for example, put it in dropbox and access through its public url).

Expand Down
2 changes: 1 addition & 1 deletion doc/gallery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Data Narratives examples</title>
<title>Gallery</title>


<!-- Bootstrap -->
Expand Down

0 comments on commit 5fbc900

Please sign in to comment.