From ff440967f15132e53f823a502897f17e1ceefa54 Mon Sep 17 00:00:00 2001 From: Achilles Dougalis <143995053+AchillesDougalis@users.noreply.github.com> Date: Wed, 21 Feb 2024 16:52:03 +0200 Subject: [PATCH] Feature/readme (#564) * Added README.md files for each module. --- implementation/README.md | 2 +- implementation/eCatalogue/README.md | 2 +- implementation/eCatalogue/conventions_report/README.md | 6 ++++++ implementation/eCatalogue/model2owl-config/README.md | 9 +++++++++ implementation/eCatalogue/owl_ontology/README.md | 7 +++++++ implementation/eCatalogue/shacl_shapes/README.md | 6 ++++++ implementation/eCatalogue/xmi_conceptual_model/README.md | 5 +++++ implementation/eContract/README.md | 2 +- implementation/eContract/conventions_report/README.md | 6 ++++++ implementation/eContract/model2owl-config/README.md | 5 +++++ implementation/eContract/owl_ontology/README.md | 8 ++++++++ implementation/eContract/shacl_shapes/README.md | 5 +++++ implementation/eContract/xmi_conceptual_model/README.md | 9 +++++++++ implementation/eFulfilment/README.md | 2 +- implementation/eFulfilment/conventions_report/README.md | 6 ++++++ implementation/eFulfilment/model2owl-config/README.md | 6 ++++++ implementation/eFulfilment/owl_ontology/README.md | 8 ++++++++ implementation/eFulfilment/shacl_shapes/README.md | 5 +++++ .../eFulfilment/xmi_conceptual_model/README.md | 5 +++++ implementation/eNotice/README.md | 2 +- implementation/eNotice/conventions_report/README.md | 5 +++++ implementation/eNotice/model2owl-config/README.md | 5 +++++ implementation/eNotice/owl_ontology/README.md | 5 +++++ implementation/eNotice/shacl_shapes/README.md | 6 ++++++ implementation/eNotice/xmi_conceptual_model/README.md | 5 +++++ implementation/eOrdering/README.md | 2 +- implementation/eOrdering/conventions_report/README.md | 5 +++++ implementation/eOrdering/model2owl-config/README.md | 6 ++++++ implementation/eOrdering/owl_ontology/README.md | 6 ++++++ implementation/eOrdering/shacl_shapes/README.md | 5 +++++ implementation/eOrdering/xmi_conceptual_model/README.md | 5 +++++ implementation/ePO_core/README.md | 2 +- implementation/ePO_core/conventions_report/README.md | 7 +++++++ implementation/ePO_core/model2owl-config/README.md | 5 +++++ implementation/ePO_core/owl_ontology/README.md | 8 ++++++++ implementation/ePO_core/shacl_shapes/README.md | 6 ++++++ implementation/ePO_core/xmi_conceptual_model/README.md | 7 +++++++ 37 files changed, 189 insertions(+), 7 deletions(-) create mode 100644 implementation/eCatalogue/conventions_report/README.md create mode 100644 implementation/eCatalogue/model2owl-config/README.md create mode 100644 implementation/eCatalogue/owl_ontology/README.md create mode 100644 implementation/eCatalogue/shacl_shapes/README.md create mode 100644 implementation/eCatalogue/xmi_conceptual_model/README.md create mode 100644 implementation/eContract/conventions_report/README.md create mode 100644 implementation/eContract/model2owl-config/README.md create mode 100644 implementation/eContract/owl_ontology/README.md create mode 100644 implementation/eContract/shacl_shapes/README.md create mode 100644 implementation/eContract/xmi_conceptual_model/README.md create mode 100644 implementation/eFulfilment/conventions_report/README.md create mode 100644 implementation/eFulfilment/model2owl-config/README.md create mode 100644 implementation/eFulfilment/owl_ontology/README.md create mode 100644 implementation/eFulfilment/shacl_shapes/README.md create mode 100644 implementation/eFulfilment/xmi_conceptual_model/README.md create mode 100644 implementation/eNotice/conventions_report/README.md create mode 100644 implementation/eNotice/model2owl-config/README.md create mode 100644 implementation/eNotice/owl_ontology/README.md create mode 100644 implementation/eNotice/shacl_shapes/README.md create mode 100644 implementation/eNotice/xmi_conceptual_model/README.md create mode 100644 implementation/eOrdering/conventions_report/README.md create mode 100644 implementation/eOrdering/model2owl-config/README.md create mode 100644 implementation/eOrdering/owl_ontology/README.md create mode 100644 implementation/eOrdering/shacl_shapes/README.md create mode 100644 implementation/eOrdering/xmi_conceptual_model/README.md create mode 100644 implementation/ePO_core/conventions_report/README.md create mode 100644 implementation/ePO_core/model2owl-config/README.md create mode 100644 implementation/ePO_core/owl_ontology/README.md create mode 100644 implementation/ePO_core/shacl_shapes/README.md create mode 100644 implementation/ePO_core/xmi_conceptual_model/README.md diff --git a/implementation/README.md b/implementation/README.md index 489bbe20..3c807c58 100644 --- a/implementation/README.md +++ b/implementation/README.md @@ -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. diff --git a/implementation/eCatalogue/README.md b/implementation/eCatalogue/README.md index db8e9c37..e7fe17ac 100644 --- a/implementation/eCatalogue/README.md +++ b/implementation/eCatalogue/README.md @@ -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. diff --git a/implementation/eCatalogue/conventions_report/README.md b/implementation/eCatalogue/conventions_report/README.md new file mode 100644 index 00000000..a297de01 --- /dev/null +++ b/implementation/eCatalogue/conventions_report/README.md @@ -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. + diff --git a/implementation/eCatalogue/model2owl-config/README.md b/implementation/eCatalogue/model2owl-config/README.md new file mode 100644 index 00000000..78f5de38 --- /dev/null +++ b/implementation/eCatalogue/model2owl-config/README.md @@ -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. + + + + diff --git a/implementation/eCatalogue/owl_ontology/README.md b/implementation/eCatalogue/owl_ontology/README.md new file mode 100644 index 00000000..1d077939 --- /dev/null +++ b/implementation/eCatalogue/owl_ontology/README.md @@ -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. + + diff --git a/implementation/eCatalogue/shacl_shapes/README.md b/implementation/eCatalogue/shacl_shapes/README.md new file mode 100644 index 00000000..408e4a1e --- /dev/null +++ b/implementation/eCatalogue/shacl_shapes/README.md @@ -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. + diff --git a/implementation/eCatalogue/xmi_conceptual_model/README.md b/implementation/eCatalogue/xmi_conceptual_model/README.md new file mode 100644 index 00000000..900fc629 --- /dev/null +++ b/implementation/eCatalogue/xmi_conceptual_model/README.md @@ -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. diff --git a/implementation/eContract/README.md b/implementation/eContract/README.md index be9c5aaa..a1ff472c 100644 --- a/implementation/eContract/README.md +++ b/implementation/eContract/README.md @@ -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. diff --git a/implementation/eContract/conventions_report/README.md b/implementation/eContract/conventions_report/README.md new file mode 100644 index 00000000..b7863103 --- /dev/null +++ b/implementation/eContract/conventions_report/README.md @@ -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. + diff --git a/implementation/eContract/model2owl-config/README.md b/implementation/eContract/model2owl-config/README.md new file mode 100644 index 00000000..53be24e4 --- /dev/null +++ b/implementation/eContract/model2owl-config/README.md @@ -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. diff --git a/implementation/eContract/owl_ontology/README.md b/implementation/eContract/owl_ontology/README.md new file mode 100644 index 00000000..5299f330 --- /dev/null +++ b/implementation/eContract/owl_ontology/README.md @@ -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. + + + diff --git a/implementation/eContract/shacl_shapes/README.md b/implementation/eContract/shacl_shapes/README.md new file mode 100644 index 00000000..386f0db9 --- /dev/null +++ b/implementation/eContract/shacl_shapes/README.md @@ -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. diff --git a/implementation/eContract/xmi_conceptual_model/README.md b/implementation/eContract/xmi_conceptual_model/README.md new file mode 100644 index 00000000..c559f7cb --- /dev/null +++ b/implementation/eContract/xmi_conceptual_model/README.md @@ -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. + + + + diff --git a/implementation/eFulfilment/README.md b/implementation/eFulfilment/README.md index a1f86f14..9b65c379 100644 --- a/implementation/eFulfilment/README.md +++ b/implementation/eFulfilment/README.md @@ -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. diff --git a/implementation/eFulfilment/conventions_report/README.md b/implementation/eFulfilment/conventions_report/README.md new file mode 100644 index 00000000..a7edfb44 --- /dev/null +++ b/implementation/eFulfilment/conventions_report/README.md @@ -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. + diff --git a/implementation/eFulfilment/model2owl-config/README.md b/implementation/eFulfilment/model2owl-config/README.md new file mode 100644 index 00000000..3467f2b2 --- /dev/null +++ b/implementation/eFulfilment/model2owl-config/README.md @@ -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. + diff --git a/implementation/eFulfilment/owl_ontology/README.md b/implementation/eFulfilment/owl_ontology/README.md new file mode 100644 index 00000000..901e2d37 --- /dev/null +++ b/implementation/eFulfilment/owl_ontology/README.md @@ -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. + + + diff --git a/implementation/eFulfilment/shacl_shapes/README.md b/implementation/eFulfilment/shacl_shapes/README.md new file mode 100644 index 00000000..4f2096aa --- /dev/null +++ b/implementation/eFulfilment/shacl_shapes/README.md @@ -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. diff --git a/implementation/eFulfilment/xmi_conceptual_model/README.md b/implementation/eFulfilment/xmi_conceptual_model/README.md new file mode 100644 index 00000000..a1bd9209 --- /dev/null +++ b/implementation/eFulfilment/xmi_conceptual_model/README.md @@ -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. diff --git a/implementation/eNotice/README.md b/implementation/eNotice/README.md index 72cdabe5..8ba503ef 100644 --- a/implementation/eNotice/README.md +++ b/implementation/eNotice/README.md @@ -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. diff --git a/implementation/eNotice/conventions_report/README.md b/implementation/eNotice/conventions_report/README.md new file mode 100644 index 00000000..4094f55f --- /dev/null +++ b/implementation/eNotice/conventions_report/README.md @@ -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. diff --git a/implementation/eNotice/model2owl-config/README.md b/implementation/eNotice/model2owl-config/README.md new file mode 100644 index 00000000..1c87afbc --- /dev/null +++ b/implementation/eNotice/model2owl-config/README.md @@ -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. diff --git a/implementation/eNotice/owl_ontology/README.md b/implementation/eNotice/owl_ontology/README.md new file mode 100644 index 00000000..f486cb47 --- /dev/null +++ b/implementation/eNotice/owl_ontology/README.md @@ -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. diff --git a/implementation/eNotice/shacl_shapes/README.md b/implementation/eNotice/shacl_shapes/README.md new file mode 100644 index 00000000..748526ce --- /dev/null +++ b/implementation/eNotice/shacl_shapes/README.md @@ -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. + diff --git a/implementation/eNotice/xmi_conceptual_model/README.md b/implementation/eNotice/xmi_conceptual_model/README.md new file mode 100644 index 00000000..4f51c372 --- /dev/null +++ b/implementation/eNotice/xmi_conceptual_model/README.md @@ -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. diff --git a/implementation/eOrdering/README.md b/implementation/eOrdering/README.md index 1b291e07..e2416cc0 100644 --- a/implementation/eOrdering/README.md +++ b/implementation/eOrdering/README.md @@ -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. diff --git a/implementation/eOrdering/conventions_report/README.md b/implementation/eOrdering/conventions_report/README.md new file mode 100644 index 00000000..0426c9c4 --- /dev/null +++ b/implementation/eOrdering/conventions_report/README.md @@ -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. diff --git a/implementation/eOrdering/model2owl-config/README.md b/implementation/eOrdering/model2owl-config/README.md new file mode 100644 index 00000000..f0c97a2b --- /dev/null +++ b/implementation/eOrdering/model2owl-config/README.md @@ -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. + diff --git a/implementation/eOrdering/owl_ontology/README.md b/implementation/eOrdering/owl_ontology/README.md new file mode 100644 index 00000000..cc8a5a49 --- /dev/null +++ b/implementation/eOrdering/owl_ontology/README.md @@ -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. + diff --git a/implementation/eOrdering/shacl_shapes/README.md b/implementation/eOrdering/shacl_shapes/README.md new file mode 100644 index 00000000..77d84321 --- /dev/null +++ b/implementation/eOrdering/shacl_shapes/README.md @@ -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. diff --git a/implementation/eOrdering/xmi_conceptual_model/README.md b/implementation/eOrdering/xmi_conceptual_model/README.md new file mode 100644 index 00000000..956ac1e3 --- /dev/null +++ b/implementation/eOrdering/xmi_conceptual_model/README.md @@ -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. diff --git a/implementation/ePO_core/README.md b/implementation/ePO_core/README.md index 57a9788a..dc10c6a0 100644 --- a/implementation/ePO_core/README.md +++ b/implementation/ePO_core/README.md @@ -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. diff --git a/implementation/ePO_core/conventions_report/README.md b/implementation/ePO_core/conventions_report/README.md new file mode 100644 index 00000000..bc879b8e --- /dev/null +++ b/implementation/ePO_core/conventions_report/README.md @@ -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. + + diff --git a/implementation/ePO_core/model2owl-config/README.md b/implementation/ePO_core/model2owl-config/README.md new file mode 100644 index 00000000..6151f791 --- /dev/null +++ b/implementation/ePO_core/model2owl-config/README.md @@ -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. diff --git a/implementation/ePO_core/owl_ontology/README.md b/implementation/ePO_core/owl_ontology/README.md new file mode 100644 index 00000000..d48a5b0e --- /dev/null +++ b/implementation/ePO_core/owl_ontology/README.md @@ -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. + + diff --git a/implementation/ePO_core/shacl_shapes/README.md b/implementation/ePO_core/shacl_shapes/README.md new file mode 100644 index 00000000..2de87b7a --- /dev/null +++ b/implementation/ePO_core/shacl_shapes/README.md @@ -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. + diff --git a/implementation/ePO_core/xmi_conceptual_model/README.md b/implementation/ePO_core/xmi_conceptual_model/README.md new file mode 100644 index 00000000..a15339e4 --- /dev/null +++ b/implementation/ePO_core/xmi_conceptual_model/README.md @@ -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. + +