Changes for page Technical details
Last modified by lzehl on 2021/07/05 18:57
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -111,18 +111,20 @@ 111 111 === The openMINDS schema template syntax === 112 112 113 113 (% style="text-align: justify;" %) 114 -All openMINDS metadata models use a light-weighted schema template syntax for defining the expected metadata. Although this schematemplate syntax is inspired by JSON-Schema, itoutsourcesmost schema technicalities to be handledinthe openMINDS integration pipeline,makingtheopenMINDSschemasmore human-readable, especiallyforuntrainedeyes. Within theopenMINDS integrationpipeline (cf.below), theschemaemplatesyntax is interpreted, extended and flexibly translated tovarious formal metadata formats (e.g., JSON-Schema).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 - Please findin thefollowinga full documentationofthe openMINDS schema template syntax specifications.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 -==== Specifications ==== 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. 120 120 121 -All openMINDS schemas are human and machine-readable text files with the extension **##.schema.tpl.json##** which define the structure and content of correctly instantiated openMINDS metadata instances. Many features are adopted from JSON-Schema. According to the schema template syntax each schema is defined as a nested associative array (dictionary). 122 +(% style="text-align: justify;" %) 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. 122 122 125 +(% style="text-align: justify;" %) 126 +(//**coming soon**//) 123 123 124 124 === The openMINDS integration pipeline === 125 125 126 -(//**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 127 - 128 -{{putFootnotes/}} 130 +(//**coming soon**//)