Skip to content

Commit 9777605

Browse files
candleindarkyarikoptic
authored andcommitted
style: use top-to-bottom orientation and hierarchical layout
This adjustment will allow items in the mermaid diagram to appear bigger in the webpage because the page is more limited in the horizontal dimension. Additionally, the syntax of the mermaid diagram has been updated to the latest syntax, e.g. `flowchart` instead of `graph`. The intents of the lines in the diagram are those recommended/defaulted by the mermaid live editor at https://www.mermaidchart.com
1 parent e99fd81 commit 9777605

File tree

1 file changed

+65
-59
lines changed

1 file changed

+65
-59
lines changed

docs/standards/index.md

Lines changed: 65 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -16,64 +16,70 @@ You can find further information for:
1616
The following figure shows the relationship between the BIDS specification, validator implementations, and the BIDS schema:
1717

1818
```mermaid
19-
graph LR;
20-
subgraph bids-specification-repo["<a href=https://github.com/bids-standard/bids-specification>bids-standard/bids-specification</a>"];
21-
markdown
22-
schema -.is interpreted by.-> bidsschematools
23-
end
24-
25-
markdown --is interpreted by--> mkdocs
26-
bidsschematools --provides MACROS for--> mkdocs
27-
mkdocs --renders HTML--> specification
28-
29-
schema --is instance of-->bids-schema
30-
bids-schema -.is implemented by.->deno & bidsschematools
31-
bids-schema -.is reflected in.-> metaschema.json
32-
schema.json --is instance of-->bids-schema
33-
34-
subgraph bids.neuroimaging.io["<a href=https://bids.neuroimaging.io>bids.neuroimaging.io</a>"]
35-
subgraph bids-specification-website["<a href=https://bids-specification.readthedocs.io>bids-specification.readthedocs.io</a>"];
36-
specification
37-
bidsschematools --compiles YAMLs as--> schema.json
38-
end
39-
subgraph stats-models["<a href=https://bids-standard.github.io/stats-models/>stats-models standard</a>"]
40-
end
41-
subgraph bids-apps["<a href=https://bids-standard.github.io/execution-spec/>bids-apps standard</a>"]
42-
end
43-
end
44-
45-
subgraph "legacy-validator @ v1.15.1";
46-
regex["filename patterns"] --> Node.js
47-
Node.js --> web1["<a href=https://bids-standard.github.io/legacy-validator/>web</a>"]
48-
Node.js --> cli1[cli]
49-
end
50-
subgraph "bids-validator ≥ v2.0";
51-
deno --> web["<a href=https://bids-standard.github.io/bids-validator/>web</a>"]
52-
deno --> cli
53-
end
54-
subgraph "python-validator ≥ v1.14.7";
55-
python
56-
python --> library
57-
python --> cli3[cli]
58-
end
59-
60-
bids-schema -.is implemented by.->python
61-
19+
---
20+
config:
21+
layout: dagre
22+
---
23+
flowchart TB
24+
subgraph bids-specification-repo["<a href=https://github.com/bids-standard/bids-specification>bids-standard/bids-specification</a>"]
25+
markdown@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.10.0/src'>src/</a><br>markdown" }
26+
bidsschematools@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.10.0/tools/schemacode'>tools/schemacode/</a><br/>bidsschematools" }
27+
schema@{ label: "<a href='https://github.com/bids-standard/bids-specification/tree/v1.10.0/src/schema'>src/schema/</a><br>YAMLs" }
28+
end
29+
subgraph s2["<a href=https://bids-specification.readthedocs.io>bids-specification.readthedocs.io</a>"]
30+
specification["specification html"]
31+
schema.json@{ label: "<a href='https://bids-specification.readthedocs.io/en/v1.10.0/schema.json'>schema.json</a>" }
32+
end
33+
subgraph s3["<a href=https://bids-standard.github.io/stats-models/>stats-models standard</a>"]
34+
end
35+
subgraph s4["<a href=https://bids-standard.github.io/execution-spec/>bids-apps standard</a>"]
36+
end
37+
subgraph s5["<a href=https://bids.neuroimaging.io>bids.neuroimaging.io</a>"]
38+
s2
39+
s3
40+
s4
41+
end
42+
subgraph subGraph5["legacy-validator @ v1.15.1"]
43+
Node.js["Node.js"]
44+
regex["filename patterns"]
45+
web1@{ label: "<a href=\"https://bids-standard.github.io/legacy-validator/\">web</a>" }
46+
cli1["cli"]
47+
end
48+
subgraph subGraph6["bids-validator ≥ v2.0"]
49+
web@{ label: "<a href=\"https://bids-standard.github.io/bids-validator/\">web</a>" }
50+
deno["deno"]
51+
cli["cli"]
52+
end
53+
subgraph subGraph7["python-validator ≥ v1.14.7"]
54+
python["python"]
55+
library["library"]
56+
cli3["cli"]
57+
end
58+
schema -. is interpreted by .-> bidsschematools
59+
markdown -- is interpreted by --> mkdocs@{ label: "<a href=''>mkdocs</a>" }
60+
bidsschematools -- provides MACROS for --> mkdocs
61+
mkdocs -- renders HTML --> specification
62+
schema -- is instance of --> bids-schema["<a href=https://bids-website.readthedocs.io/en/latest/standards/schema/index.html>BIDS Schema</a>"]
63+
bids-schema -. is implemented by .-> deno & bidsschematools & python
64+
bids-schema -. is reflected in .-> metaschema.json@{ label: "<a href='https://github.com/bids-standard/bids-specification/blob/master/src/metaschema.json'>metaschema.json</a><br/>JSON Schema" }
65+
schema.json -- is instance of --> bids-schema & metaschema.json
66+
bidsschematools -- compiles YAMLs as --> schema.json
67+
regex --> Node.js
68+
Node.js --> web1 & cli1
69+
deno --> web & cli
70+
python --> library & cli3
6271
specification -. is interpreted by .-> regex
63-
schema.json -.is interpreted by.-> deno
64-
schema.json --is instance of-->metaschema.json
65-
bidsschematools --is used by--> python
66-
67-
markdown@{label: "<a href="https://github.com/bids-standard/bids-specification/tree/v1.10.0/src">src/</a><br>markdown", shape: docs}
68-
schema@{label: "<a href="https://github.com/bids-standard/bids-specification/tree/v1.10.0/src/schema">src/schema/</a><br>YAMLs", shape: docs}
69-
mkdocs@{label: "<a href="">mkdocs</a>", shape: proc}
70-
bidsschematools@{label: "<a href="https://github.com/bids-standard/bids-specification/tree/v1.10.0/tools/schemacode">tools/schemacode/</a><br/>bidsschematools", shape: proc}
71-
schema.json@{label: "<a href="https://bids-specification.readthedocs.io/en/v1.10.0/schema.json">schema.json</a>", shape: doc}
72-
metaschema.json@{label: "<a href="https://github.com/bids-standard/bids-specification/blob/master/src/metaschema.json">metaschema.json</a><br/>JSON Schema", shape: doc}
73-
bids-specification-repo@{label: "<a href='xxx'>bids-specification@github</a>"}
74-
specification@{label: specification html}
75-
bids-schema@{label: "<a href=https://bids-website.readthedocs.io/en/latest/standards/schema/index.html>BIDS Schema</a>"}
76-
Node.js@{shape: subproc}
77-
python@{shape: subproc}
78-
deno@{shape: subproc}
72+
schema.json -. is interpreted by .-> deno
73+
bidsschematools -- is used by --> python
74+
markdown@{ shape: docs}
75+
schema@{ shape: docs}
76+
bidsschematools@{ shape: proc}
77+
mkdocs@{ shape: proc}
78+
deno@{ shape: subproc}
79+
metaschema.json@{ shape: doc}
80+
schema.json@{ shape: doc}
81+
Node.js@{ shape: subproc}
82+
web1@{ shape: rect}
83+
web@{ shape: rect}
84+
python@{ shape: subproc}
7985
```

0 commit comments

Comments
 (0)