From c3e85c587b1e51e8673faf3dc99475fe0d653a47 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Sun, 9 Jul 2023 21:12:21 -0400 Subject: [PATCH 1/3] add schema in appendix --- mkdocs.yml | 1 + src/appendices/schema.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+) create mode 100644 src/appendices/schema.md diff --git a/mkdocs.yml b/mkdocs.yml index 1a24697360..04c07297ac 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -26,6 +26,7 @@ nav: - Glossary: glossary.md - BIDS Extension Proposals: extensions.md - Appendix: + - Schema: appendices/schema.md - Contributors: appendices/contributors.md - Licenses: appendices/licenses.md - Entity table: appendices/entity-table.md diff --git a/src/appendices/schema.md b/src/appendices/schema.md new file mode 100644 index 0000000000..370e3f0ddd --- /dev/null +++ b/src/appendices/schema.md @@ -0,0 +1,16 @@ +# BIDS schema + +The BIDS specification exist as a schema. +The BIDS schema is a machine readable representation of the BIDS Standard written in . +It is (by and large) the BIDS Specification, but written in a declarative form. + +The BIDS schema is available in two machine readable formats: + +- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specifiation repository](https://github.com/bids-standard/bids-specification/src/schema) +- as a [single json file](https://bids-specification.readthedocs.io/en/stable/schema.json) + +A light-weight introduction to the schema can be found [here](https://bids-extensions.readthedocs.io/en/latest/schema/). + +A full description of the schema can be found on this [website](https://bidsschematools.readthedocs.io/en/latest/?badge=latest) +where you will also find the documentation for the python package +to interact with the schema, [bidsschematools](https://pypi.org/project/bidsschematools/). From f7e3b4de06c579a9b02d0438a2dc995354b8a3ef Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 14 Jul 2023 01:11:54 +0200 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Chris Markiewicz Co-authored-by: Nell Hardcastle --- src/appendices/schema.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/src/appendices/schema.md b/src/appendices/schema.md index 370e3f0ddd..5c3ec41660 100644 --- a/src/appendices/schema.md +++ b/src/appendices/schema.md @@ -1,16 +1,19 @@ # BIDS schema -The BIDS specification exist as a schema. -The BIDS schema is a machine readable representation of the BIDS Standard written in . -It is (by and large) the BIDS Specification, but written in a declarative form. +The BIDS schema is a machine readable representation of the BIDS standard, +written in a custom YAML format. +The goal of the schema is to provide a single source for rendering the specification +and validating BIDS datasets, reducing the scope for inconsistencies. +Third party tools may also use the schema to write code that will adapt to additions +to the BIDS standard. The BIDS schema is available in two machine readable formats: -- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specifiation repository](https://github.com/bids-standard/bids-specification/src/schema) -- as a [single json file](https://bids-specification.readthedocs.io/en/stable/schema.json) +- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specification repository](https://github.com/bids-standard/bids-specification/src/schema) +- as a [single dereferenced json file](https://bids-specification.readthedocs.io/en/stable/schema.json) -A light-weight introduction to the schema can be found [here](https://bids-extensions.readthedocs.io/en/latest/schema/). - -A full description of the schema can be found on this [website](https://bidsschematools.readthedocs.io/en/latest/?badge=latest) -where you will also find the documentation for the python package -to interact with the schema, [bidsschematools](https://pypi.org/project/bidsschematools/). +A didactic walkthrough of the schema can be found in the [BEP Guide](https://bids-extensions.readthedocs.io/en/latest/schema/), +and a complete description is available in the [`bidsschematools` documentation](https://bidsschematools.readthedocs.io/en/latest/). +[`bidsschematools`](https://pypi.org/project/bidsschematools/) is a Python package sourced +from the specification repository, and includes the necessary code to render the specification +and filename validation. From 6de341bbd637dcbd2c9c8ae39f21ff481be9dbf4 Mon Sep 17 00:00:00 2001 From: Stefan Appelhoff Date: Thu, 20 Jul 2023 15:56:37 +0200 Subject: [PATCH 3/3] fix remark --- src/appendices/schema.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/appendices/schema.md b/src/appendices/schema.md index 5c3ec41660..1616a6d5c9 100644 --- a/src/appendices/schema.md +++ b/src/appendices/schema.md @@ -9,8 +9,8 @@ to the BIDS standard. The BIDS schema is available in two machine readable formats: -- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specification repository](https://github.com/bids-standard/bids-specification/src/schema) -- as a [single dereferenced json file](https://bids-specification.readthedocs.io/en/stable/schema.json) +- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specification repository](https://github.com/bids-standard/bids-specification/src/schema) +- as a [single dereferenced json file](https://bids-specification.readthedocs.io/en/stable/schema.json) A didactic walkthrough of the schema can be found in the [BEP Guide](https://bids-extensions.readthedocs.io/en/latest/schema/), and a complete description is available in the [`bidsschematools` documentation](https://bidsschematools.readthedocs.io/en/latest/).