Skip to content

Commit

Permalink
Feature/readme (#564)
Browse files Browse the repository at this point in the history
* Added README.md files for each module.
  • Loading branch information
AchillesDougalis authored Feb 21, 2024
1 parent 4df0a1c commit ff44096
Show file tree
Hide file tree
Showing 37 changed files with 189 additions and 7 deletions.
2 changes: 1 addition & 1 deletion implementation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Each module folder is structured as follows:
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the .xml file of the specified module to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the ontology files of the specified module, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the ontology files of the specified module, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of the specified module in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
2 changes: 1 addition & 1 deletion implementation/eCatalogue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ It covers the needs for post-award and some of the needs for pre-award.
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eCatalogue.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the eCatalogue ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the eCatalogue ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eCatalogue in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
6 changes: 6 additions & 0 deletions implementation/eCatalogue/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the eCatalogue module (as an HTML page). An automatically generated report that lists the ontology concepts in the eCatalogue.xml file that violate the ePO UML conventions.

9 changes: 9 additions & 0 deletions implementation/eCatalogue/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eCatalogue.xml file to a formal OWL ontology including SHACL shapes.




7 changes: 7 additions & 0 deletions implementation/eCatalogue/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# owl ontology

**Description**:

The *owl_ontology* folder contains the eCatalogue ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


6 changes: 6 additions & 0 deletions implementation/eCatalogue/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# shacl shapes

**Description**:

The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eCatalogue in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.

5 changes: 5 additions & 0 deletions implementation/eCatalogue/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the eCatalogue.xml file. A representation of the UML model of the Ontology.
2 changes: 1 addition & 1 deletion implementation/eContract/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The eContract module contains classes related to the concept of a Contract.
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eContract.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the eContract ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the eContract ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eContract in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
6 changes: 6 additions & 0 deletions implementation/eContract/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the eContract module (as an HTML page). An automatically generated report that lists the ontology concepts in the eContract.xml file that violate the ePO UML conventions.

5 changes: 5 additions & 0 deletions implementation/eContract/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eContract.xml file to a formal OWL ontology including SHACL shapes.
8 changes: 8 additions & 0 deletions implementation/eContract/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# owl ontology

**Description**:

The *owl_ontology* folder contains the eContract ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.



5 changes: 5 additions & 0 deletions implementation/eContract/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# shacl shapes

**Description**:

The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eContract in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
9 changes: 9 additions & 0 deletions implementation/eContract/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the eContract.xml file. A representation of the UML model of the Ontology.




2 changes: 1 addition & 1 deletion implementation/eFulfilment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ shipping of orders.
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eFulfilment.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the eFulfilment ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the eFulfilment ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eFulfilment in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
6 changes: 6 additions & 0 deletions implementation/eFulfilment/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the eFulfilment module (as an HTML page). An automatically generated report that lists the ontology concepts in the eFulfilment.xml file that violate the ePO UML conventions.

6 changes: 6 additions & 0 deletions implementation/eFulfilment/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eFulfilment.xml file to a formal OWL ontology including SHACL shapes.

8 changes: 8 additions & 0 deletions implementation/eFulfilment/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# owl ontology

**Description**:

The *owl_ontology* folder contains the eFulfilment ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.



5 changes: 5 additions & 0 deletions implementation/eFulfilment/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# shacl shapes

**Description**:

The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eFulfilment in RDF and Turtle format. SHACL (Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
5 changes: 5 additions & 0 deletions implementation/eFulfilment/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the eFulfilment.xml file. A representation of the UML model of the Ontology.
2 changes: 1 addition & 1 deletion implementation/eNotice/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The eNotice module contains classes related to eNotices. It is structured in thr
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eNotice.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the eNotice ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the eNotice ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eNotice in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
5 changes: 5 additions & 0 deletions implementation/eNotice/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the eNotice module (as an HTML page). An automatically generated report that lists the ontology concepts in the eNotice.xml file that violate the ePO UML conventions.
5 changes: 5 additions & 0 deletions implementation/eNotice/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eNotice.xml file to a formal OWL ontology including SHACL shapes.
5 changes: 5 additions & 0 deletions implementation/eNotice/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# owl ontology

**Description**:

The *owl_ontology* folder contains the eNotice ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.
6 changes: 6 additions & 0 deletions implementation/eNotice/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# shacl shapes

**Description**:

The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eNotice in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.

5 changes: 5 additions & 0 deletions implementation/eNotice/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the eNotice.xml file. A representation of the UML model of the Ontology.
2 changes: 1 addition & 1 deletion implementation/eOrdering/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The eOrdering module contains classes specific to the Ordering phase of procurem
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eOrdering.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the eOrdering ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the eOrdering ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eOrdering in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
5 changes: 5 additions & 0 deletions implementation/eOrdering/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the eOrdering module (as an HTML page). An automatically generated report that lists the ontology concepts in the eOrdering.xml file that violate the ePO UML conventions.
6 changes: 6 additions & 0 deletions implementation/eOrdering/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the eOrdering.xml file to a formal OWL ontology including SHACL shapes.

6 changes: 6 additions & 0 deletions implementation/eOrdering/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# owl ontology

**Description**:

The *owl_ontology* folder contains the eOrdering ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.

5 changes: 5 additions & 0 deletions implementation/eOrdering/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# shacl shapes

**Description**:

Τhe *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of eOrdering in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
5 changes: 5 additions & 0 deletions implementation/eOrdering/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the eOrdering.xml file. A representation of the UML model of the Ontology.
2 changes: 1 addition & 1 deletion implementation/ePO_core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ePO core is the main module of ePO ontology containing the fundamental parts of
- The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the ePO_core.xml file to a formal OWL ontology including SHACL shapes.


- The *owl_ontology* folder contains the ePO_core ontology files, as well as the restriction files. The files are available in both [RDF](https://www.w3.org/RDF/) and [Turtle](https://www.w3.org/TR/turtle/) formats.
- The *owl_ontology* folder contains the ePO_core ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


- The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of ePO core in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.
Expand Down
7 changes: 7 additions & 0 deletions implementation/ePO_core/conventions_report/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# conventions report

**Description**:

The *conventions_report* folder contains the [UML Conventions](https://meaningfy-ws.github.io/model2owl-docs/public-review/uml/conceptual-model-conventions.html) comformance report of the ePO_core module (as an HTML page). An automatically generated report that lists the ontology concepts in the ePO_core.xml file that violate the ePO UML conventions.


5 changes: 5 additions & 0 deletions implementation/ePO_core/model2owl-config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# model2owl config

**Description**:

The *model2owl-config* folder contains the configuration files necessary for the [model2owl toolchain](https://github.com/OP-TED/model2owl) to transform the ePO_core.xml file to a formal OWL ontology including SHACL shapes.
8 changes: 8 additions & 0 deletions implementation/ePO_core/owl_ontology/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# owl ontology

**Description**:


The *owl_ontology* folder contains the ePO_core ontology files, as well as the restriction files. The files are available in [XML/RDF](https://www.w3.org/TR/rdf-syntax-grammar/) and [Turtle/RDF](https://www.w3.org/TR/turtle/) formats.


6 changes: 6 additions & 0 deletions implementation/ePO_core/shacl_shapes/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# shacl shapes

**Description**:

The *shacl_shapes* folder contains the [SHACL](https://www.w3.org/TR/shacl/) shapes of ePO core in RDF and Turtle format. SHACL ( Shapes Constraint Language) is a W3C standard used for validating the contents of an RDF graph.

7 changes: 7 additions & 0 deletions implementation/ePO_core/xmi_conceptual_model/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# xmi conceptual model

**Description**:

The *[xmi](https://www.omg.org/spec/XMI/)_conceptual_model* folder contains the ePO_core.xml file. A representation of the UML model of the Ontology.


0 comments on commit ff44096

Please sign in to comment.