Changes for page Technical details

Last modified by lzehl on 2021/07/05 18:57
From version 64.1
edited by lzehl
on 2021/06/24 15:34
Change comment: There is no comment for this version
To version 57.1
edited by lzehl
on 2021/06/23 14:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -60,13 +60,13 @@
60 60  Through the integration pipeline of the openMINDS generator, the openMINDS vocabulary is automatically gathered and stored in the main openMINDS GitHub in order to centrally maintain general definitions and references for **types** and **properties** used in schemas across all openMINDS repositories. How this works is explained in the following.
61 61  
62 62  (% style="text-align: justify;" %)
63 -Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##**:
63 +Schema types and properties are stored in dedicated JSON files (**##types.json##** and **##properties.json##**) under the folder **##vocab##** located in the main openMINDS GitHub directory. Each schema type and property occurring in the openMINDS metadata models is automatically represented in those files as nested dictionaries. Here a cutout of the **##types.json##** and **##properties.json##**:
64 64  
65 65  {{code language="json"}}
66 66  {
67 67   ...,
68 68   "https://openminds.ebrains.eu/core/Person": {
69 - "description": "Structured information on a person (alive or dead).",
69 + "description": "Structured information on a person.",
70 70   "name": "Person",
71 71   "translatableTo": [
72 72   "https://schema.org/Person"
... ... @@ -76,8 +76,6 @@
76 76  }
77 77  {{/code}}
78 78  
79 -... and a cutout of the **##properties.json##**:
80 -
81 81  {{code language="json"}}
82 82  {
83 83   ...,
... ... @@ -97,12 +97,9 @@
97 97  {{/code}}
98 98  
99 99  (% style="text-align: justify;" %)
100 -The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence (cf. **##"schemas"##** in **##properties.json##**), their general description (cf. **##"description"##** in **##types.json##** and **##properties.json##**), and possible references to related or matching schema types (cf. **##"translatableTo"##** in **##types.json##**) and properties (cf. **##""sameAs""##** in **##properties.json##**) of other metadata initiatives (e.g., schema.org).
98 +The keywords of those nested dictionaries are pre-defined to consistently capture for all schema types and properties their namespace, their occurrence, their general description, and possible references to related or matching schema types and properties of other metadata initiatives (e.g., schema.org). This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (e.g., the namespace and occurrence) and others to be manually editable later on (e.g., the general description and references).
101 101  
102 102  (% style="text-align: justify;" %)
103 -This setup also allows us to define some values/entries to be automatically filled in by the openMINDS integration pipeline with each commit to one of the openMINDS repositories (**##"name"##**, **##"schemas"##**) and others to be manually editable later on (**##"description"##**, **##"translatableTo"##**, **##"sameAs"##**, **##"nameForReverseLink"##**).
104 -
105 -(% style="text-align: justify;" %)
106 106  For security, outdated entries in those openMINDS vocabulary files (e.g., because the namespace of the schema type or property changed or the schema type or property was deleted) are not automatically deleted, but kept and marked as being deprecated. After evaluation, deprecated schema types or properties can be deleted manually from openMINDS vocabulary.
107 107  
108 108  (% style="text-align: justify;" %)
... ... @@ -114,29 +114,17 @@
114 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 -Although, as the file extension suggests, this openMINDS schema template syntax is inspired by JSON-Schema, it facilitates or even excludes technical aspects making the openMINDS schemas 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).
112 +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 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. 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.
115 +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.
121 121  
122 122  (% style="text-align: justify;" %)
123 -For the more inexperienced programmers, let's start by explaining first some general terms that will be later used in the openMINDS schema template syntax specification. More experienced programmers can of course skip these explanations and jump directly further down.
118 +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.
124 124  
125 -**What are strings, integers, floats or booleans?** Generally speaking strings, integers, floats or booleans are derived **data types**. A **string** is defined as a sequence of characters between quotes (e.g., ##"Is this a string? YES!"## or ##'thisIsAlsoAString'##). For a string, openMINDS accepts Unicode characters. An **integer** is a whole number, positive or negative, without decimals, of unlimited length (e.g., ##5##, ##-5## or ##1238921234##). A **float** represents a real number, written with a decimal point dividing the integer and fractional part, both of unlimited length (e.g., ##5.15##, ##-5.15## or ##1238921234.1345##). A **boolean** represents a logical proposition by means of the binary digits ##0## (##false##) and ##1## (##true##), especially in computing and electronics. How a boolean is written depends highly on the format or computational language.
120 +(% style="text-align: justify;" %)
121 +(//**coming soon**//)
126 126  
127 -**What is a list or array?** A **list** is a data structure that is a mutable ordered sequence of values (also called items). The values of a list are typically defined between square brackets (e.g., ##[value1, value2, value3]##). Note that the values within a list do not have to have the same data type. In contrast, an **array** is a data structure that is a mutable unordered sequence of values of the same data type. What data types are accepted for values in a list or in an array is highly depending on the format or computational language.
128 -
129 -**What is a key-value pair or an associative array?** A **key-value pair** (sometimes also called name-value pair, attribute-value pair, property-value pair, or field-value pair) is a basic data representation and standard language feature in computing languages, systems and applications. In most cases this concept is used to build an **associative array**, meaning an unordered list of unique keys with associated values typically defined within curly brackets (e.g., ##{key1: value1, key3: value3, key2:value2}##). What data types are accepted for keys and values highly depends on the format or computational language. Note that a value could also be a data structure, such as a list, an array or an associative array.
130 -
131 -**What is a dictionary and what is JSON?**
132 -
133 -
134 -==== Specification of the openMINDS schema template syntax ====
135 -
136 -(coming soon)
137 -
138 138  === The openMINDS integration pipeline ===
139 139  
140 -(//**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
141 -
142 -{{putFootnotes/}}
125 +(//**coming soon**//)
Public

openMINDS