From 047e759949d97710dd2f11b254b5a75aaab90baf Mon Sep 17 00:00:00 2001 From: mereolog Date: Mon, 12 Feb 2024 10:47:31 +0100 Subject: [PATCH 1/5] update of readme file with information about onto-viewer requirements Signed-off-by: mereolog --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f7d3d3ba..8332630e 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,22 @@ -# Onto Viewer +# onto-viewer -Onto Viewer is an open-source project that is hosted by EDM Council. The project started in May 2019. Onto Viewer is a Java application that is specifically designed to access both the ontology structure and its content in the easiest possible way. Onto Viewer servers REST API. +onto-viewer is an open-source Java application that provides a number of REST API endpoints to access the content of OWL ontologies. If run together with [html-pages frontend](https://github.com/edmcouncil/html-pages), it will visualise them as a web application. -## Onto website -Onto viewer is used in the ontology view in html-pages. -* https://github.com/edmcouncil/html-pages +## How to customise your ontology to be properly displayed by onto-viewer +1. We require that all ontologies' IRIs end with '/' (e.g., https://www.omg.org/spec/Commons/Classifiers/) as per the recommendation from https://www.w3.org/TR/cooluris/. +1. We require that all ontologies are "registered" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file. +1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file. -# How to run Onto Viewer + +# How to run onto-viewer ## Running locally -To run the Onto Viewer locally: +To run the onto-viewer locally: * Download the file named "onto-viewer.zip" from the [latest release](https://github.com/edmcouncil/onto-viewer/releases). * Unzip the file. From 3e4a5ed180db14818bc1dfb3d56b75a0cd77fb71 Mon Sep 17 00:00:00 2001 From: mereolog Date: Mon, 12 Feb 2024 10:51:34 +0100 Subject: [PATCH 2/5] update of readme file with information about onto-viewer requirements Signed-off-by: mereolog --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8332630e..1855b392 100644 --- a/README.md +++ b/README.md @@ -5,15 +5,15 @@ onto-viewer is an open-source Java application that provides a number of REST API endpoints to access the content of OWL ontologies. If run together with [html-pages frontend](https://github.com/edmcouncil/html-pages), it will visualise them as a web application. + +# How to run onto-viewer + ## How to customise your ontology to be properly displayed by onto-viewer 1. We require that all ontologies' IRIs end with '/' (e.g., https://www.omg.org/spec/Commons/Classifiers/) as per the recommendation from https://www.w3.org/TR/cooluris/. 1. We require that all ontologies are "registered" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file. 1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file. - -# How to run onto-viewer - ## Running locally To run the onto-viewer locally: From e775276a42cf295ce6db3f12b0e7425075fa9a5c Mon Sep 17 00:00:00 2001 From: mereolog Date: Mon, 12 Feb 2024 10:53:07 +0100 Subject: [PATCH 3/5] update of readme file with information about onto-viewer requirements Signed-off-by: mereolog --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1855b392..1443e035 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ onto-viewer is an open-source Java application that provides a number of REST AP 1. We require that all ontologies are "registered" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file. 1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file. -## Running locally +## How to run it locally To run the onto-viewer locally: @@ -32,7 +32,7 @@ java -jar app-v-0.1.0.war ``` -## Run with docker +## How to run it using docker Requirements: - [git](https://git-scm.com/) ([install](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)) - [docker](https://www.docker.com/) - install: From ab762b258ea162a08e41610a06d3bc1684e23696 Mon Sep 17 00:00:00 2001 From: mereolog Date: Mon, 12 Feb 2024 10:58:17 +0100 Subject: [PATCH 4/5] update of readme file with information about onto-viewer requirements Signed-off-by: mereolog --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1443e035..d9283aff 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,16 @@ onto-viewer is an open-source Java application that provides a number of REST API endpoints to access the content of OWL ontologies. If run together with [html-pages frontend](https://github.com/edmcouncil/html-pages), it will visualise them as a web application. +# Table of contents + +* [How to run onto-viewer](#how-to-run-onto-viewer) + * [How to customise your ontology to be properly displayed by onto-viewer](#how-to-customise-ontologies) + * [How to run it locally](#how-to-run-locally) + * [How to run it using docker](#how-to-run-docker) +* [Contributing](#contributing) + * [Development](#development) +* [License](#license) + # How to run onto-viewer @@ -132,7 +142,7 @@ docker compose down --rmi all -v Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details on our code of conduct, and the process for submitting pull requests to us. -# Development +## Development To run integration tests, use the following command: From b3184d2a07602d8590da2bf8ed43790a5d7ae588 Mon Sep 17 00:00:00 2001 From: Pawel Garbacz Date: Thu, 15 Feb 2024 14:51:52 +0100 Subject: [PATCH 5/5] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Przemysław Grądzki --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d9283aff..68e7ae8a 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ onto-viewer is an open-source Java application that provides a number of REST AP ## How to customise your ontology to be properly displayed by onto-viewer -1. We require that all ontologies' IRIs end with '/' (e.g., https://www.omg.org/spec/Commons/Classifiers/) as per the recommendation from https://www.w3.org/TR/cooluris/. +1. We require each _ontology IRI_ to follow the convention described in [Vocabularies that use a 'slash namespace'](https://www.w3.org/TR/swbp-vocab-pub/#slash), i.e. end with a forward slash character `/` (e.g., `https://www.omg.org/spec/Commons/Classifiers/`). 1. We require that all ontologies are "registered" in the meta file(s), which store the relevant metadata, in particular allow for custom modularisation - see https://github.com/edmcouncil/idmp/blob/master/ISO/MetadataISO.rdf for an example of such file. 1. We recommend that all imported ontologies and locally cached and their local references are listed in catalog-v001.xml file.