WIP - but lots of tidy up (#125)

* WIP - but lots of tidy up

* Typo fixes

.github/pull_request_template.md

@@ -29,4 +29,4 @@ This PR bumps the version to <version number>.
   - the CHANGELOG update.
   - the version update.
 - [ ] I will make sure **not** to squash these commits, but **rebase** instead.
-- [ ] Once this PR is merged, I will push the tag I created (e.g. `git push origin vx.y.z`).
+- [ ] Once this PR is merged, I will push the tag I created (e.g., `git push origin vx.y.z`).

.github/workflows/cd.yml

@@ -12,6 +12,8 @@ jobs:
                 "common-rdf/vocab-common-rdf.yml",
                 "solid-rdf/vocab-solid.yml",
                 "inrupt-rdf/Core/vocab-inrupt-core.yml",
+                "inrupt-rdf/Core/vocab-inrupt-glossary.yml",
+                "inrupt-rdf/Core/vocab-inrupt-3rd-party.yml",
                 "inrupt-rdf/Test/vocab-inrupt-test.yml"
             ]
         name: CD for ${{ matrix.vocab }}

CHANGELOG.md

@@ -5,7 +5,12 @@ configuration files contained in this repository.
 
 ## Unreleased
 
--
+- Updated glossary vocabs, and added an initial Solid one (based on
+  [SolidProject](https://docs.inrupt.com/developer-tools/javascript/client-libraries/reference/glossary/)).
+- Removed unnecessary vocab descriptions from YAMLS (as descriptions should
+  come from vocabs themselves - we only provide the capability for vocabs that
+  fail to describe themselves).
+- Moved the basic test code into a JavaScript-specific sub-directory.
 
 ## v1.0.1 2021-08-20
 

README.md

@@ -5,7 +5,7 @@ controlled or used by Inrupt.
 
 Vocabularies (also known, slightly more formally, as Ontologies) provide the
 basis to allow developers build interoperable applications by reusing the
-individual terms (i.e. Classes and Properties) from well-known and public
+individual terms (i.e., Classes and Properties) from well-known and public
 vocabularies (such as Schema.org, or Friend-of-a-Friend (FOAF) or the Dublin
 Core (DC Terms) etc.), as well as from highly specialised or even private
 vocabularies, perhaps only ever intended for use within a narrow field, or

common-rdf/CopyOfVocab/inrupt-vann.ttl

@@ -1,7 +1,7 @@
 #
 # PMcB: I needed to manually create this Turtle representation as
 # dereferencing the namespace just returns HTML, even when specifically
-# using a HTTP 'Accept' header value of 'text/turtle' (e.g. using POSTMAN).
+# using a HTTP 'Accept' header value of 'text/turtle' (e.g., using POSTMAN).
 #
 # Note: I also took the liberty of adding triples for the ontology itself too.
 #

common-rdf/CopyOfVocab/inrupt-xml-schema.ttl

@@ -1,7 +1,7 @@
 #
 # PMcB: I needed to manually create this Turtle representation as
 # dereferencing the namespace just returns HTML, even when specifically
-# using a HTTP 'Accept' header value of 'text/turtle' (e.g. using POSTMAN).
+# using a HTTP 'Accept' header value of 'text/turtle' (e.g., using POSTMAN).
 #
 # Note: I also took the liberty of adding triples for the ontology itself too.
 #

common-rdf/Extension/http-header-inrupt-ext.ttl

@@ -16,7 +16,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix httph_inrupt_ext: <https://inrupt.com/vocab/extension/httph#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -31,7 +31,7 @@ httph_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:title "Inrupt extension adding terms and multilingual meta-data for HTTP headers" ;
     dcterms:description """Extension to th HTTPH (HTTP Headers) vocabulary
  providing terms for more headers that the current (Aug 2019) namespace document,
- and multilingual alternative names and translations for comments (e.g. for use
+ and multilingual alternative names and translations for comments (e.g., for use
  directly as labels or tool-tips in user interfaces or error messages)""" ;
     vann:preferredNamespacePrefix "httph_inrupt_ext" ;
     vann:preferredNamespaceUri "http://www.w3.org/2007/ont/httph#" ;

common-rdf/Extension/ldp-inrupt-ext.ttl

@@ -11,7 +11,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix ldp_inrupt_ext: <https://w3id.org/inrupt/vocab/extension/schema#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -24,7 +24,7 @@ ldp_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:creator <https://inrupt.com/profile/card/#us> ;
     dcterms:issued "2020/07/16"^^xsd:date ;
     dcterms:title "Inrupt extension adding multilingual meta-data for LDP terms"@en ;
-    dcterms:description "Extension to LDP terms providing multilingual alternative names and translations for comments (e.g. for use directly as labels or tool-tips in user interfaces or error messages)"@en ;
+    dcterms:description "Extension to LDP terms providing multilingual alternative names and translations for comments (e.g., for use directly as labels or tool-tips in user interfaces or error messages)"@en ;
     vann:preferredNamespacePrefix "ldp_inrupt_ext" ;
     vann:preferredNamespaceUri "http://www.w3.org/ns/ldp#" ;
     dcterms:license "http://www.opendatacommons.org/licenses/pddl/" .

common-rdf/Extension/rdf-inrupt-ext.ttl

@@ -12,7 +12,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix rdf_inrupt_ext: <https://inrupt.com/vocab/extension/rdf#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -25,7 +25,7 @@ rdf_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:creator <https://inrupt.com/profile/card/#us> ;
     dcterms:issued "2019/07/28"^^xsd:date ;
     dcterms:title "Inrupt extension adding multilingual meta-data for RDF terms" ;
-    dcterms:description "Extension to RDF terms providing multilingual alternative names and translations for comments (e.g. for use directly as labels or tool-tips in user interfaces or error messages)" ;
+    dcterms:description "Extension to RDF terms providing multilingual alternative names and translations for comments (e.g., for use directly as labels or tool-tips in user interfaces or error messages)" ;
     vann:preferredNamespacePrefix "rdf_inrupt_ext" ;
     vann:preferredNamespaceUri "http://www.w3.org/1999/02/22-rdf-syntax-ns#" ;
     dcterms:license "http://www.opendatacommons.org/licenses/pddl/" .

common-rdf/Extension/schema-inrupt-ext.ttl

@@ -14,7 +14,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix schema_inrupt_ext: <https://w3id.org/inrupt/vocab/extension/schema#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -28,8 +28,8 @@ schema_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:issued "2019/06/18"^^xsd:date ;
     dcterms:title "Inrupt extension adding multilingual meta-data for Schema.org terms" ;
     dcterms:description """Inrupt extension to Schema.org terms providing
- multilingual alternative names (i.e. labels) and translations for comments
- (e.g. for use directly as labels or tool-tips in user interfaces or error
+ multilingual alternative names (i.e., labels) and translations for comments
+ (e.g., for use directly as labels or tool-tips in user interfaces or error
  messages). This extension very deliberately cherry-picks the individual terms
  from Schema.org that Inrupt currently deem generally useful for Solid and Solid
  applications (meaning we can provide a much cleaner, less noisy and smaller
@@ -346,6 +346,17 @@ schema:attendee
     rdfs:comment "Una persona u organización que asista al evento."@es ;
     rdfs:comment "Una persona o un'organizzazione che partecipa all'evento."@it .
 
+schema:accessCode
+    rdfs:isDefinedBy schema_inrupt_ext: ;
+    schema:alternateName "Access code"@en ;
+    schema:alternateName "Code d'accès"@fr ;
+    schema:alternateName "Zugangscode"@de ;
+    schema:alternateName "Código de acceso"@es ;
+    schema:alternateName "Codice d'accesso"@it ;
+    rdfs:comment "Mot de passe, code PIN ou code d'accès nécessaire à la livraison (par exemple depuis un casier)."@fr ;
+    rdfs:comment "Passwort, PIN oder Zugangscode, der für die Lieferung benötigt wird (z. B. aus einem Schließfach)."@de ;
+    rdfs:comment "Se necesita contraseña, PIN o código de acceso para la entrega (por ejemplo, de un casillero)."@es ;
+    rdfs:comment "Password, PIN o codice di accesso necessari per la consegna (ad es. da un armadietto)."@it .
 
 #
 # Template for pulling in new terms!

common-rdf/Extension/ui-inrupt-ext.ttl

@@ -14,7 +14,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix ui_inrupt_ext: <https://w3id.org/inrupt/vocab/extension/ui#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -27,7 +27,7 @@ ui_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:creator <https://inrupt.com/profile/card/#us> ;
     dcterms:issued "2020/04/26"^^xsd:date ;
     dcterms:title "Inrupt extension for UI terms" ;
-    dcterms:description "Extension to UI terms providing multilingual alternative names and translations for comments (e.g. for use directly as labels or tool-tips in user interfaces or error messages)" ;
+    dcterms:description "Extension to UI terms providing multilingual alternative names and translations for comments (e.g., for use directly as labels or tool-tips in user interfaces or error messages)" ;
     dcterms:license "http://www.opendatacommons.org/licenses/pddl/" ;
 
     # Note: We deliberately use the underlying namespace here, as we are adding

common-rdf/Extension/vcard-inrupt-ext.ttl

@@ -14,7 +14,7 @@ prefix inrupt_gen: <https://inrupt.com/vocab/tool/artifact_generator#>
 prefix vcard_inrupt_ext: <https://inrupt.com/vocab/extension/vcard#>
 
 #
-# Extensions deliberately add (i.e. extend) existing terms in existing
+# Extensions deliberately add (i.e., extend) existing terms in existing
 # vocabularies, specifically to add extra features, such as multilingual
 # values for labels and comments.
 #
@@ -27,7 +27,7 @@ vcard_inrupt_ext: a owl:Ontology, inrupt_gen:Ontology ;
     dcterms:creator <https://inrupt.com/profile/card/#us> ;
     dcterms:issued "2019/07/28"^^xsd:date ;
     dcterms:title "Inrupt extension adding multilingual meta-data for VCard terms" ;
-    dcterms:description "Extension to VCard terms providing multilingual alternative names and translations for comments (e.g. for use directly as labels or tool-tips in user interfaces or error messages)" ;
+    dcterms:description "Extension to VCard terms providing multilingual alternative names and translations for comments (e.g., for use directly as labels or tool-tips in user interfaces or error messages)" ;
     vann:preferredNamespacePrefix "vcard_inrupt_ext" ;
     vann:preferredNamespaceUri "http://www.w3.org/2006/vcard/ns#" ;
     dcterms:license "http://www.opendatacommons.org/licenses/pddl/" .

common-rdf/vocab-common-rdf.yml

@@ -34,10 +34,54 @@ license:
   name: "MIT"
 
 artifactToGenerate:
-  # This is the configuration of the DEFAULT Java artifact - i.e. where the name
-  # of the generated JAR does not contain details of it's dependencies (e.g.
-  # whether it provides VocabTerm constants or just string constants, or whether
+  # This is the configuration of the DEFAULT Java artifact - i.e., where the name
+  # of the generated JAR does not contain details of its dependencies (e.g.,
+  # whether it provides SolidCommonVocab constants or just string constants, or whether
   # it depends on RDF4J or Jena or RDF Commons, etc.).
+  - programmingLanguage: Java
+    artifactVersion: 0.8.2-SNAPSHOT
+
+    artifactDirectoryName: Java
+    sourceFileExtension: java
+    javaPackageName: com.inrupt.vocab.common.rdf
+
+    templateInternal: stringLiteral/java/vocab.hbs
+
+    # Currently we're just adding terms as they occur in vocabs, and not all possible keywords.
+    languageKeywordsToUnderscore:
+      - class     # Defined in VCard.
+      - abstract  # Defined in DCTerms.
+      - for       # Defined in ?.
+      - default   # Defined in ACL.
+      - boolean   # Defined in XML Schema Datatypes.
+      - float     # Defined in XML Schema Datatypes.
+      - double    # Defined in XML Schema Datatypes.
+      - byte      # Defined in XML Schema Datatypes.
+      - int       # Defined in XML Schema Datatypes.
+      - long      # Defined in XML Schema Datatypes.
+      - short     # Defined in XML Schema Datatypes.
+    packaging:
+      - packagingTool: maven
+        groupId: com.inrupt
+        publish:
+          - key: "mavenLocal"
+            command: "mvn --version && mvn install"
+          - key: "mavenRemote"
+            command: "mvn deploy"
+          - key: "cloudsmith"
+            command: "mvn -s /home/runner/work/solid-common-vocab-rdf/solid-common-vocab-rdf/settings.xml deploy --log-file ../../../mvn-deploy.log"
+        packagingTemplates:
+          - templateInternal: stringLiteral/java/pom.hbs
+            fileName: pom.xml
+        repository:
+          - type: repository
+            id: cloudsmith-staging
+            url: https://maven.cloudsmith.io/inrupt/sdk-staging/
+          - type: snapshotRepository
+            id: cloudsmith-development
+            url: https://maven.cloudsmith.io/inrupt/sdk-development/
+
+
   - programmingLanguage: Java
     artifactVersion: 0.8.2-SNAPSHOT
 
@@ -88,7 +132,7 @@ artifactToGenerate:
 
     artifactDirectoryName: Java-StringLiteral
     sourceFileExtension: java
-    javaPackageName: com.inrupt.vocab.common.rdf
+    javaPackageName: com.inrupt.vocab.common.rdf.stringliteral
     artifactSuffix: -stringliteral
 
     templateInternal: stringLiteral/java/vocab.hbs
@@ -127,12 +171,13 @@ artifactToGenerate:
             id: cloudsmith-development
             url: https://maven.cloudsmith.io/inrupt/sdk-development/
 
+
   - programmingLanguage: Java
     artifactVersion: 0.8.2-SNAPSHOT
 
-    artifactDirectoryName: Java-SolidCommonVocab-Rdf4J
+    artifactDirectoryName: Java-SolidCommonVocab-RDF4J
     sourceFileExtension: java
-    javaPackageName: com.inrupt.vocab.common.rdf
+    javaPackageName: com.inrupt.vocab.common.rdf.rdf4j
     artifactSuffix: -solidcommonvocab-rdf4j
 
     solidCommonVocabVersion: 0.0.3
@@ -163,12 +208,13 @@ artifactToGenerate:
             id: cloudsmith-development
             url: https://maven.cloudsmith.io/inrupt/sdk-development/
 
+
   - programmingLanguage: Java
     artifactVersion: 0.8.2-SNAPSHOT
 
     artifactDirectoryName: Java-CommonsRdf-ServiceLoader
     sourceFileExtension: java
-    javaPackageName: com.inrupt.vocab.common.rdf
+    javaPackageName: com.inrupt.vocab.common.rdf.commonsrdf.serviceloader
     artifactSuffix: -commonsrdf-serviceloader
 
     # This config doesn't use our own vocab library - it uses a specific
@@ -200,9 +246,9 @@ artifactToGenerate:
             id: cloudsmith-development
             url: https://maven.cloudsmith.io/inrupt/sdk-development/
 
-  # This is the configuration of the DEFAULT TypeScript artifact - i.e. where
-  # the name of the generated npm module does not contain details of it's
-  # dependencies (e.g. whether it provides VocabTerm constants or just string
+  # This is the configuration of the DEFAULT TypeScript artifact - i.e., where
+  # the name of the generated npm module does not contain details of its
+  # dependencies (e.g., whether it provides SolidCommonVocab constants or just string
   # literals, or whether it depends on RDF/JS or Jena or RDF Commons, etc.).
   - programmingLanguage: TypeScript
     artifactVersion: "1.0.1"
@@ -240,16 +286,16 @@ artifactToGenerate:
             fileName: rollup.config.js
 
 
-  # This is the configuration of the DEFAULT VocabTerm TypeScript artifact -
-  # i.e., where the name of the generated npm module does not contain details
-  # of the underlying RDF library dependencies (e.g., whether it depends on
-  # RDF/JS or a specific implementation, etc.).
+  # This is the configuration of the DEFAULT SolidCommonVocab TypeScript
+  # artifact - i.e., where the name of the generated npm module does not
+  # contain details of the underlying RDF library dependencies (e.g.,
+  # whether it depends on RDF/JS or a specific implementation, etc.).
   - programmingLanguage: TypeScript
     artifactVersion: "1.0.1"
 
-    artifactDirectoryName: TypeScript-VocabTerm
+    artifactDirectoryName: TypeScript-SolidCommonVocab
     sourceFileExtension: ts
-    artifactSuffix: -vocabterm
+    artifactSuffix: -solidcommonvocab
 
     solidCommonVocabVersion: "^1.0.0"
     rdfjsTypesVersion: "^1.0.1"
@@ -287,9 +333,9 @@ artifactToGenerate:
   - programmingLanguage: TypeScript
     artifactVersion: "1.0.1"
 
-    artifactDirectoryName: TypeScript-VocabTerm-rdfjs-RdfDataFactory
+    artifactDirectoryName: TypeScript-SolidCommonVocab-RdfDataFactory
     sourceFileExtension: ts
-    artifactSuffix: -vocabterm-rdfjs-rdfdatafactory
+    artifactSuffix: -solidcommonvocab-rdfdatafactory
 
     solidCommonVocabVersion: "^1.0.0"
     rdfjsTypesVersion: "^1.0.1"
@@ -332,10 +378,10 @@ artifactToGenerate:
 #
 #  - programmingLanguage: TypeScript
 #    artifactVersion: "1.0.1"
-#    artifactDirectoryName: TypeScript-rdfjs-Base
+#    artifactDirectoryName: TypeScript-Base
 #    templateInternal: rdfLibraryDependent/typescript/rdfjsBase-DataModel/vocab.hbs
 #    sourceFileExtension: ts
-#    artifactSuffix: -rdfjs-base
+#    artifactSuffix: -base
 #    packaging:
 #      - packagingTool: npm
 #        npmModuleScope: "@inrupt/"
@@ -368,9 +414,9 @@ artifactToGenerate:
   - programmingLanguage: TypeScript
     artifactVersion: "1.0.1"
 
-    artifactDirectoryName: TypeScript-rdfjs-RdfDataFactory
+    artifactDirectoryName: TypeScript-RdfDataFactory
     sourceFileExtension: ts
-    artifactSuffix: -rdfjs-rdfdatafactory
+    artifactSuffix: -rdfdatafactory
 
     rdfjsTypesVersion: "^1.0.1"
     rdfjsImplVersion: "^1.1.0"
@@ -603,7 +649,7 @@ vocabList:
       - http://dublincore.org/2012/06/14/dcterms.ttl
 
   #
-  # Activity Streams 2.0 seems a little bit strange - i.e. it's namespace IRI
+  # Activity Streams 2.0 seems a little bit strange - i.e., it's namespace IRI
   # does not resolve to RDF (see below), and the best RDF definition (that we
   # can find!) of its terms refers to those terms using the 'http:' scheme
   # instead of the official 'https:' scheme (so we need to override that).