Skip to content

Commit f37a8c4

Browse files
committed
Added screenshots and more explanation.
1 parent 7c54ec3 commit f37a8c4

File tree

1 file changed

+37
-26
lines changed

1 file changed

+37
-26
lines changed

README.md

Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,44 @@
11
# Linked Data Extension
22

3-
The Elsevier Data Architecture Linked Data Extension for Visual Studio Code brings a number of Linked Data related functionalities to a popular integrated development environment.
3+
The Elsevier Data Architecture Linked Data Extension (LDE) for Visual Studio Code brings a number of Linked Data related functionalities to a popular integrated development environment.
44

5-
This extension depends on the [Stardog Languages Extension Pack](https://marketplace.visualstudio.com/items?itemName=stardog-union.vscode-stardog-languages) from Stardog Union
5+
It's not industry-grade solid, but should be *good enough™*. For any questions, comments, please contact [Rinke Hoekstra](mailto:[email protected]), or create an issue in the [GitHub repository](https://github.com/elsevierlabs-os/linked-data).
66

7-
For any questions, comments, please contact [Rinke Hoekstra](mailto:[email protected])
7+
## What it does
88

9-
## Features
9+
* Visualise an RDF graph directly from a file.
10+
* Convert between JSON-LD, Turtle, RDF/XML and N-Quads (some quirks because not every format supports named graphs)
11+
* Convert between JSON-LD variants (compact, expanded, flattened)
12+
* Apply a JSON-LD frame to a JSON-LD file.
13+
* Validate your RDF against a SHACL file
14+
* Run a SPARQL query directly on a file and see the results in HTML and CSV
1015

11-
The extension supports the following:
16+
The JSON-LD operations can work with local context files. This overcomes the limitation in most JSON-LD libraries that interpret context references as URLs. See the `loadLocalContexts` setting below.
17+
18+
Download Linked Data Extension from <https://marketplace.visualstudio.com/items?itemName=Elsevier.linked-data> or through the Extensions menu of VSCode.
19+
20+
This extension depends on the [Stardog Languages Extension Pack](https://marketplace.visualstudio.com/items?itemName=stardog-union.vscode-stardog-languages) from Stardog Union for file type recognition, syntax highlighting and syntax checking.
21+
22+
## Screenshots
23+
24+
For the files used in the screenshots, see the [examples](examples) folder.
25+
26+
### Conversion Between RDF Formats
27+
28+
![RDF Formats](media/img/different_formats.png)
29+
30+
### Visualisation and JSON-LD Variants
31+
32+
![Visualization](media/img/jsonld_visualisation.png)
33+
34+
### SPARQL and SHAQL
35+
![Querying and Validation](media/img/shacl_and_sparql.png)
36+
37+
## Commands
38+
39+
You can access the commands through the command palette: `Cmd-Shift-p` or `Ctrl-Shift-p` and then start typing "Linked Data", or use one of the following keyboard shortcuts.
40+
41+
### Keyboard Shortcuts
1242

1343
* Standard syntactic JSON-LD operations:
1444
* `Ctrl-Option-e`/`Ctrl-Alt-e`: Convert a JSON-LD structure to the [expanded document form](https://www.w3.org/TR/json-ld11/#expanded-document-form)
@@ -27,27 +57,11 @@ The extension supports the following:
2757
* Query a Graph:
2858
* `Ctrl-Option-q`/`Ctrl-Alt-q`: Run the SPARQL query against an RDF file (see below)
2959

30-
You can also access the commands through the command palette: `Cmd-Shift-p` or `Ctrl-Shift-p` and then start typing "Linked Data".
31-
32-
<!-- ## Screenshots
33-
34-
### Conversion Between RDF Formats
35-
36-
![RDF Formats](media/img/different_formats.png)
37-
38-
### Visualisation and JSON-LD Variants
39-
40-
![Visualization](media/img/jsonld_visualisation.png)
41-
42-
### SPARQL and SHAQL
43-
![Querying and Validation](media/img/shacl_and_sparql.png) -->
44-
45-
4660
## Extension Settings
4761

4862
This extension contributes the following settings:
4963

50-
* `linked-data.loadLocalContexts`: Should the extension try to load local (non-URI) contexts?
64+
* `linked-data.loadLocalContexts`: Should the extension try to load local (non-URI) JSON-LD context files. This is especially useful when testing large context files that are intended to be shared across multiple JSON-LD files. It overcomes the problem that JSON-LD libraries interpret references to contexts as URIs, which would require running an HTTP server to test the context.
5165

5266
## Tips and Recommendations
5367

@@ -91,7 +105,4 @@ SPARQL results are shown both as a web view with a table that supports sorting a
91105
* Zazuko's SHACL validator, <https://github.com/zazuko/rdf-validate-shacl>
92106
* Google's Schemarama, <https://github.com/google/schemarama>
93107
* d3js, <https://d3js.org>
94-
95-
## Release Notes
96-
97-
- v1.0.0 - Open Source Release
108+
* ... and many others.

0 commit comments

Comments
 (0)