Merge pull request #578 from International-Data-Spaces-Association/refactoring

Refactoring

Author: JohannesLipp

.github/PULL_REQUEST_TEMPLATES/PULL_REQUEST_TEMPLATE.md

@@ -17,8 +17,8 @@
 - [ ] Rerun ontology creation script (`create-ontology-ttl.sh`) with the version number of the release. E.g., `create-ontology-ttl.sh 4.2.0`
 - [ ] Update and validate the examples against the latest ontology version and SHACL shapes
 - [ ] Make sure that the manually authored parts of the documentation are in sync with the rest of the implementation and documentation
-- [ ] Check whether the [IDS-G-pre](https://github.com/International-Data-Spaces-Association/IDS-G-pre/tree/main/Infomodel) documentation is up to date
-- [ ] Check whether the [IDS Information Model Readme.md](https://github.com/International-Data-Spaces-Association/InformationModel/#readme) is up to date
+- [ ] Check whether the [IDS-G-pre](https://github.com/International-Data-Spaces-Association/IDS-G-pre/tree/main/Infomodel) documentation is up-to-date
+- [ ] Check whether the [IDS Information Model Readme.md](https://github.com/International-Data-Spaces-Association/InformationModel/#readme) is up-to-date
 
 ### After a release:
 - [ ] Generate human-readable documentation and single-file serializations using Widoco

CHANGELOG.md

@@ -45,7 +45,7 @@ Version 4.1.0 of the IDS Information Model
 
 
 ### Removed
-* `idsm:` metamodel annotations, which were used to annotate cardinalities of properties. The property cardinalities and restrictions are now exclusively represented via the corresponding SHACL shapes found in the [testing subdirectory](testing/)
+* `idsm:` metamodel annotations, which were used to annotate cardinalities of properties. The property cardinalities and restrictions are now exclusively represented via the corresponding SHACL shapes found in the [testing subdirectory](testing)
 
 
 ## [4.0.0] 2020-08-04
@@ -159,7 +159,7 @@ Version 3.0.0 of the IDS Information Model
 
 * Redesign of the DynamicAttributeToken (DAT) based on the new Dynamic Attribute Provisioning Service (DAPS) version. Check the corresponding [Token](model/security/Token.ttl) class as well as the [DAT payload example](examples/DAT_PAYLOAD.jsonld) for more information.
 
-* `ids:RequestMessage`, `ids:ResponseMessage`, `ids:NotificationMessage` not _abstract_ any more. These messages can now be used directly for non-core IDS communication.
+* `ids:RequestMessage`, `ids:ResponseMessage`, `ids:NotificationMessage` not _abstract_ anymore. These messages can now be used directly for non-core IDS communication.
 
 * `ids:DescriptionRequestMessage`(previously called `ids:SelfDescriptionRequest`) now accepts an optional URI. This can be used to either retrieve a component's self-description (by providing its own URI or nothing) or to retrieve metadata about a specific element by providing the element's URI.
 
@@ -197,7 +197,7 @@ Version 2.0.1 of the IDS Information Model
 * Removed property *ids:baseContractOffer* from class *ids:ContractRequestMessage* due to redundancy. By definition *ids:ContractRequestMessage* already requires a contract in its payload. The property is therefore not needed.
 
 ### Fixed
-* Changed *ids:referingConnector* (class *ids:Token*) from *owl:ObjectProperty* to *owl:DatatypeProperty* with *rdfs:range* *xsd:anyURI*. Allows to reference the connector via an URI.
+* Changed *ids:referingConnector* (class *ids:Token*) from *owl:ObjectProperty* to *owl:DatatypeProperty* with *rdfs:range* *xsd:anyURI*. Allows to reference the connector via a URI.
 
 * Removed *idsm:abstract true* property from *ids:variant* (class *ids:Resource*). Property is invalid, since it is intended to be used by classes only.
 
@@ -233,4 +233,4 @@ Version 2.0 of the IDS Information Model
 
 ### Removed
 
-- Removing plural forms for properties: A catalog can have can have several “ids:offer” triples but must not have any with “ids:offer*s*”
+- Removing plural forms for properties: A catalog can have several “ids:offer” triples but must not have any with “ids:offer*s*”

CONTRIBUTING.md

@@ -11,7 +11,7 @@ maintained according to the rules documented on http://keepachangelog.com.
 
 - strip whitespace at the end of lines
 - do not use tabs (use 4 spaces instead)
-- end each file with a newline (its easier to concat them then)
+- end each file with a newline (it is easier to concat them then)
 
 ## Commits
 
@@ -26,7 +26,7 @@ Good commits serve at least these important purposes:
 
 ### Meta Data
 
-Please create commits with valid meta data only. This means, you have to configure your name and mail address like this:
+Please create commits with valid metadata only. This means, you have to configure your name and mail address like this:
 
 ```
 git config --global user.name "$name"
@@ -92,8 +92,8 @@ For example:
 
 Notice how this doesn't work for the other non-imperative forms:
 
-- If applied, this commit will fixed bug with Y
-- If applied, this commit will changing behavior of X
+- If applied, this commit will fix bug with Y
+- If applied, this commit will change behavior of X
 - If applied, this commit will more fixes for broken stuff
 - If applied, this commit will sweet new class
 
@@ -110,7 +110,7 @@ The branching model defines the basic workflow for different activities in the r
 - prepare and release a version
 
 Our used branching model is an enhanced version of the model by [Vincent Driessen](http://nvie.com/posts/a-successful-git-branching-model/).
-The important variation is the back-merge from the the tagged master onto the develop branch.
+The important variation is the back-merge from the tagged master onto the develop branch.
 This enables the power of the `git describe --always --dirty` command, which outputs an ID for the whole process.
 
 #### Requirements
@@ -124,7 +124,7 @@ This enables the power of the `git describe --always --dirty` command, which out
 - Every new feature will be developed in its own feature branch off from develop
 - Each feature will follow this naming: feature/featureName (where feature name is some descriptive feature name, 2 words most, camel case)
 - Regularly push your work to the same named feature branch on the server
-- If you need newest changes from develop merge it into your feature branch using git merge --no-ff
+- If you need the newest changes from develop merge it into your feature branch using git merge --no-ff
 - Avoid cross-merging of other feature branches
 - CONVENTION: merge your feature branch into develop by opening a pull request
     - Always merge your feature branch into develop using git merge --no-ff

README.md

@@ -27,7 +27,7 @@ with significant contributions, comments and support by (in alphabetical order):
 - Andreas W. Müller, [Schaeffler](https://www.schaeffler.de/content.schaeffler.de/en/)
 - Dr. Michael Theß, [Signal Cruncher GmbH](https://signal-cruncher.com/)
 
-Likewise the authors would like to thank numerous colleagues at Fraunhofer, active participants of the [International Data Spaces Association](https://www.internationaldataspaces.org/en/), the members of the W3C [Dataset Exchange Group](https://www.w3.org/2017/dxwg/wiki/Main_Page) and [Data Market Austria](https://datamarket.at/en/) for illuminating conversations and support in shaping the Information Model.
+Likewise, the authors would like to thank numerous colleagues at Fraunhofer, active participants of the [International Data Spaces Association](https://www.internationaldataspaces.org/en/), the members of the W3C [Dataset Exchange Group](https://www.w3.org/2017/dxwg/wiki/Main_Page) and [Data Market Austria](https://datamarket.at/en/) for illuminating conversations and support in shaping the Information Model.
 
 ## Directory layout
 

Shacl.ttl

@@ -18,7 +18,7 @@
 
 shapes:
     a voaf:Vocabulary, owl:Ontology ;
-    rdfs:isDefinedBy <https://w3id.org/idsa/core/> ;
+    rdfs:isDefinedBy ids: ;
     rdfs:label "IDS Information Model"@en ;
     dct:title "The International Data Spaces Information Model"@en ;
     rdfs:comment "This ontology defines classes and properties for describing participants, infrastructure, data and services of the International Data Spaces (formerly known as Industrial Data Space)." ;

codes/Action.ttl

@@ -15,7 +15,7 @@ idsc:ANONYMIZE
     a odrl:Action ;
     rdfs:comment "To anonymize all, parts or certain attributes of the resource."@en ;
     rdfs:label "anonymize"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/anonymize> ;
+    skos:broader odrl:anonymize ;
     odrl:includedIn idsc:USE ;
     skos:note "This action is always evaluated at the provider side."@en ;
 .
@@ -24,7 +24,7 @@ idsc:AGGREGATE_BY_CONSUMER
     a odrl:Action ;
     rdfs:comment "Data will be part of another piece of data so that it is not distinguishable anymore."@en ;
     rdfs:label "aggregate by consumer"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/aggregate> ;
+    skos:broader odrl:aggregate ;
     odrl:includedIn idsc:USE ;
     skos:note "This action is always evaluated at the consumer side."@en ;
 .
@@ -33,7 +33,7 @@ idsc:AGGREGATE_BY_PROVIDER
     a odrl:Action ;
     rdfs:comment "Data will be part of another piece of data so that it is not distinguishable anymore."@en ;
     rdfs:label "aggregate by provider"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/aggregate> ;
+    skos:broader odrl:aggregate ;
     odrl:includedIn idsc:AGGREGATE_BY_CONSUMER ;
     skos:note "This action is always evaluated at the provider side."@en ;
 .
@@ -49,7 +49,7 @@ idsc:COMPENSATE
     a odrl:Action;
     rdfs:label "compensate"@en ;
     rdfs:comment "To pay a certain amount of money in order to use a resource."@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/compensate> ;
+    skos:broader odrl:compensate ;
     odrl:includedIn idsc:USE ;
     skos:note "This action must be evaluated both at the consumer and provider side. A compensation might be required before access is granted (provider-side), or each time the usage action is performed (consumer-side)."@en ;
     .
@@ -65,7 +65,7 @@ idsc:DELETE
     a odrl:Action;
     rdfs:label "delete"@en ;
     rdfs:comment "To remove a resource or inhibit any further access with reasonable measures."@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/delete> ;
+    skos:broader odrl:delete ;
     odrl:includedIn idsc:WRITE ;
     skos:note "This action is evaluated at the consumer side if used in a duty clause. A provider cannot be forced to delete its data resources. If used in a permission clause, it is effecting the data provider as it allows the consumer to delete the provider's resource remotely."@en ;
     .
@@ -74,7 +74,7 @@ idsc:DISTRIBUTE
     a odrl:Action;
     rdfs:label "distribute"@en;
     rdfs:comment "To forward or supply a resource to a third-party."@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/distribute> ;
+    skos:broader odrl:distribute ;
     odrl:includedIn idsc:USE ;
     skos:note "This action is always evaluated at the consumer side and allows it to become a data provider of this resource."@en ;
     .
@@ -83,7 +83,7 @@ idsc:GRANT_USE
     a odrl:Action;
     rdfs:label "grant use"@en;
     rdfs:comment "To grant use of a resource to another party. Does *not* imply any other usage rights."@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/grantUse> ;
+    skos:broader odrl:grantUse ;
     odrl:includedIn idsc:USE ;
     skos:note "This action is always evaluated at the consumer side, at the moment a third party intends to access the resource as received by the original consumer."@en ;
     .
@@ -121,7 +121,7 @@ idsc:MODIFY
     a odrl:Action ;
     rdfs:comment "To change a resource locally."@en ;
     rdfs:label "modify"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/modify>;
+    skos:broader odrl:modify;
     odrl:includedIn idsc:WRITE ;
     skos:note "This action is always evaluated at the consumer side. It corresponds to 'allow changes of the copied resource'."@en ;
     .
@@ -137,7 +137,7 @@ idsc:NEXT_POLICY
     a odrl:Action ;
     rdfs:comment "To forward the resource under the same policy. Implies a permission to distribute."@en ;
     rdfs:label "next policy"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/nextPolicy> ;
+    skos:broader odrl:nextPolicy ;
     odrl:includedIn idsc:DISTRIBUTE ;
     skos:note "This action is always evaluated at the consumer side."@en ;
     .
@@ -146,7 +146,7 @@ idsc:NOTIFY
     a odrl:Action ;
     rdfs:comment "To log information or notify an instance about incidents. Can be used to define Clearing House interactions."@en ;
     rdfs:label "notify"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/inform> ;
+    skos:broader odrl:inform ;
     odrl:includedIn idsc:LOG ;
     skos:note "This action can target the consumer and the data provider of the resource."@en ;
     .
@@ -155,7 +155,7 @@ idsc:READ
     a odrl:Action ;
     rdfs:comment "To obtain data from the resource."@en ;
     rdfs:label "read"@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/read>;
+    skos:broader odrl:read;
     odrl:includedIn idsc:MODIFY ;
     skos:note "This action is always evaluated at the provider side. It corresponds to 'give access to a resource'."@en ;
     .
@@ -187,7 +187,7 @@ idsc:USE
     a odrl:Action;
     rdfs:label "use"@en;
     rdfs:comment "To use a resource in any possible way. Includes all other actions."@en ;
-    skos:broader <http://www.w3.org/ns/odrl/2/use> ;
+    skos:broader odrl:use ;
     skos:note "This action is always evaluated at the consumer side."@en ;
     .
 

docs/config/widoco.py

@@ -148,7 +148,7 @@ def get_jive_information(jive_credentials):
             subsection_id += 1
             description_text += '<div class="jive-rendered-content">' + useful_text
 
-    # Fix a enumeration mistake in the current version of the jive documents (last checked: 08/19)
+    # Fix an enumeration mistake in the current version of the jive documents (last checked: 08/19)
     description_text = re.sub(r'Figure\s3\s20:', 'Figure 3.24:', description_text)
     description_text = re.sub(r'Figure\s3\s21:', 'Figure 3.25:', description_text)
 
@@ -390,7 +390,7 @@ def clean_up_webvowl_ontology():
 
 
 # Some local references are included to the generated serializations.
-# This starts the clean up for all formats.
+# This starts the cleanup for all formats.
 def clean_up_ontology_serialization_owl_imports():
     clean_up_json_ontology_owl_imports()
     clean_up_nt_ontology_owl_imports()
@@ -400,7 +400,7 @@ def clean_up_ontology_serialization_owl_imports():
 
 
 # Renames widoco output file "index-en.html" to "index.html".
-# Only "index.html" gets displayed correctly with github pages.
+# Only "index.html" gets displayed correctly with GitHub pages.
 def rename_index_file():
     # Replace reference in index-en.html itself
     with open('../index-en.html') as fp:
@@ -448,7 +448,7 @@ def rename_namespace(old_ns, uri, new_ns):
 
 # Define all namespaces which are not wanted to be added to the namespaces.
 # Most of them come from "rdfs:seeAlso"-links or the additional references.
-# Additionally defines some incorrectly named namespaces and starts the
+# Additionally, defines some incorrectly named namespaces and starts the
 # substitution process.
 def adjust_namespaces():
     # Entry format for the list:

docs/readme.md

@@ -13,15 +13,15 @@ password for the IndustrialDataSpace Jiveon (https://industrialdataspace.jiveon.
 About Widoco output
 ===================
 The purpose of Widoco is to reuse and integrate existing tools for documentation, plus the set of features listed below:
-* Separation of the sections of your html page so you can write them independently and replace only those needed.
+* Separation of the sections of your html page, so you can write them independently and replace only those needed.
 * Automatic annotation in RDF-a of the html produced.
 * Association of a provenance page which includes the history of your vocabulary (W3C PROV-O compliant).
 * Metadata extraction from the ontology plus the means to complete it on the fly when generating your ontology.
 * Guidelines on the main sections that your document should have and how to complete them.
 
 Widoco will create 3 different folders:
 |
-|-provenance (a folder including an html and RDF serialization of how the documentation page was created)
+|-provenance (a folder including a html and RDF serialization of how the documentation page was created)
 |-resources (folder with the different resources)
 |-sections (folder with the different sections of the documentation, separated for easy editing. Just edit one and the main page will be updated)
 
@@ -31,7 +31,7 @@ Widoco uses the ontology metadata to update a configuration file. If you complet
 
 Browser issues
 ==========
-The result of executing Widoco is an html file. We have tested it in Mozilla, IE and Chrome, and when the page is stored in a server all the browsers work correctly. If you view the file locally, we recommend you to use Mozilla Firefox (or Internet Explorer, if you must). Google Chrome will not show the contents correctly, as it doesn't allow  XMLHttpRequest without HTTP. If you want to view the page locally with Google Chrome you have two possibilities:
+The result of executing Widoco is a html file. We have tested it in Mozilla, IE and Chrome, and when the page is stored in a server all the browsers work correctly. If you view the file locally, we recommend you to use Mozilla Firefox (or Internet Explorer, if you must). Google Chrome will not show the contents correctly, as it doesn't allow  XMLHttpRequest without HTTP. If you want to view the page locally with Google Chrome you have two possibilities:
 
 a) Place the file in a server and access it via its URL (for example, put it in dropbox and access through its public url).