Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 41.1
edited by lzehl
on 2021/03/09 17:55
Change comment: There is no comment for this version
To version 36.1
edited by lzehl
on 2021/03/08 22:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -18,7 +18,7 @@
18 18  === The openMINDS schema template syntax ===
19 19  
20 20  (% style="text-align: justify;" %)
21 -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##**.
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##**.
22 22  
23 23  (% style="text-align: justify;" %)
24 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 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).
... ... @@ -38,13 +38,13 @@
38 38  {{code language="json"}}
39 39  {
40 40   "properties": {
41 - "propertyNameA": {},
42 - "propertyNameB": {},
43 - "propertyNameC": {}
41 + "propertyNameA": {},
42 + "propertyNameB": {},
43 + "propertyNameC": {}
44 44   },
45 45   "required": [
46 - "propertyNameA",
47 - "propertyNameC"
46 + "propertyNameA",
47 + "propertyNameC"
48 48   ]
49 49  }
50 50  {{/code}}
... ... @@ -78,7 +78,6 @@
78 78  }
79 79  {{/code}}
80 80  
81 -(% style="text-align: justify;" %)
82 82  Note that this convention requires the concept and corresponding target templates to be located in the same openMINDS metadata model repository. Note also that for properties, the following rules apply for target and concept template: 
83 83  
84 84  1. A concept template has to define some properties which will be inherited by all extending target templates.
... ... @@ -86,28 +86,33 @@
86 86  1. A target template can require properties of the concept template, that are not explicitly required within the concept template. In such a case, the other target templates extending the same concept template will not require those properties.
87 87  1. A target template can (but does not have to) define and require additional properties that were not defined and required in the concept template. These additionally defined and required properties will not be shared with the other target templates extending the same concept template.
88 88  
89 -(% style="text-align: justify;" %)
90 90  How to define the expected value of a property will be explained for the different property types in the following sections.
91 91  
92 92  (% style="text-align: justify;" %)
93 -===== Defining expected values =====
91 +===== String properties =====
94 94  
95 95  (% style="text-align: justify;" %)
96 -The expected value of a property can be defined in large parts in the same way as in JSON-Schema, with some openMINDS syntax specific simplifications and modifications.
94 +(//**coming soon**//)
97 97  
98 98  (% style="text-align: justify;" %)
99 -On the first level, the **##"type"##** of the expected property value needs to be defined. In principle, the openMINDS template syntax supports the same value types as JSON-Schema Draft 7.0, meaning:
100 -+ **##"string"##**
101 -+ **##"number"##**
102 -+ **##"integer"##**
103 -+ **##"array"##**
104 -+ **##"boolean"##**
105 -+ **##"null"##**
106 -+ **##"object"##**
97 +===== Numerical properties =====
107 107  
108 -Also very similar to JSON-Schema, additional type-specific keys can be used to set further requirements for the expected value. H
99 +(% style="text-align: justify;" %)
100 +(//**coming soon**//)
109 109  
102 +(% style="text-align: justify;" %)
103 +===== Object properties =====
110 110  
105 +(% style="text-align: justify;" %)
106 +(//**coming soon**//)
107 +
108 +(% style="text-align: justify;" %)
109 +===== Property arrays =====
110 +
111 +(% style="text-align: justify;" %)
112 +(//**coming soon**//)
113 +
114 +
111 111  === The openMINDS integration pipeline ===
112 112  
113 113  (//**coming soon**//)
Public

openMINDS