You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit b03dc61
Browse filesBrowse the repository at this point in the historyBrowse files
feat(yasgui): add a "How MatGUI works" quick start tour
Five pages with three items each, a small illustration and a short
explanation. Opens on the first visit (remembered in local storage),
stays available from the help menu and the Ctrl+K search, and links to
the user guide. Embedders can set showQuickStart: false, or
quickStartOnFirstVisit: false to only offer it in the help menu.
"How MatGUI works": a quick start tour of five pages, each with three things to know and a small illustration, opens the first time someone uses MatGUI and stays available from the help menu and the Ctrl+K search. It links to the full user guide. Embedders can leave it out with `showQuickStart: false`, or keep it in the help menu only with `quickStartOnFirstVisit: false`.
-[Running Matgui with Docker](#running-matgui-with-docker)
18
19
-[Your First Query](#your-first-query)
19
20
-[Saving Your Work](#saving-your-work)
@@ -149,6 +150,20 @@ This excellent resource covers:
149
150
150
151
Matgui is available at: **[https://matgui.matdata.eu/](https://matgui.matdata.eu/)**
151
152
153
+
### Quick Start Tour
154
+
155
+
The first time you open MatGUI in a browser, **How MatGUI works** shows you around in five short pages, with three things to know on each:
156
+
157
+
1.**Write and run a query**: pick an endpoint, write with autocomplete, run with `Ctrl+Enter`
158
+
2.**Explore the results**: switch views, describe a resource, download the results
159
+
3.**Keep your queries**: work in tabs, save to a workspace, share a link
160
+
4.**Let MatGUI help**: insert snippets, look at the endpoint, ask the AI assistant (or hover an IRI, when the site has no AI assistant)
161
+
5.**Find your way**: search everything with `Ctrl+K`, open the side panel with `Ctrl+B`, switch the theme and open the settings
162
+
163
+
Click **Next** and **Back**, the dots at the bottom, or use the `←` and `→` keys to move between the pages. **Read the full user guide** opens this guide. Close the tour with **Skip**, **Start querying** on the last page, the × or `Esc`. MatGUI remembers in your browser that you saw it and doesn't open it again by itself.
164
+
165
+
To see it again, click **Help** (?) in the top bar and pick **How MatGUI works**, or search for it with `Ctrl+K`. Sites that embed MatGUI can leave the tour out, or keep it in the help menu without opening it on the first visit.
166
+
152
167
### Running Matgui with Docker
153
168
154
169
You can run Matgui locally using Docker, which is especially useful when working with local SPARQL endpoints.
@@ -352,7 +367,7 @@ From left to right:
352
367
-**MatGUI**: the name of the application (sites that embed MatGUI can hide it)
353
368
-**Query tabs**: one tab per query. The active tab is raised. Tabs that hold a saved (managed) query show a small dot before their name; the dot turns amber when the query has unsaved changes. Hover a tab to show its close button (×), click **+** to add a tab
354
369
-**Search queries and commands** (`Ctrl+K`, or `⌘K` on a Mac): see [Search](#search)
355
-
-**Help** (?): opens the MatGUI user guide in a new browser tab
370
+
-**Help** (?): opens a menu with **How MatGUI works** (the [quick start tour](#quick-start-tour)) and **Documentation**, the MatGUI user guide in a new browser tab
356
371
-**Theme** (sun / moon): switches between the light and dark theme
357
372
-**Settings** (gear): opens the settings of the active tab
358
373
@@ -362,7 +377,7 @@ Click **Search queries and commands** in the top bar, or press `Ctrl+K` (`⌘K`
362
377
363
378
-**Queries**: the saved queries of all your workspaces, with the workspace and folder they are in. Pick one to open it in a new tab, or to go to the tab that already has it open
364
379
-**Snippets**: the code snippets of the [Insert menu](#insert-menu), found by name, group or the code they write (`filter` finds the comparison snippets). Pick one to insert it at the cursor
365
-
-**Commands**: Run query, New tab, Insert snippet, Insert PREFIX declarations, Switch endpoint, Explore endpoint, Show saved queries, Toggle side panel, Toggle side-by-side layout, Format, Share, Save, Download, full screen editor, dark mode and the documentation. Commands with a shortcut show it at the right
380
+
-**Commands**: Run query, New tab, Insert snippet, Insert PREFIX declarations, Switch endpoint, Explore endpoint, Show saved queries, Toggle side panel, Toggle side-by-side layout, Format, Share, Save, Download, full screen editor, dark mode, How MatGUI works and the documentation. Commands with a shortcut show it at the right
366
381
-**Settings**: every page of the settings (General, SPARQL endpoints, Workspaces, Prefixes, Editor, AI, Import / export, Keyboard shortcuts, About), for example type `prefixes` and pick **Settings: Prefixes**
367
382
368
383
Type `>` first to search commands and settings only. Snippets and settings show up once you type something. Use `↑` and `↓` to move, `Enter` to open and `Esc` to close.
0 commit comments