Changes for page Technical details

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

From version 13.1
edited by lzehl
on 2021/03/08 19:50
Change comment: There is no comment for this version
To version 7.1
edited by lzehl
on 2021/02/26 19:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -7,33 +7,17 @@
7 7  In parallel, openMINDS tries to consider the various programming skills present in the neuroscience research community. For this reason, openMINDS established an integration pipeline which gradually increases the level of technical detail: starting from a user-friendly, lightweight schema template and ending with established, highly technical metadata schema formats (e.g., JSON-Schema).
8 8  
9 9  (% style="text-align: justify;" %)
10 -Please find below a documentation of the layout and requirements needed to keep the openMINDS modularity, the syntax of the openMINDS schema template, as well as the openMINDS integration pipeline.
10 +Please find below a documentation of the layout and requirements needed to keep the openMINDS modularity, the openMINDS integration pipeline, as well as the openMINDS schema template.
11 11  )))
12 12  
13 13  === Overview of the openMINDS layout ===
14 14  
15 -(% style="text-align: justify;" %)
16 -In summary, openMINDS is the overall umbrella for a set of distributed GitHub repositories, each defining a particular metadata model for neuroscience research products.
15 +(//**coming soon**//)
17 17  
18 18  === The openMINDS schema template syntax ===
19 19  
20 -(% style="text-align: justify;" %)
21 -All openMINDS metadata models use a light-weighted schema template syntax for defining the metadata. The correspondingly formatted schema files use the extension: **##.schema.tpl.json##**.
19 +(//**coming soon**//)
22 22  
23 -(% style="text-align: justify;" %)
24 -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 it more human-readable, especially for untrained eyes.
25 -
26 -(% style="text-align: justify;" %)
27 -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). Please find in the following a full documentation of the openMINDS schema template syntax and how it needs to be interpreted.
28 -
29 -(% style="text-align: justify;" %)
30 -===== **##"_type"##** =====
31 -
32 -The **##"_type"##** is used to define the type and with that the namespace of a corresponding schema using the following convention:
33 -**##{{code}}"_type": "https://openminds.ebrains.eu/<<schema-model>>/<<schema-name>>"{{/code}}##**
34 -where **##<<schema-model>>##** has to be replaced with the label of the openMINDS metadata model the corresponding schema belongs to and **##<<schema-name>>##** exchanged with the label of that schema.
35 -
36 -
37 37  === The openMINDS integration pipeline ===
38 38  
39 39  (//**coming soon**//)
Public

openMINDS