Skip to content

Commit f518eca

Browse files
committed
Start on web guide (still need to show results)
1 parent a7332bc commit f518eca

File tree

5 files changed

+49
-0
lines changed

5 files changed

+49
-0
lines changed
45.9 KB
Loading
46.3 KB
Loading
43.5 KB
Loading
44.6 KB
Loading

docs/user_guide/web.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
11
# Using the web validator
2+
3+
The web validator is the primary interface to the validator,
4+
hosted at <https://bids-standard.github.io/bids-validator/>
5+
6+
![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
7+
(Dark theme)](../_static/web_entrypoint_dark.png){.only-dark .no-scaled-link width="50%" align=center}
8+
![The web interface to the BIDS Validator with the "Select Dataset Files" button highlighted.
9+
(Light theme)](../_static/web_entrypoint_light.png){.only-light .no-scaled-link width="50%" align=center}
10+
11+
To validate a dataset, click the "Select Dataset Files" and select a directory to validate.
12+
The directory must contain a `dataset_description.json` to be identified as a BIDS dataset.
13+
14+
When you select a directory, you will get a permission prompt,
15+
verifying that you want to provide access to the directory.
16+
17+
::::{tab-set}
18+
19+
:::{tab-item} Firefox permission prompt
20+
21+
![The Firefox permissions prompt (Dark theme)](../_static/firefox_permissions_dark.png){.only-dark width="50%" align=center}
22+
![The Firefox permissions prompt (Light theme)](../_static/firefox_permissions_light.png){.only-light width="50%" align=center}
23+
24+
:::
25+
:::{tab-item} Chrome permission prompt
26+
:sync: install
27+
28+
![The Chromium permissions notice (Dark theme)](../_static/chromium_permissions_dark.png){.only-dark width="50%" align=center}
29+
![The Chromium permissions notice (Light theme)](../_static/chromium_permissions_light.png){.only-light width="50%" align=center}
30+
31+
:::
32+
::::
33+
34+
At present (November 2024), Firefox browsers present the request to "Upload" data,
35+
while Chromium-based browsers (Google Chrome, Microsoft Edge, and others) request permission
36+
to "view files".
37+
In both cases, confirming allows the Javascript application to read the files and perform validation,
38+
but those files are never sent to a remote server.
39+
40+
## The Legacy Validator
41+
42+
The current BIDS Validator is a complete rewrite of the original BIDS Validator,
43+
based on the [BIDS Schema].
44+
The original validator, now called the "legacy validator", can be found at
45+
<https://bids-standard.github.io/legacy-validator/>.
46+
47+
It is not recommended to use this validator, as it will become increasingly out-of-date,
48+
but it may be useful for comparative purposes.
49+
50+
[BIDS Schema]: https://bidsschematools.readthedocs.io

0 commit comments

Comments
 (0)