Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57

From version 63.1
edited by lzehl
on 2021/06/24 12:53
Change comment: There is no comment for this version
To version 60.1
edited by lzehl
on 2021/06/23 15:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -114,29 +114,17 @@
114 114  All openMINDS metadata models use a light-weighted schema template syntax for defining the expected metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**.
115 115  
116 116  (% style="text-align: justify;" %)
117 -Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects making the openMINDS schemas more human-readable, especially for untrained eyes. Behind the scenes, within the openMINDS integration pipeline (cf. below), this schema template syntax is then interpreted and flexibly translated to various formal metadata formats (e.g., JSON-Schema).
117 +Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects that are generally expected for the openMINDS schemas making them more human-readable, especially for untrained eyes. Behind the scenes, within the openMINDS integration pipeline (cf. below), this schema template syntax is then interpreted and flexibly translated to various formal metadata formats (e.g., JSON-Schema).
118 118  
119 119  (% style="text-align: justify;" %)
120 -Despite the simplification in comparison to JSON-Schema, the openMINDS schema templates are also, at the core, specially formatted JSON files using a particular syntax, meaning special key-value pairs that define the validation rules of a schema. Please find in the following a full documentation of the openMINDS schema template syntax and how it's key-value pairs need to be defined and interpreted.
120 +Despite the simplification in comparison to JSON-Schema, the openMINDS schema templates are also, at the core, specially formatted JSON files using a particular syntax, meaning special key-value pairs that define the validation rules of a schema.
121 121  
122 122  (% style="text-align: justify;" %)
123 -For the more inexperienced programmers, let's start by explaining first some general terms that will be later used in the openMINDS schema template syntax specification. More experienced programmers can of course skip these explanations and jump directly further down.
123 +Please find in the following a full documentation of the openMINDS schema template syntax and how it's key-value pairs need to be defined and interpreted.
124 124  
125 -**What is a string, an integer, a float or a boolean?**
125 +(% style="text-align: justify;" %)
126 +(//**coming soon**//)
126 126  
127 -**What is a key-value pair?**
128 -
129 -**What is a list?**
130 -
131 -**What is a dictionary?**
132 -
133 -**What is a JSON?**
134 -
135 -
136 -
137 -
138 138  === The openMINDS integration pipeline ===
139 139  
140 -(//**coming soon**//) If you'd like to learn more about the openMINDS integration pipeline, especially if you'd like to contribute to it, please get in touch with us (the openMINDS development team) via the issues on the openMINDS or openMINDS_generator GitHub or the support email: openminds@ebrains.eu
141 -
142 -{{putFootnotes/}}
130 +(//**coming soon**//)
Public

openMINDS