Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 83.1
edited by lzehl
on 2021/07/05 12:21
Change comment: There is no comment for this version
To version 85.2
edited by lzehl
on 2021/07/05 13:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -63,12 +63,12 @@
63 63  
64 64  {{code language="json"}}
65 65  {
66 - "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SIMPLIFIED_SCHEMA_NAME»": {
66 + "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SCHEMA_NAME»": {
67 67   "description": "«GENERAL_DESCRIPTION»",
68 68   "label": "«HUMAN-READABLE_LABEL»",
69 - "name": "«SIMPLIFIED_SCHEMA_TYPE»",
69 + "name": "«SCHEMA_NAME»",
70 70   "schemas": [
71 - "«METADATA_MODEL_LABEL»/«VERSION_BRANCH»/«SIMPLIFIED_SCHEMA_TYPE»"
71 + "«RELATIVE_PATH_TO_SCHEMA_FILE_OF_THAT_TYPE»"
72 72   ],
73 73   "translatableTo": [
74 74   "«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»"
... ... @@ -78,28 +78,23 @@
78 78  {{/code}}
79 79  
80 80  (% style="text-align: justify;" %)
81 -With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the "name" and "label" automatically derived from the respective schema type, because it has a consistent naming convention:
81 +With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the values for **##"name"##**, **##"label"##**, and **##"schemas"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived **##"label"##** value can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
82 82  
83 -(% style="text-align: center;" %)
84 -**##"https:~/~/openminds.ebrains.eu/METADATA_MODEL_LABEL/SIMPLIFIED_SCHEMA_NAME"##**
85 -
86 86  (% style="text-align: justify;" %)
87 -The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. Once an entry for a schema is made in the **##types.json##** file, the values of attributes (**##"label"##**, **##"description"##**, and **##"translatableTo"##**) can be manually edited. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
84 +Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas. For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
88 88  
89 -(% style="text-align: justify;" %)
90 -Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas (via the property name). For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
91 -
92 92  {{code language="json"}}
93 93  {
94 - "PROPERTY_NAME": {
95 - "description": "GENERAL_DESCRIPTION",
96 - "name": "DISPLAY_LABEL",
97 - "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
88 + "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME»": {
89 + "description": "«GENERAL_DESCRIPTION",
90 + "label": "«HUMAN-READABLE_LABEL",
91 + "labelForReverseLink": "«HUMAN-READABLE_LABEL_OF_REVERSED_LINK",
92 + "name": "«PROPERTY_NAME»",
98 98   "sameAs": [
99 - "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
94 + "«REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
100 100   ],
101 101   "schemas": [
102 - "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY"
97 + "«RELATIVE_PATH_TO_SCHEMA_FILE_CONTAINING_THIS_PROPERTY»"
103 103   ]
104 104   }
105 105  }
... ... @@ -106,7 +106,7 @@
106 106  {{/code}}
107 107  
108 108  (% style="text-align: justify;" %)
109 -With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the display label and list of schemas in which this property occurs automatically derived. The remaining attributes are initially provided with a null value. Once an entry for a property is made in the **##properties.json##** file, the values of all attributes (**##"name"##**, **##"description"##**, **##"nameForReversedLink"##**, and **##"sameAs"##**) can be manually edited, except for **##"schemas"##** which will be always automatically updated. All those manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
104 +With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the **##"name"##**, **##"label"##** and **##"labelForReversedLink"##** automatically derived. The remaining attributes are predefined with a null value and frequently, manually edited by a corresponding expert of the openMINDS development team. If necessary the auto-derived values for **##"label"##** and **##"labelForReversedLink"##** can be edited as well. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
110 110  
111 111  === The openMINDS syntax ===
112 112  
... ... @@ -129,6 +129,7 @@
129 129   "PROPERTY_NAME": {
130 130   "type": "DATA_TYPE",
131 131   "_instruction": "METADATA_ENTRY_INSTRUCTION"
127 + }
132 132   },
133 133   "required": [
134 134   "PROPERTY_NAME"
... ... @@ -167,8 +167,26 @@
167 167  Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
168 168  
169 169  (% style="text-align: justify;" %)
170 -If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined.
166 +If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined. Here a conceptual example for all possible constraints:
171 171  
168 +{{code language="json"}}
169 +{
170 + "_type": "https://openminds.ebrains.eu/LABEL_OF_METADATA_MODEL/SCHEMA_NAME",
171 + "properties": {
172 + "stringProperty_noConstraints": {
173 + "type": "string",
174 + "_instruction": "Enter a free text."
175 + },
176 + "stringProperty_lengthConstraints": {
177 + "maxLength": 6
178 + "minLength": 2,
179 + "type": "string",
180 + "_instruction": "Enter a free text (allowed numbers of characters: 2 - 6)."
181 + }
182 + }
183 +}
184 +{{/code}}
185 +
172 172  === The openMINDS integration pipeline ===
173 173  
174 174  (//**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
Public

openMINDS