From 8dd6fcbcd6fac9123786a82d6f6b21bc2529a4d8 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Tue, 30 Apr 2024 17:16:36 +0200 Subject: [PATCH 1/9] update version --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c47c01c..d5d9aa7 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.23 + v1.4.24 From 63c0ccb49282e2b9cf7378ee4b253b02f6676b34 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Dierick?= Date: Wed, 29 May 2024 14:19:53 +0200 Subject: [PATCH 2/9] add cli flag for excluding provenance link section --- src/main/java/widoco/gui/GuiController.java | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/main/java/widoco/gui/GuiController.java b/src/main/java/widoco/gui/GuiController.java index 3070dd3..8af78d8 100644 --- a/src/main/java/widoco/gui/GuiController.java +++ b/src/main/java/widoco/gui/GuiController.java @@ -107,8 +107,8 @@ public GuiController(String[] args) { boolean isFromFile = false, oops = false, rewriteAll = false, getOntoMetadata = true, useW3Cstyle = true, includeImportedOntologies = false, htAccess = false, webVowl = false, errors = false, licensius = false, generateOnlyCrossRef = false, includeNamedIndividuals = true, includeAnnotationProperties = false, - displaySerializations = true, displayDirectImportsOnly = false, excludeIntroduction = false, uniteSections = false, - placeHolderText = true, localImports=false; + displaySerializations = true, displayDirectImportsOnly = false, excludeIntroduction = false, excludeProvenance = false, + uniteSections = false, placeHolderText = true, localImports=false; String confPath = ""; String code = null;// for tracking analytics. String[] languages = null; @@ -203,6 +203,9 @@ public GuiController(String[] args) { case "-noPlaceHolderText": placeHolderText = false; break; + case "-excludeProvenance": + excludeProvenance = true; + break; case "--help": System.out.println(Constants.HELP_TEXT); return; @@ -270,6 +273,9 @@ public GuiController(String[] args) { this.config.setIncludeAbstract(false); } } + if (excludeProvenance) { + this.config.setPublishProvenance(false); + } if (code != null) { this.config.setGoogleAnalyticsCode(code); } From 4f458114a30697bf05b2abf15aa4d2534f3b8125 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Dierick?= Date: Wed, 29 May 2024 15:14:44 +0200 Subject: [PATCH 3/9] add readme entry for excludeProvenance flag --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c47c01c..e85bf05 100644 --- a/README.md +++ b/README.md @@ -165,6 +165,8 @@ docker run -ti --rm \ `-noPlaceHolderText`: Do not add any placeholder text (this will remove intro, abstract (if empty) and description sections). +`-excludeProvenance`: Do not add the link "Provenance of this page" in the metadata header section + `-ontFile PATH` [required (unless -ontURI is used)]: Load a local ontology file (from PATH) to document. This option is incompatible with -ontURI `-outFolder folderName`: Specifies the name of the folder where to save the documentation. By default is 'myDocumentation' From ebc2fc06e00d0d2a8a17d76936859c19d7ac87f5 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jun 2024 17:02:49 +0000 Subject: [PATCH 4/9] Bump docker/build-push-action from 5.3.0 to 5.4.0 Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5.3.0 to 5.4.0. - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/v5.3.0...v5.4.0) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a64a5b1..0468719 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -58,7 +58,7 @@ jobs: with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - name: Build and push - uses: docker/build-push-action@v5.3.0 + uses: docker/build-push-action@v5.4.0 with: push: ${{ github.event_name != 'pull_request' && github.actor != 'dependabot[bot]' }} tags: ${{ steps.meta.outputs.tags }} From b1e1a7801ec27a116958f241e67451a506b7dafd Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 17 Jun 2024 17:57:35 +0000 Subject: [PATCH 5/9] Bump docker/build-push-action from 5.4.0 to 6.0.0 Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 5.4.0 to 6.0.0. - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/v5.4.0...v6.0.0) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0468719..d351af7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -58,7 +58,7 @@ jobs: with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - name: Build and push - uses: docker/build-push-action@v5.4.0 + uses: docker/build-push-action@v6.0.0 with: push: ${{ github.event_name != 'pull_request' && github.actor != 'dependabot[bot]' }} tags: ${{ steps.meta.outputs.tags }} From 0e339f16b41460586a6bf6b745707f6d863dde92 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 24 Jun 2024 17:05:09 +0000 Subject: [PATCH 6/9] Bump docker/build-push-action from 6.0.0 to 6.1.0 Bumps [docker/build-push-action](https://github.com/docker/build-push-action) from 6.0.0 to 6.1.0. - [Release notes](https://github.com/docker/build-push-action/releases) - [Commits](https://github.com/docker/build-push-action/compare/v6.0.0...v6.1.0) --- updated-dependencies: - dependency-name: docker/build-push-action dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d351af7..a55801c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -58,7 +58,7 @@ jobs: with: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} - name: Build and push - uses: docker/build-push-action@v6.0.0 + uses: docker/build-push-action@v6.1.0 with: push: ${{ github.event_name != 'pull_request' && github.actor != 'dependabot[bot]' }} tags: ${{ steps.meta.outputs.tags }} From c7c6a5cad798e4cf73a2202ad2623bf5a31e09b2 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Sun, 30 Jun 2024 11:20:47 +0200 Subject: [PATCH 7/9] Fix #694 --- doc/adoption/readme.md | 2 +- doc/bestPractices/sections/checklist-en.html | 4 ++-- doc/tutorial/index.html | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/adoption/readme.md b/doc/adoption/readme.md index 562f656..2eb528b 100644 --- a/doc/adoption/readme.md +++ b/doc/adoption/readme.md @@ -6,7 +6,7 @@ WIDOCO has been used to document **more than a hundred ontologies from different * [Vocab](http://vocab.linkeddata.es): Project grouping many of the vocabularies developed or contributed to by the [Ontology Engineering Group](http://www.oeg-upm.net/). At the moment the site includes a total of 41 vocabularies, **30 of them directly documented with WIDOCO**. These vocabularies are associated to projects from different domains, such as: * eScience ([Smart Protocols](http://purl.org/net/SMARTprotocol), [provenance in workflows](http://www.opmw.org/ontology/), etc.) * [Licensing](http://purl.oclc.org/NET/ldr/ns) - * [Libraries](http://datos.bne.es/def/) + * [Libraries](https://web.archive.org/web/20170701004216/https://datos.bne.es/def/ontology.html) * [Videogames](http://purl.org/net/vgo) * [Environment modeling](https://w3id.org/def/saref4envi#) * [Quality modeling](http://vocab.linkeddata.es/qmo/index.html) diff --git a/doc/bestPractices/sections/checklist-en.html b/doc/bestPractices/sections/checklist-en.html index 6791d36..89ea351 100644 --- a/doc/bestPractices/sections/checklist-en.html +++ b/doc/bestPractices/sections/checklist-en.html @@ -14,7 +14,7 @@

Vocabulary namespace URI [
Example:
@@ -30,7 +30,7 @@

Prefix [REC

Preferred prefix used to refer to the ontology. This is important to let potential reusers know how you expect your ontology to be abbreviated. You want everyone to refer to it in the same way. It's also recommended to register your prefix at the http://prefix.cc service, so other KG engineers are able to find the URI of your ontology.

Example:
diff --git a/doc/tutorial/index.html b/doc/tutorial/index.html index 79e5832..f591799 100644 --- a/doc/tutorial/index.html +++ b/doc/tutorial/index.html @@ -216,7 +216,7 @@

4.5 Generating an automated Changelog

4.6 Changing default documentation style

- You can customize the style in which WIDOCO displays the documentation by editing the CSS included in the main folder. However, one of WIDOCO's users contributed a new stylem used in the BNE ontology. If you like it, just select the "Custom" style option. + You can customize the style in which WIDOCO displays the documentation by editing the CSS included in the main folder. However, one of WIDOCO's users contributed a new style used in the BNE ontology. If you like it, just select the "Custom" style option.

4.7 Documentation Analytics

From 4a54261c55ababac1b54668befe481eb59817585 Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Sun, 30 Jun 2024 11:26:10 +0200 Subject: [PATCH 8/9] Fix #698 --- doc/bestPractices/sections/checklist-en.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/bestPractices/sections/checklist-en.html b/doc/bestPractices/sections/checklist-en.html index 89ea351..68cf97c 100644 --- a/doc/bestPractices/sections/checklist-en.html +++ b/doc/bestPractices/sections/checklist-en.html @@ -711,7 +711,7 @@

Example:
@prefix owl: <http://www.w3.org/2002/07/owl#> . @prefix : <https://w3id.org/example#> . :Researcher rdf:type owl:Class ; - vann:example "Daniel Garijo"@en . + owl:deprecated "true"^^xsd:boolean .

Status [OPTIONAL]

From abe5a7d1aecd61e1a6268f7a1ce12ab793800efd Mon Sep 17 00:00:00 2001 From: Daniel Garijo Date: Sun, 30 Jun 2024 11:37:29 +0200 Subject: [PATCH 9/9] Fix #698 --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a647606..573fe6c 100644 --- a/README.md +++ b/README.md @@ -107,19 +107,35 @@ java -jar widoco-VERSION-jar-with-dependencies.jar [OPTIONS] ``` ### Docker execution +If you don't want to use the JAR directly, you may run the project using a [Docker container](https://www.docker.com/). First you will need to download or build the image, and then run it. -First build the image using the `Dockerfile` in project folder: +#### Reusing a pre-existing image +We build containers in the [GitHub image registry](https://github.com/dgarijo/Widoco/pkgs/container/widoco) for all latest releases. In order to import one, just run the following command, stating the version of Widoco you prefer (e.g., for v1.4.23): + +``` +docker pull ghcr.io/dgarijo/widoco:v1.4.23 +``` + +To browse all available images, see the [GitHub image registry](https://github.com/dgarijo/Widoco/pkgs/container/widoco). + +#### Building the image yourself + +Build the image using the `Dockerfile` in project folder: ```bash docker build -t dgarijo/widoco . ``` +#### Running WIDOCO's image + You can now execute WIDOCO through the command line. Usage: ```bash docker run -ti --rm dgarijo/widoco [OPTIONS] ``` +**Note:** If you downloaded the image from the GitHub registry, you will have to change `dgarijo/widoco` with the name of the image you downloaded. For example `ghcr.io/dgarijo/widoco:v1.4.23`. + If you want to share data between the Docker Container and your Host, for instance to load a local ontology file (from PATH), you will need to mount the container with host directories. For instance: @@ -130,7 +146,7 @@ docker run -ti --rm \ dgarijo/widoco -ontFile in/bne.ttl -outFolder out -rewriteAll ``` -### Options +### Execution options `-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 @@ -144,6 +160,8 @@ docker run -ti --rm \ `-excludeIntroduction`: Skip the introduction section in the documentation. +`-excludeProvenance`: Do not add the link "Provenance of this page" in the metadata header section + `-getOntologyMetadata`: Extract ontology metadata from the given ontology `--help`: Shows a help message and exits. @@ -165,8 +183,6 @@ docker run -ti --rm \ `-noPlaceHolderText`: Do not add any placeholder text (this will remove intro, abstract (if empty) and description sections). -`-excludeProvenance`: Do not add the link "Provenance of this page" in the metadata header section - `-ontFile PATH` [required (unless -ontURI is used)]: Load a local ontology file (from PATH) to document. This option is incompatible with -ontURI `-outFolder folderName`: Specifies the name of the folder where to save the documentation. By default is 'myDocumentation' @@ -185,7 +201,7 @@ docker run -ti --rm \ `-useCustomStyle`: Export the documentation using alternate css files (by Daniel Vila). -`--version`: Shows the version of WIDOCO. +`--version`: Shows the current version of WIDOCO. `-webVowl`: Create a visualization based on WebVowl (http://vowl.visualdataweb.org/webvowl/index.html#) in the documentation.