more work on documentation

SmartDataAnalytics · Sep 18, 2024 · dd7b4bb · dd7b4bb
1 parent ccfe64d
commit dd7b4bb
Show file tree

Hide file tree

Showing 37 changed files with 41 additions and 18 deletions.
diff --git a/doc/README.md → docs/examples/README.md b/doc/README.md → docs/examples/README.md
@@ -1,3 +1,10 @@
+---
+title: Examples
+parent: RDF/SPARQL Processing
+layout: default
+nav_order: 10
+---
+
 # SPARQL Integrate examples
 
 

diff --git a/doc/csv.sparql → docs/examples/csv.sparql b/doc/csv.sparql → docs/examples/csv.sparql
diff --git a/doc/data.csv → docs/examples/data.csv b/doc/data.csv → docs/examples/data.csv
diff --git a/doc/example-data/data.csv → docs/examples/example-data/data.csv b/doc/example-data/data.csv → docs/examples/example-data/data.csv
diff --git a/doc/example-data/data.ttl → docs/examples/example-data/data.ttl b/doc/example-data/data.ttl → docs/examples/example-data/data.ttl
diff --git a/doc/example-data/people.csv → docs/examples/example-data/people.csv b/doc/example-data/people.csv → docs/examples/example-data/people.csv
diff --git a/doc/fs-list-all-files.sparql → docs/examples/fs-list-all-files.sparql b/doc/fs-list-all-files.sparql → docs/examples/fs-list-all-files.sparql
diff --git a/doc/fs-list-rdf-files.sparql → docs/examples/fs-list-rdf-files.sparql b/doc/fs-list-rdf-files.sparql → docs/examples/fs-list-rdf-files.sparql
diff --git a/doc/fs-query-rdf-files.sparql → docs/examples/fs-query-rdf-files.sparql b/doc/fs-query-rdf-files.sparql → docs/examples/fs-query-rdf-files.sparql
diff --git a/doc/fs-test.sparql → docs/examples/fs-test.sparql b/doc/fs-test.sparql → docs/examples/fs-test.sparql
diff --git a/doc/hashbang.sparql → docs/examples/hashbang.sparql b/doc/hashbang.sparql → docs/examples/hashbang.sparql
diff --git a/doc/io.sparql → docs/examples/io.sparql b/doc/io.sparql → docs/examples/io.sparql
diff --git a/doc/json-by-index.sparql → docs/examples/json-by-index.sparql b/doc/json-by-index.sparql → docs/examples/json-by-index.sparql
diff --git a/doc/json-hello-world.sparql → docs/examples/json-hello-world.sparql b/doc/json-hello-world.sparql → docs/examples/json-hello-world.sparql
diff --git a/doc/json-path-inline.sparql → docs/examples/json-path-inline.sparql b/doc/json-path-inline.sparql → docs/examples/json-path-inline.sparql
diff --git a/doc/json-path1.sparql → docs/examples/json-path1.sparql b/doc/json-path1.sparql → docs/examples/json-path1.sparql
diff --git a/doc/json-unnest-by-index.sparql → docs/examples/json-unnest-by-index.sparql b/doc/json-unnest-by-index.sparql → docs/examples/json-unnest-by-index.sparql
diff --git a/doc/json-unnest.sparql → docs/examples/json-unnest.sparql b/doc/json-unnest.sparql → docs/examples/json-unnest.sparql
diff --git a/doc/json-zip-arrays.sparql → docs/examples/json-zip-arrays.sparql b/doc/json-zip-arrays.sparql → docs/examples/json-zip-arrays.sparql
diff --git a/doc/test-zip-arrays.sparql → docs/examples/test-zip-arrays.sparql b/doc/test-zip-arrays.sparql → docs/examples/test-zip-arrays.sparql
diff --git a/doc/test.nt → docs/examples/test.nt b/doc/test.nt → docs/examples/test.nt
diff --git a/doc/test.sparql → docs/examples/test.sparql b/doc/test.sparql → docs/examples/test.sparql
diff --git a/doc/test2.sparql → docs/examples/test2.sparql b/doc/test2.sparql → docs/examples/test2.sparql
diff --git a/doc/test3.sparql → docs/examples/test3.sparql b/doc/test3.sparql → docs/examples/test3.sparql
diff --git a/doc/test4.sparql → docs/examples/test4.sparql b/doc/test4.sparql → docs/examples/test4.sparql
diff --git a/doc/url-local-file.sparql → docs/examples/url-local-file.sparql b/doc/url-local-file.sparql → docs/examples/url-local-file.sparql
diff --git a/doc/workloads.sparql → docs/examples/workloads.sparql b/doc/workloads.sparql → docs/examples/workloads.sparql
diff --git a/doc/xml-attribute.sparql → docs/examples/xml-attribute.sparql b/doc/xml-attribute.sparql → docs/examples/xml-attribute.sparql
diff --git a/doc/xml-unnest.sparql → docs/examples/xml-unnest.sparql b/doc/xml-unnest.sparql → docs/examples/xml-unnest.sparql
diff --git a/docs/graphql/demo.md b/docs/graphql/demo.md
@@ -1,6 +1,6 @@
 ---
 title: Online demo
-parent: GraphQL
+parent: GraphQL over SPARQL
 nav_order: 90
 layout: default
 ---
@@ -10,5 +10,7 @@ Inspect the source code to see the underlying queries.
 
 * A simple [WikiData Movies Browser.](https://smartdataanalytics.github.io/RdfProcessingToolkit/demos/movies/). This is a HTML one-pager that queries the GraphQL endpoint of a demo RPT instance loaded with movies from Wikidata.
 
-* A simple [GraphQL-to-GeoJSON Demo.](https://smartdataanalytics.github.io/RdfProcessingToolkit/demos/leaflet-graphql/). This is a HTML one-pager that uses GraphQL to transform GeoSPARQL data to a customizable GeoJSON structure.
+* A simple [GraphQL-to-GeoJSON Demo.](https://smartdataanalytics.github.io/RdfProcessingToolkit/demos/leaflet-graphql/). This is a HTML one-pager that uses GraphQL to transform GeoSPARQL data to a customizable GeoJSON structure. It also demonstrates:
+    * Ad-hoc simplification of GeoSPARQL polygons using our `geof:simplifyDp` extension function.
+    * Use of caching cardinalities of properties across a dataset using `SERVICE <cache:>`, which is part of Apache Jena's [Service Enhancer extension](https://jena.apache.org/documentation/query/service_enhancer.html).
 
diff --git a/docs/graphql/index.md b/docs/graphql/index.md
@@ -1,5 +1,5 @@
 ---
-title: GraphQL
+title: GraphQL over SPARQL
 has_children: true
 nav_order: 100
 layout: default

diff --git a/docs/graphql/reference/index-directive.md b/docs/graphql/reference/index-directive.md
@@ -1,6 +1,6 @@
 ---
 title: index
-parent: GraphQL
+parent: GraphQL over SPARQL
 nav_order: 150
 layout: default
 ---

diff --git a/docs/graphql/reference/join.md b/docs/graphql/reference/join.md
@@ -1,6 +1,6 @@
 ---
 title: join
-parent: Reference
+parent: GraphQL over SPARQL
 nav_order: 140
 layout: default
 ---
@@ -18,7 +18,7 @@ While implicit joins automatically connect a parent’s target variables with a
 #### Arguments
 
 - **`parent`** (`String | [String]`): Specifies the parent field's variable(s) to be joined.
-- **`this`** (`String | [String]`): Specifies the child field's variable(s) that should be connected with the parent’s variable(s).
+- **`this`** (`String | [String]`): Specifies `this` field's variable(s) that should be connected with its parent’s variable(s).
 
 #### Usage
 

diff --git a/docs/graphql/reference/one-and-many.md b/docs/graphql/reference/one-and-many.md
@@ -1,13 +1,13 @@
 ---
 title: one and many
-parent: GraphQL
+parent: GraphQL over SPARQL
 nav_order: 130
 layout: default
 ---
 
 ## GraphQL Directives: `@one` and `@many`
 
-The `@one` and `@many` directives control the cardinality of a field within a GraphQL schema. These directives are particularly useful in RDF and SPARQL-based contexts, where fields often correspond to graph patterns that involve relationships with varying cardinalities.
+The `@one` and `@many` directives control the cardinality of a field within a GraphQL query or schema. These directives are particularly useful in RDF and SPARQL-based contexts, where fields often correspond to graph patterns that involve relationships with varying cardinalities.
 
 ### Purpose
 

diff --git a/docs/graphql/reference/prefix.md b/docs/graphql/reference/prefix.md
@@ -1,13 +1,13 @@
 ---
 title: prefix
-parent: GraphQL
+parent: GraphQL over SPARQL
 nav_order: 100
 layout: default
 ---
 
 ## GraphQL Directive: `@prefix`
 
-The `@prefix` directive is designed to manage and define namespace prefixes in a GraphQL schema. This directive can be used to either specify a single prefix with an IRI or map multiple prefixes to their corresponding IRIs.
+The `@prefix` directive is designed to manage and define namespace prefixes in a GraphQL query or schema. This directive can be used to either specify a single prefix with an IRI or map multiple prefixes to their corresponding IRIs.
 
 ### Usage
 
@@ -32,25 +32,26 @@ The `@prefix` directive accepts two possible configurations:
     {
       field
         @prefix(name: "rdf", iri: "http://www.w3.org/1999/02/22-rdf-syntax-ns#")
+        @prefix(name: "owl", iri: "http://www.w3.org/2002/07/owl#")
     }
     ```
 
 2. **Multiple Prefix Mapping**
 
-    Define multiple prefixes using the `map` argument:
+    Define multiple prefixes using the `map` argument. As GraphQL does not allow the empty string `""` as a key, the `name/iri` form can be used in conjunction with map:
 
     ```graphql
+    query MyQuery
+      @prefix(map: {
+        rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+        rdfs: "http://www.w3.org/2000/01/rdf-schema#"
+      }, name: "", iri: "http://my.domain/ontology/)
     {
-      field
-        @prefix(map: {
-          rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
-          rdfs: "http://www.w3.org/2000/01/rdf-schema#"
-        })
+      # ...
     }
     ```
 
 #### Notes
 
 - When using the `map` argument, you can define multiple prefix-to-IRI mappings in a single directive instance.
-- The `name` and `iri` arguments should not be used together with the `map` argument; choose one configuration based on your needs.
 
diff --git a/docs/integrate/canned-queries.md b/docs/integrate/canned-queries.md
@@ -1,7 +1,7 @@
 ---
 title: Canned Queries
 parent: RDF/SPARQL Processing
-nav_order: 10
+nav_order: 30
 layout: default
 ---
 

diff --git a/docs/integrate/sparql-extensions.md b/docs/integrate/sparql-extensions.md
@@ -0,0 +1,13 @@
+---
+title: SPARQL Extensions
+nav_order: 20
+layout: default
+---
+
+## SPARQL Extensions
+RPT's SPARQL extensions are provided by our unofficial [JenaX Jena eXtenions project](https://scaseco.github.io/jenax/).
+
+* A function reference is available at [http://jsa.aksw.org/fn/](http://jsa.aksw.org/fn/).
+  Note, that the functions are being consolidated into the new `norse` (Not Only Rdf Sparql Extensions) namespace `norse: <https://w3id.org/aksw/norse#>`.
+* Additional extensions are detailed at our [JenaX ARQ Plugins documentation](https://scaseco.github.io/jenax/jenax-arq-parent/jenax-arq-plugins-parent/README.html).
+