Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 82.1
edited by lzehl
on 2021/07/05 12:13
Change comment: There is no comment for this version
To version 83.2
edited by lzehl
on 2021/07/05 13:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -56,19 +56,22 @@
56 56  === The openMINDS vocabulary ===
57 57  
58 58  (% style="text-align: justify;" %)
59 -Located under the folder **##vocab##** in the main branch of the central openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files ([[**##types.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/types.json||rel="noopener noreferrer" target="_blank"]] and [[**##properties.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/properties.json||rel="noopener noreferrer" target="_blank"]]). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing **schemas** and **properties** across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives. How this works in detail is explained in the following.
59 +Located under the folder **##vocab##** in the main branch of the central openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files ([[**##types.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/types.json||rel="noopener noreferrer" target="_blank"]] and [[**##properties.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/properties.json||rel="noopener noreferrer" target="_blank"]]). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing **schema types** and **properties** across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives. How this works in detail is explained in the following.
60 60  
61 61  (% style="text-align: justify;" %)
62 -The **##types.json##** file is an associative array listing all existing openMINDS schemas (via their type). For each openMINDS schema, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
62 +The **##types.json##** file is an associative array listing all existing openMINDS schema types. For each openMINDS schema type, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
63 63  
64 64  {{code language="json"}}
65 65  {
66 - "OPENMINDS_SCHEMA_TYPE": {
67 - "description": "GENERAL_DESCRIPTION",
68 - "label": "HUMAN-READABLE_LABEL",
69 - "name": "SIMPLIFIED_SCHEMA_TYPE",
66 + "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SCHEMA_NAME»": {
67 + "description": "«GENERAL_DESCRIPTION»",
68 + "label": "«HUMAN-READABLE_LABEL»",
69 + "name": "«SCHEMA_NAME»",
70 + "schemas": [
71 + "«METADATA_MODEL_LABEL»/«VERSION_BRANCH»/«SCHEMA_NAME»"
72 + ],
70 70   "translatableTo": [
71 - "REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE"
74 + "«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»"
72 72   ]
73 73   }
74 74  }
... ... @@ -75,20 +75,14 @@
75 75  {{/code}}
76 76  
77 77  (% style="text-align: justify;" %)
78 -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 **##"name"##** and **##"label"##** automatically derived from the respective schema type. 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" 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.
79 79  
80 -(% style="text-align: center;" %)
81 -**##"https:~/~/openminds.ebrains.eu/METADATA_MODEL_LABEL/SIMPLIFIED_SCHEMA_NAME"##**
82 -
83 83  (% style="text-align: justify;" %)
84 -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:
85 85  
86 -(% style="text-align: justify;" %)
87 -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:
88 -
89 89  {{code language="json"}}
90 90  {
91 - "PROPERTY_NAME": {
88 + "https://openminds.ebrains.eu/vocab/«PROPERTY_NAME": {
92 92   "description": "GENERAL_DESCRIPTION",
93 93   "name": "DISPLAY_LABEL",
94 94   "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
Public

openMINDS