Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -76,7 +76,7 @@
76	76	}
77	77	{{/code}}
78	78
79		-... and a cutout of the properties.json:
	79	+... and a cutout of the **##properties.json##**:
80	80
81	81	{{code language="json"}}
82	82	{
...	...	@@ -97,9 +97,12 @@
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, 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).
	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).
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;" %)
103	103	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.
104	104
105	105	(% style="text-align: justify;" %)
...	...	@@ -108,20 +108,18 @@
108	108	=== The openMINDS schema template syntax ===
109	109
110	110	(% style="text-align: justify;" %)
111		-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##**.
	114	+All openMINDS metadata models use a light-weighted schema template syntax for defining the expected metadata. Although this schema template syntax is inspired by JSON-Schema, it outsources most schema technicalities to be handled in the openMINDS integration pipeline, making the openMINDS schemas more human-readable, especially for untrained eyes. Within the openMINDS integration pipeline (cf. below), the schema template syntax is interpreted, extended and flexibly translated to various formal metadata formats (e.g., JSON-Schema).
112	112
113	113	(% style="text-align: justify;" %)
114		-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).
	117	+Please find in the following a full documentation of the openMINDS schema template syntax specifications.
115	115
116		-(% style="text-align: justify;" %)
117		-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.
	119	+==== Specifications ====
118	118
119		-(% style="text-align: justify;" %)
120		-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.
	121	+All openMINDS schemas are human and machine-readable text files with the extension **##.schema.tpl.json##** which define the structure and content of correctly instantiated openMINDS metadata instances. Many features are adopted from JSON-Schema.  According to the schema template syntax each schema is defined as a nested associative array (dictionary).
121	121
122		-(% style="text-align: justify;" %)
123		-(//**coming soon**//)
124	124
125	125	=== The openMINDS integration pipeline ===
126	126
127		-(//**coming soon**//)
	126	+(//**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
	127	+
	128	+{{putFootnotes/}}