@matdata/yasgui-utils 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +111 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
# YASGUI
|
|
2
|
+
|
|
3
|
+
YASGUI (Yet Another SPARQL GUI) is an advanced SPARQL client for querying and exploring RDF data. It provides a user-friendly interface for writing SPARQL queries, executing them against SPARQL endpoints, and visualizing the results in various formats.
|
|
4
|
+
|
|
5
|
+
Go to https://yasgui.matdata.eu/ and use it freely in production. Or fork this repo and extend it yourself. Contributions are certainly welcome!
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
|
|
9
|
+
- [Useful Links](#useful-links)
|
|
10
|
+
- [Features](#features)
|
|
11
|
+
- [Keyboard Shortcuts](#keyboard-shortcuts)
|
|
12
|
+
- [Query Editor (Yasqe)](#query-editor-yasqe)
|
|
13
|
+
- [Fullscreen Mode](#fullscreen-mode)
|
|
14
|
+
- [URI Explorer](#uri-explorer)
|
|
15
|
+
- [Prefix Management](#prefix-management)
|
|
16
|
+
- [Result Visualization Plugins (Yasr)](#result-visualization-plugins-yasr)
|
|
17
|
+
- [Installation](#installation)
|
|
18
|
+
- [npm](#npm)
|
|
19
|
+
- [Yarn](#yarn)
|
|
20
|
+
- [Local Development](#local-development)
|
|
21
|
+
- [License](#license)
|
|
22
|
+
|
|
23
|
+
## Useful Links
|
|
24
|
+
|
|
25
|
+
- Production environment: https://yasgui.matdata.eu/
|
|
26
|
+
- Dev environment: https://yasgui-dev.matdata.eu/
|
|
27
|
+
- User documentation: https://docs.triply.cc/yasgui/
|
|
28
|
+
- Developer documentation: https://docs.triply.cc/yasgui-api/
|
|
29
|
+
|
|
30
|
+
## Features
|
|
31
|
+
|
|
32
|
+
### Keyboard Shortcuts
|
|
33
|
+
|
|
34
|
+
#### Query Editor (Yasqe)
|
|
35
|
+
- **Ctrl+Enter** / **Cmd+Enter**: Execute the current query
|
|
36
|
+
- **Ctrl+Space**: Trigger autocomplete
|
|
37
|
+
- **Ctrl+S**: Save query to local storage
|
|
38
|
+
- **Shift+Ctrl+F**: Auto-format the query
|
|
39
|
+
- **Ctrl+/**: Comment/uncomment selected lines
|
|
40
|
+
- **Shift+Ctrl+D**: Duplicate the current line
|
|
41
|
+
- **Shift+Ctrl+K**: Delete the current line
|
|
42
|
+
- **Esc**: Remove focus from the editor
|
|
43
|
+
|
|
44
|
+
#### Fullscreen Mode
|
|
45
|
+
- **F11**: Toggle fullscreen mode for the query editor (Yasqe)
|
|
46
|
+
- **F10**: Toggle fullscreen mode for the results viewer (Yasr)
|
|
47
|
+
- **Ctrl+Shift+F**: Switch between Yasqe and Yasr fullscreen modes
|
|
48
|
+
|
|
49
|
+
#### URI Explorer
|
|
50
|
+
- **Ctrl+Click** on any URI in the query editor: Automatically executes a CONSTRUCT query to explore the clicked URI's connections (incoming and outgoing triples). The query runs in the background without modifying your current query in the editor.
|
|
51
|
+
|
|
52
|
+
### Prefix Management
|
|
53
|
+
- **PREFIX Button**: Insert saved prefix declarations into your query (replaces existing PREFIX lines at the beginning)
|
|
54
|
+
- **Settings Modal**: Access via the settings button (⚙) to manage:
|
|
55
|
+
- **Saved Prefixes**: Define reusable PREFIX declarations
|
|
56
|
+
- **Auto-capture**: Automatically captures new prefixes from your queries (enabled by default)
|
|
57
|
+
- **Request Configuration**: Configure HTTP request method, accept headers, arguments, headers, and named/default graphs
|
|
58
|
+
- **Default Prefixes**: Automatically includes `rdf:` and `rdfs:` prefixes for new users
|
|
59
|
+
- **Prefix Autocomplete**: When typing a prefix declaration (e.g., `PREFIX foaf:`), the editor automatically queries [prefix.cc](https://prefix.cc) to suggest and auto-complete the full URI commonly associated with that prefix. This helps you quickly add standard prefixes without needing to remember their full URIs.
|
|
60
|
+
|
|
61
|
+
### Result Visualization Plugins (Yasr)
|
|
62
|
+
|
|
63
|
+
Yasgui includes several built-in plugins to visualize SPARQL query results:
|
|
64
|
+
|
|
65
|
+
- **Table**: Interactive table view with sorting, filtering, pagination, and column resizing. Ideal for SELECT query results.
|
|
66
|
+
- **Boolean**: Displays boolean results (true/false) with visual indicators. Automatically used for ASK queries.
|
|
67
|
+
- **Response**: Raw response viewer with syntax highlighting and code folding. Shows the original response from the endpoint in JSON, XML, Turtle, or other formats.
|
|
68
|
+
- **Geo**: Geographic visualization plugin for displaying spatial data on interactive maps. Visualizes geospatial triples with coordinates. See [Yasgui Geo TG Plugin](https://github.com/Thib-G/yasgui-geo-tg) for more details.
|
|
69
|
+
- **Graph**: Visual graph representation of RDF data using nodes and edges. Ideal for CONSTRUCT/DESCRIBE query results. See [Yasgui Graph Plugin](https://github.com/Matdata-eu/yasgui-graph-plugin) for more details.
|
|
70
|
+
- **Error**: Displays error messages and diagnostics when queries fail, including CORS troubleshooting guidance.
|
|
71
|
+
|
|
72
|
+
Plugins are automatically selected based on the query type and response format. You can manually switch between available plugins using the view selector in the results pane.
|
|
73
|
+
|
|
74
|
+
## Installation
|
|
75
|
+
|
|
76
|
+
Below are instructions on how to include Yasgui in your project.
|
|
77
|
+
If you only want to install Yasr or Yasqe, replace yasgui in the commands below.
|
|
78
|
+
|
|
79
|
+
### npm
|
|
80
|
+
|
|
81
|
+
```sh
|
|
82
|
+
npm i @matdata/yasgui
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### Yarn
|
|
86
|
+
|
|
87
|
+
```sh
|
|
88
|
+
yarn add @matdata/yasgui
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Local Development
|
|
92
|
+
|
|
93
|
+
#### Installing dependencies
|
|
94
|
+
|
|
95
|
+
Run `npm install`.
|
|
96
|
+
|
|
97
|
+
#### Running Yasgui locally
|
|
98
|
+
|
|
99
|
+
To develop locally, run `npm run dev`
|
|
100
|
+
|
|
101
|
+
Go to `http://localhost:5173/demo` in your browser to see Yasgui in action.
|
|
102
|
+
|
|
103
|
+
#### Compiling Yasgui
|
|
104
|
+
|
|
105
|
+
Run `npm run build`. It'll store the transpiled js/css files in the `build` directory.
|
|
106
|
+
|
|
107
|
+
## License
|
|
108
|
+
|
|
109
|
+
This is a fork from [Zazuko](https://github.com/zazuko/Yasgui) who forked it from [Triply](https://github.com/TriplyDB/Yasgui).
|
|
110
|
+
|
|
111
|
+
This code is released under the MIT license.
|