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
-
... ... @@ -63,12 +63,12 @@ 63 63 64 64 {{code language="json"}} 65 65 { 66 - "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SCHEMA_NAME»": { 66 + "https://openminds.ebrains.eu/«METADATA_MODEL_LABEL»/«SIMPLIFIED_SCHEMA_NAME»": { 67 67 "description": "«GENERAL_DESCRIPTION»", 68 68 "label": "«HUMAN-READABLE_LABEL»", 69 - "name": "«SCHEMA_ NAME»",69 + "name": "«SIMPLIFIED_SCHEMA_TYPE»", 70 70 "schemas": [ 71 - "« RELATIVE_PATH_TO_SCHEMA_FILE_OF_THAT_TYPE»"71 + "«METADATA_MODEL_LABEL»/«VERSION_BRANCH»/«SIMPLIFIED_SCHEMA_TYPE»" 72 72 ], 73 73 "translatableTo": [ 74 74 "«REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE»" ... ... @@ -78,23 +78,28 @@ 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 values for **##"name"##**,**##"label"##**,and **##"schemas"##** automatically derived.Theremainingattributesareredefinedwitha null valueand frequently,manuallyedited bya correspondingexpertof the openMINDS development team. If necessary the auto-derived "label" valuecan be edited as well. All manual editionswill bepreserved and not overwrittenwhen the file isupdatedagain with a newcommit. Incase a schemaisdeleted fromtheopenMINDS metadatamodels, the correspondingentry in the **##types.json##** file is marked as being deprecated (additional attribute-valuepair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.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: 82 82 83 +(% style="text-align: center;" %) 84 +**##"https:~/~/openminds.ebrains.eu/METADATA_MODEL_LABEL/SIMPLIFIED_SCHEMA_NAME"##** 85 + 83 83 (% style="text-align: justify;" %) 84 - Similar to the **##types.json##** file, the **##properties.json##**file isan associative array listingall properties acrossallexistingopenMINDSschemas.Foreach openMINDSproperty,asmalllistofgeneral attributesare providedin a nestedassociativearray. Currently, thefollowing attributes are captured: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. 85 85 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 + 86 86 {{code language="json"}} 87 87 { 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»", 94 + "PROPERTY_NAME": { 95 + "description": "GENERAL_DESCRIPTION", 96 + "name": "DISPLAY_LABEL", 97 + "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK", 93 93 "sameAs": [ 94 - " «REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"99 + "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE" 95 95 ], 96 96 "schemas": [ 97 - " «RELATIVE_PATH_TO_SCHEMA_FILE_CONTAINING_THIS_PROPERTY»"102 + "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY" 98 98 ] 99 99 } 100 100 } ... ... @@ -101,7 +101,7 @@ 101 101 {{/code}} 102 102 103 103 (% style="text-align: justify;" %) 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 valueand frequently,manuallyedited bya corresponding expertoftheopenMINDSdevelopmentteam.Ifnecessarytheauto-derived valuesfor"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.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. 105 105 106 106 === The openMINDS syntax === 107 107