diff --git a/README.md b/README.md index 76da114..63ef271 100644 --- a/README.md +++ b/README.md @@ -57,9 +57,9 @@ WIDOCO helps you to publish and create an enriched and customized documentation Features of WIDOCO: * Automatic documentation of the terms in your ontology (based on [LODE](http://www.essepuntato.it/lode/)). Now **you can use Markdown on your class descriptions** (see [example](doc/gallery/index.html)) +* Massive metadata extraction and support: WIDOCO will enhance your ontology documentation based on your ontology annotations. Now you can add custom logos and images, edit the content of your sections, etc. by just editing metadata. See our [supported metadata](https://github.com/dgarijo/Widoco/blob/master/doc/metadataGuide/guide.md) and [recommendations](https://dgarijo.github.io/Widoco/doc/bestPractices/index-en.html) for more information. * 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](https://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](http://vowl.visualdataweb.org/webvowl/)). * Automatic changelog of differences between the actual and the previous version of the ontology (based on [Bubastis](http://www.ebi.ac.uk/efo/bubastis/)). @@ -75,10 +75,28 @@ Examples of the features of WIDOCO can be seen on [the gallery](https://dgarijo. A tutorial explaining the main features of the GUI can be found [here](https://dgarijo.github.io/Widoco/doc/tutorial/) ## Metadata usage -To see how WIDOCO recognizes metadata annotations in your ontology to create the documentation files, see [the Widoco metadata documentation](doc/metadataGuide/guide.md). To learn which metadata properties we recommend adding to your ontology for producing a nice-looking documentation, have a look at our [best practices guide](doc/bestPractices/index-en.html). +To see how WIDOCO recognizes metadata annotations in your ontology to create the documentation files, see [the WIDOCO metadata documentation](doc/metadataGuide/guide.md). To learn which metadata properties we recommend adding to your ontology for producing a nice-looking documentation, have a look at our [best practices guide](doc/bestPractices/index-en.html). + +For example, in order to show your logo in your documentation you just need to use `foaf:logo` as an annotation, as follows: +``` +@prefix owl: . +@prefix foaf: . + a owl:Ontology ; + foaf:logo . +``` + +and it will show right next to the title. The [WIDOCO metadata documentation](doc/metadataGuide/guide.md) shows all supported metadata fields. ## How to use WIDOCO +### Building the JAR executable +We provide JAR files for each release (see the [releases](https://github.com/dgarijo/Widoco/releases) page). However, if you want to build WIDOCO from scratch, just cd into the project folder and run: + +```bash +mvn install +``` +The JAR will be generated in a "JAR" folder. The name will follow the pattern: `widoco-{VERSION_ID}-jar-with-dependencies.jar`, where {VERSION_ID} is the version number of the tool. + ### JAR execution Download the latest `.jar` [WIDOCO available release](https://github.com/dgarijo/WIDOCO/releases/latest) (it will be something like `widoco-VERSION-jar-with-dependencies.jar`). Then just double click the `.jar` file.