#201 Update documentation '#457'

SPARQL-Anything · Jan 9, 2024 · 0bf3c7e · 0bf3c7e
1 parent 4502c8b
commit 0bf3c7e
Show file tree

Hide file tree

Showing 7 changed files with 70 additions and 7 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -1,9 +1,10 @@
 [![DOI](https://zenodo.org/badge/303967701.svg)](https://zenodo.org/badge/latestdoi/303967701)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![How to](https://img.shields.io/badge/How%20to-cite-green.svg)](#how-to-cite-our-work)
-[![Java 11](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java11.yml/badge.svg?branch=v0.9-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java11.yml)
-[![Java 14](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java14.yml/badge.svg?branch=v0.9-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java14.yml)
-[![Java 14](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java17.yml/badge.svg?branch=v0.9-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java17.yml)
+[![Java 11](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java11.yml/badge.svg?branch=v1.0-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java11.yml)
+[![Java 14](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java14.yml/badge.svg?branch=v1.0-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java14.yml)
+[![Java 14](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java17.yml/badge.svg?branch=v1.0-DEV)](https://github.com/sparql-anything/sparql.anything/actions/workflows/maven_Java17.yml)
+[![CodeQL](https://github.com/SPARQL-Anything/sparql.anything/actions/workflows/codeql-analysis.yml/badge.svg?branch=v1.0-DEV)](https://github.com/SPARQL-Anything/sparql.anything/actions/workflows/codeql-analysis.yml)
 
 # SPARQL Anything
 

diff --git a/docs/formats/Bibliography.md b/docs/formats/Bibliography.md
@@ -28,6 +28,31 @@ SPARQL Anything selects this transformer for the following media types:
 
 ### Data
 
+```Bibliography
+@article{Knuth1984,
+  title={Literate Programming},
+  author={Donald E. Knuth},
+  journal={The Computer Journal},
+  volume={27},
+  number={2},
+  pages={97--111},
+  year={1984},
+  publisher={Oxford University Press}
+}
+
+
+@article{Berners2001,
+  title={The semantic web},
+  author={Berners-Lee, Tim and Hendler, James and Lassila, Ora},
+  journal={Scientific american},
+  volume={284},
+  number={5},
+  pages={34--43},
+  year={2001}
+}
+
+```
+
 Located at https://sparql-anything.cc/examples/example.bib
 
 ### Query

diff --git a/docs/formats/Metadata.md b/docs/formats/Metadata.md
@@ -122,7 +122,7 @@ WHERE
             <http://sparql.xyz/facade-x/data/F-Number>
                     "f/7.1" ;
             <http://sparql.xyz/facade-x/data/File%20Modified%20Date>
-                    "Mon Jan 08 11:21:29 +01:00 2024" ;
+                    "Tue Jan 09 12:31:12 +01:00 2024" ;
             <http://sparql.xyz/facade-x/data/File%20Name>
                     "Canon_40D.jpg" ;
             <http://sparql.xyz/facade-x/data/File%20Size>

diff --git a/docs/formats/RDF.md b/docs/formats/RDF.md
@@ -6,7 +6,13 @@ RDF files can be targeted by the option `location`, the content is loaded as-is
 
 The query does not need to include a SERVICE clause, so you can use the tool to just query some RDF file of your choice.
 This is useful when you want to break down the process so that RDF files produced by previous SPARQL Anything processes are joined with data coming from additional transformatioons.
-Examples of this can be found in the [tutorials](TUTORIALS.md).
+Examples of this can be found in the [tutorials](TUTORIALS.md).This feature is enabled with the command line argument `-l|--load` that accepts a file or a directory.
+The files are loaded in a Dataset which becomes the target for the query execution.
+A single file will be loaded in the default Graph. 
+In the second case, all RDF files in the folder are loaded, each one on a Named Graph.
+
+See also the documentation of the [Command Line Interface (CLI)](CLI.md).
+
 
 ## Extensions
 

diff --git a/formats/Bibliography.md b/formats/Bibliography.md
@@ -28,6 +28,31 @@ SPARQL Anything selects this transformer for the following media types:
 
 ### Data
 
+```Bibliography
+@article{Knuth1984,
+  title={Literate Programming},
+  author={Donald E. Knuth},
+  journal={The Computer Journal},
+  volume={27},
+  number={2},
+  pages={97--111},
+  year={1984},
+  publisher={Oxford University Press}
+}
+
+
+@article{Berners2001,
+  title={The semantic web},
+  author={Berners-Lee, Tim and Hendler, James and Lassila, Ora},
+  journal={Scientific american},
+  volume={284},
+  number={5},
+  pages={34--43},
+  year={2001}
+}
+
+```
+
 Located at https://sparql-anything.cc/examples/example.bib
 
 ### Query

diff --git a/formats/Metadata.md b/formats/Metadata.md
@@ -122,7 +122,7 @@ WHERE
             <http://sparql.xyz/facade-x/data/F-Number>
                     "f/7.1" ;
             <http://sparql.xyz/facade-x/data/File%20Modified%20Date>
-                    "Mon Jan 08 11:21:29 +01:00 2024" ;
+                    "Tue Jan 09 12:31:12 +01:00 2024" ;
             <http://sparql.xyz/facade-x/data/File%20Name>
                     "Canon_40D.jpg" ;
             <http://sparql.xyz/facade-x/data/File%20Size>

diff --git a/formats/RDF.md b/formats/RDF.md
@@ -6,7 +6,13 @@ RDF files can be targeted by the option `location`, the content is loaded as-is
 
 The query does not need to include a SERVICE clause, so you can use the tool to just query some RDF file of your choice.
 This is useful when you want to break down the process so that RDF files produced by previous SPARQL Anything processes are joined with data coming from additional transformatioons.
-Examples of this can be found in the [tutorials](TUTORIALS.md).
+Examples of this can be found in the [tutorials](TUTORIALS.md).This feature is enabled with the command line argument `-l|--load` that accepts a file or a directory.
+The files are loaded in a Dataset which becomes the target for the query execution.
+A single file will be loaded in the default Graph. 
+In the second case, all RDF files in the folder are loaded, each one on a Named Graph.
+
+See also the documentation of the [Command Line Interface (CLI)](CLI.md).
+
 
 ## Extensions