From 24c6bf79d3df16974bac1f244d23a4b0e6d55fb8 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Thu, 4 Apr 2024 19:51:10 +0200 Subject: [PATCH 1/3] Update readme and preparing develop version --- README.md | 8 ++++---- pom.xml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 50c752f..16bd3bf 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Just add the dependency and repository to your `pom.xml` file as follows. See th com.github.dgarijo Widoco - v1.4.21 + v1.4.22 @@ -57,7 +57,7 @@ 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](https://dgarijo.github.io/Widoco/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. +* 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](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). * Guidelines on the main sections that your document should have and how to complete them. @@ -75,7 +75,7 @@ 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](https://dgarijo.github.io/Widoco/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](https://dgarijo.github.io/Widoco/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](https://dgarijo.github.io/Widoco/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: ``` @@ -134,7 +134,7 @@ docker run -ti --rm \ `-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 -`-confFile PATH`: Load your own configuration file for the ontology metadata. Incompatible with -getOntologyMetadata. See [the configuration documentation](doc/configuration/configuration_doc.md) for more information about the accepted fields. +`-confFile PATH`: Load your own configuration file for the ontology metadata. Use this option if you want to load your own HTML sections as well. Incompatible with -getOntologyMetadata. See [the configuration documentation](doc/configuration/configuration_doc.md) for more information about the accepted fields. `-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. diff --git a/pom.xml b/pom.xml index 84da093..492fb68 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ es.oeg widoco jar - 1.4.22 + 1.4.23 Widoco From 750e453777ba3c7be154df352d5c9d7cd7348853 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Sun, 7 Apr 2024 18:25:57 +0200 Subject: [PATCH 2/3] update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 16bd3bf..8d71dbd 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Just add the dependency and repository to your `pom.xml` file as follows. See th com.github.dgarijo Widoco - v1.4.22 + v1.4.23 From 90406e46e6c722dc5e792467159992482b182e98 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Sun, 7 Apr 2024 18:27:29 +0200 Subject: [PATCH 3/3] adding extra contributor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d71dbd..c47c01c 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ WIDOCO helps you to publish and create an enriched and customized documentation **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, Pat Mc Bennett, Christophe Camel, Jacobus Geluk, Martin Scharm, @rpietzsch, Jonathan Leitschuh, Jodi Schneider, Giacomo Lanza, Alejandra Gonzalez-Beltran, Mario Scrocca, Miguel Angel García, Flores Bakker, @JohnnyMoonlight, René Fritze, @telecsur, Jan Vlug, Han Kruiger, Johannes Theissen-Lipp, Roberto Polli and Victor Chavez. +**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, Pat Mc Bennett, Christophe Camel, Jacobus Geluk, Martin Scharm, @rpietzsch, Jonathan Leitschuh, Jodi Schneider, Giacomo Lanza, Alejandra Gonzalez-Beltran, Mario Scrocca, Miguel Angel García, Flores Bakker, @JohnnyMoonlight, René Fritze, @telecsur, Jan Vlug, Han Kruiger, Johannes Theissen-Lipp, Roberto Polli, Victor Chavez and Sirko Schindler. **Citing WIDOCO**: If you used WIDOCO in your work, please cite the ISWC 2017 paper: https://iswc2017.semanticweb.org/paper-138