Merge pull request #245 from SolidLabResearch/development

Merge for v2.2.0

Author: mvanbrab

CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.2.0] - 2025-10-30
+
+### Changed
+
+- Export cleaned so that it doesn't contain irrelevant columns (#242).
+- Documented and tested SPARQL query restrictions (#243).
+
 ## [2.1.1] - 2025-10-14
 
 ### Changed
@@ -291,4 +298,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [2.0.0]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/releases/tag/v2.0.0
 [2.1.0]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/releases/tag/v2.1.0
 [2.1.1]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/releases/tag/v2.1.1
-[Unreleased]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/compare/v2.1.1...HEAD
+[2.2.0]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/releases/tag/v2.2.0
+[Unreleased]: https://github.com/SolidLabResearch/miravi-a-linked-data-viewer/compare/v2.2.0...HEAD

README.md

@@ -24,6 +24,7 @@ Table of contents:
 * [Static, production build](#static-production-build)
 * [Logging in](#logging-in)
 * [Configuration file](#configuration-file)
+  * [Writing SPARQL queries](#writing-sparql-queries)
   * [Specifying sources](#specifying-sources)
   * [About httpProxies](#about-httpproxies)
   * [Adding variable type](#adding-variable-type)
@@ -154,7 +155,7 @@ The configuration file must follow the structure shown below.
   "logoLocation": "Image location of the logo shown at the top of the app (relative to public folder.).",
   "logoRedirectURL": "The URL the Web application redirects to when a user clicks on the logo.",
   "defaultIDP": "The default value used for IDP when logging in, this IDP can be manually changed in the Web app as well. ",
-  "queryFolder": "The base location of the queries, all query locations will start from this folder (relative to public folder).",
+  "queryFolder": "The base location of the SPARQL queries, all query locations will start from this folder (relative to public folder).",
   "introductionText": "The text that the app shows on the dashboard, which the app also shows when you first open it.",
   "queryGroups" : [
     {
@@ -167,7 +168,7 @@ The configuration file must follow the structure shown below.
     {
       "id": "A unique ID for the query. This ID appears in the URL of the displayed result. Queries are ordered in the menu according to ascending ID.",
       "queryGroupId": "ID of the query group too which this query belongs. If not given, the query is displayed outside existing groups.",
-      "queryLocation": "Path to the query location, relative to 'queryFolder'",
+      "queryLocation": "Path to the SPARQL query location, relative to 'queryFolder'",
       "name": "A name for the query",
       "description": "Description of the query",
       "icon": "The key to the icon for the query. This is optional and a default menu icon will be used when left empty.",
@@ -213,6 +214,16 @@ The configuration file must follow the structure shown below.
 }
 ```
 
+### Writing SPARQL queries
+
+Write each [SPARQL query](https://www.w3.org/TR/sparql11-query/) in a separate file (see `queryLocation` in the configuration file).
+
+The following restrictions apply to SPARQL queries in Miravi:
+
+* Mark your query variables with `?`, not with `$`. The `$` sign is reserved for use in [templated queries](#templated-queries).
+* Do not use `_` in variable names, unless for [adding variable type](#adding-variable-type).
+* Do not use `id` as a variable name. It is reserved for internal use.
+
 ### Specifying sources
 
 The set of sources over which a query will be executed is derived from two *optional* inputs in a query entry:

main/configs/test/config.json

@@ -607,6 +607,18 @@
         ],
         "lenient": true
       }
+    },
+    {
+      "id": "9300",
+      "queryGroupId": "gr-test",
+      "queryLocation": "idols_id.rq",
+      "name": "Reserved variable name test",
+      "description": "Tests a query with a reserved variable name.",
+      "comunicaContext": {
+        "sources": [
+          "http://localhost:8000/example/idols"
+        ]
+      }
     }
   ]
 }

main/configs/test/public/queries/idols_id.rq

@@ -0,0 +1,9 @@
+PREFIX schema: <http://schema.org/> 
+
+SELECT ?id ?birthDate_int WHERE {
+    ?list schema:name ?listTitle;
+      schema:itemListElement [
+      schema:name ?id;
+      schema:birthDate ?birthDate_int;
+    ].
+}