OP-TED · Dragos0000 · Jun 25, 2023 · Jun 25, 2023 · Jun 25, 2023 · Jun 25, 2023
diff --git a/.gitignore b/.gitignore
@@ -322,4 +322,5 @@ output
 target
 bin/
 lib64
-pyvenv.cfg
+pyvenv.cfg
+/build/
diff --git a/README.md b/README.md
@@ -1,75 +1,56 @@
 # model2owl
 
-This project comprises a set of tools for transforming an UML (v2.5) model from its XMI (v2.5.1) serialisation into a formal ontology. This transformation is performed using XSLT stylesheets under the assumption that the UML model conforms to the set of conventions outlined in the documentation.    
+_Transform a UML model into a formal OWL ontology, and a SHACL shape based on established UML conventions._ 
 
-* UML -> OWL 2 (light / complete)
-* UML -> SHACL
+[![Build](https://github.com/OP-TED/model2owl/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/OP-TED/model2owl/actions/workflows/main.yml)
+
+![GitHub last commit](https://img.shields.io/github/last-commit/OP-TED/model2owl)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/OP-TED/model2owl)
+
+![GitHub issues](https://img.shields.io/github/issues/OP-TED/model2owl)
+![GitHub contributors](https://img.shields.io/github/contributors-anon/OP-TED/model2owl)
+![GitHub Repo stars](https://img.shields.io/github/stars/OP-TED/model2owl?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/OP-TED/model2owl?style=social)
+
+![GitHub](https://img.shields.io/github/license/OP-TED/model2owl)
+
+
+## About 
+
+This project comprises a set of tools for transforming an UML (v2.5) model from its XMI (v2.5.1) serialisation into a formal OWL ontology, and a SHACL shape. This approach is conformant to the [SEMIC Style Guide](https://OP-TED.github.io/style-guide/1.0.0/index.html) and with [eProcurement Ontology Architecture specification](https://github.com/meaningfy-ws/model2owl/blob/master/doc/ontology-architecture/ontology-architecture.pdf). 
+
+The UML transformation is performed using XSLT stylesheets under the assumption that the UML model conforms to the set of conventions outlined in the [EPO UML conventions documentation](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html). This set of UML conventions is an extension to the UML conventions specified in [SEMIC Style Guide](https://OP-TED.github.io/style-guide/1.0.0/index.html). 
+
+The following capabilities are addressed:
+
+* UML -> Compliance report (ideal for checking the model against the established conventions) 
+* UML -> OWL 2 (lightweight ontology suitable as a Core Cocabulary)
+* UML -> OWL 2 (heavyweight ontology with additional axioms suitable for reasoning purposes)
+* UML -> SHACL (data shapes suitable for validation)
 
 This work is developed in the context of [eProcurement ontology project](https://github.com/eprocurementontology/eprocurementontology) financed by the Digital Europe Programme and led by the [Publications Office of the European Union](https://op.europa.eu/en/).
 
 ### Documents
-* The **architectural design** and the formal specifications are provided in the [Ontology architecture document](doc/ontology-architecture/ontology-architecture.pdf).  
-* The technical **conventions** for the UML representation of the conceptual model are provided in [UML conventions document](doc/uml-conventions/uml-conventions.pdf)
-* An **inventory** of conformance tests derived from the UML conventions document are provided in the [Inventory Worksheet document](doc/checkers-inventory/eProcurement conceptual model checkers inventory.xlsx)
-* The **transformation rules** from UML into OWL and SHACL are provided in the [uml2owl transformation document](doc/uml2owl-transformation/uml2owl-transformation.pdf)
+* The **architectural design** and the formal specifications are provided in the [eProcurement Ontology Architecture specification](https://github.com/meaningfy-ws/model2owl/blob/master/doc/ontology-architecture/ontology-architecture.pdf).  
+* The technical **conventions** for the UML representation of the conceptual model are provided in [EPO UML conventions documentation](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html).
+* An **inventory** of conformance tests derived from the UML conventions document are provided in the [EPO UML conventions checking specification](https://meaningfy-ws.github.io/model2owl-docs/public-review/checkers/model2owl-checkers.html).
+* The **transformation rules** from UML into OWL and SHACL are provided in the [UML2OWL transformation rules](https://meaningfy-ws.github.io/model2owl-docs/public-review/transformation/uml2owl-transformation.html).
 
 ### Scripts
 * [html-conventions-report.xsl](src/html-conventions-report.xsl) is the script checking the conformance to the technical conventions of the conceptual model.   
 * [owl-core.xsl](src/owl-core.xsl) is the transformation script for the core OWL ontology.
-* [shacl-shapes.xsl](src/shacl-shapes.xsl) is the transformation script for the SHACL data shape constraints
+* [shacl-shapes.xsl](src/shacl-shapes.xsl) is the transformation script for the SHACL data shape constraints.
 * [owl-restrictions.xsl](src/owl-restrictions.xsl) is the transformation script for the restrictions of OWL ontology (on classes and properties).
 
 ### Script unit tests
 
 * [test/unitTest/test-html-conventions-lib](
 https://github.com/meaningfy-ws/model2owl/tree/master/test/unitTests/test-html-conventions-lib) is the location of the unit tests for the script checking the conformance to the technical conventions of the conceptual model are
 * [test/unitTest/test-owl-core-lib](https://github.com/meaningfy-ws/model2owl/tree/master/test/unitTests/test-owl-core-lib) is the location of the unit tests for the transformation script for the core OWL ontology.
-
 * [test/unitTest/test-shacl-shape-lib](https://github.com/meaningfy-ws/model2owl/tree/master/test/unitTests/test-shacl-shape-lib) is the location of the unit tests for the transformation script for the SHACL data shape constraints.
 * [test/unitTest/reasoning-layer-lib](https://github.com/meaningfy-ws/model2owl/tree/master/test/unitTests/reasoning-layer-lib) is the location of the unit tests for the transformation script for the restrictions of OWL ontology (on classes and properties).
 
-## Running the transformation
-
-The scripts developed in this project conform to XSLT 3.0 and can be executed with a corresponding XSLT engine of choice. A recommendation is to use [Saxon-HE](http://saxon.sourceforge.net/), but it is not the only one.
-
-The input eProcurement conceptual model is available in the [eProcurement Ontology project on GitHub](https://github.com/eprocurementontology/eprocurementontology). Note that the XMI (v.2.5.1) output is generated with [Enterprise Architect](https://sparxsystems.com/products/ea/index.html) and was not tested with outputs from other software (although, XMI is an OMG standard). But, this does not restrict the current scripts to this project alone and any UML model that conforms to the specified UML conventions can be transformed into a formal ontology.    
 
-We assume that the users of this project are familiar with XML, UML and XSLT technologies and know how to perform an XSLT transformation. 
-
-## Automation with Makefile
-
-## Create an virtual environment
-pip install virtualenv
-virtualenv venv
-## Activate your venv
-source venv/bin/activate
-
-## Install rdflib inside your virtual environment
-pip install rdflib
-
-## Combine multiple XMI / XML UML documents
-make merge-xmi
-
-This will merge multiple input XMI / XML UML documents into a single one. The output is located under ../output/combined-xmi/ and will be used to generate a single glossary.
-
-## Generate the glossary from the merged document
-make generate-glossary
-The glossary will generated and located in the ../output/glossary/
-
-## Repository Structure
-
-* /src - source code of the XSLT scripts generating the HTML conventions report. 
-  * /common , /html-conventions-lib, /reasoning-layer-lib and /shacl-shape-lib contain modules loaded by the main files.
-  * /static contains JS and CSS styles refereed by HTML reports. It should be copied to wherever the report is saved in order to ensure proper display.
-  * config-parameters.xsl - the configurations file that may be adjusted as necessary.  
-  * html-conventions-report.xsl - source code of the XSLT scripts generating the HTML conventions report.
-  * owl-core.xsl - Transformation script for the core ontology
-  * shacl-shapes.xsl -  Transformation script for the SHACL shapes    
-  * owl-restrictions.xsl - Transformation script for the ontology intensional definitions based on the class and property restrictions
-
-* /test - contains unit tests for each XSL module ensuring the correct implementation.
-  * /test/unitTests - contain XSpec unit tests
-  * /test/testData - test data used in the unit tests
 
 # Contributing
 You are more than welcome to help expand and mature this project. 
@@ -82,9 +63,6 @@ Please note we adhere to [Apache code of conduct](https://www.apache.org/foundat
 
 The documents, such as reports and specifications, available in the /doc folder, are licenced under a [CC BY 4.0 licence](https://creativecommons.org/licenses/by/4.0/deed.en).
 
-The XSLT (stylesheets) and other scripts are licenced under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) licence. 
-
-
-
+The XSLT (stylesheets) and other scripts are licenced under [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) licence.
 
 
diff --git a/doc/readme.md b/doc/readme.md
@@ -0,0 +1,57 @@
+# Documentation migration
+
+The documentation in this folder is slowly migrated into [model2owl-docs](https://github.com/meaningfy-ws/model2owl-docs) repository.
+
+## Running the transformation (old instructions)
+**[The user manual is currently under revision; please be patient]**
+
+The scripts developed in this project conform to XSLT 3.0 and can be executed with a corresponding XSLT engine of choice. A recommendation is to use [Saxon-HE](http://saxon.sourceforge.net/), but it is not the only one.
+
+The input eProcurement conceptual model is available in the [eProcurement Ontology project on GitHub](https://github.com/eprocurementontology/eprocurementontology). Note that the XMI (v.2.5.1) output is generated with [Enterprise Architect](https://sparxsystems.com/products/ea/index.html) and was not tested with outputs from other software (although, XMI is an OMG standard). But, this does not restrict the current scripts to this project alone and any UML model that conforms to the specified UML conventions can be transformed into a formal ontology.    
+
+We assume that the users of this project are familiar with XML, UML and XSLT technologies and know how to perform an XSLT transformation. 
+
+### Create an virtual environment
+```
+pip install virtualenv
+virtualenv venv
+```
+
+### Activate your venv
+```
+source venv/bin/activate
+```
+
+### Install rdflib inside your virtual environment
+```
+pip install rdflib
+```
+
+### Combine multiple XMI / XML UML documents
+
+```
+make merge-xmi
+```
+This will merge multiple input XMI / XML UML documents into a single one. The output is located under `../output/combined-xmi/` and will be used to generate a single glossary.
+
+### Generate the glossary from the merged document
+```  
+make generate-glossary
+```
+
+The glossary will generated and located in the ../output/glossary/
+
+## Repository Structure
+
+* /src - source code of the XSLT scripts generating the HTML conventions report. 
+* /common , /html-conventions-lib, /reasoning-layer-lib and /shacl-shape-lib contain modules loaded by the main files.
+* /static contains JS and CSS styles refereed by HTML reports. It should be copied to wherever the report is saved in order to ensure proper display.
+* config-parameters.xsl - the configurations file that may be adjusted as necessary.  
+* html-conventions-report.xsl - source code of the XSLT scripts generating the HTML conventions report.
+* owl-core.xsl - Transformation script for the core ontology
+* shacl-shapes.xsl -  Transformation script for the SHACL shapes    
+* owl-restrictions.xsl - Transformation script for the ontology intensional definitions based on the class and property restrictions
+
+* /test - contains unit tests for each XSL module ensuring the correct implementation.
+* /test/unitTests - contain XSpec unit tests
+* /test/testData - test data used in the unit tests
-Original file line number
+Diff line change
@@ Expand Up / @@ -322,4 +322,5 @@ output @@
     target
     bin/
     lib64
-    pyvenv.cfg
+    pyvenv.cfg
+    /build/