Summary

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

Details

Page properties

Content

...	...	@@ -30,7 +30,7 @@
30	30	{{/code}}
31	31
32	32	(% style="text-align: justify;" %)
33		-To simplify the human-readability for all openMINDS users, technical properties specifically required for the JSON-LD syntax are, on purpose, not defined in the openMINDS schema templates. Instead, these technical properties are first added to the required property list of all openMINDS schemas after their template is transformed into an established, full-blown metadata schema format, such as JSON-Schema (cf. [[Technical details>>Technical details||target="_blank"]]). Let us explain why these technical JSON-LD properties are needed and how they are correctly provided for an openMINDS instance.
	33	+These additional technical properties specifically required for the JSON-LD syntax are, on purpose, not defined in the openMINDS schema templates in order to simplify the human-readability for all users. Instead, these technical properties are first added to the required property list of all openMINDS schemas after their template is transformed into an established, full-blown metadata schema format, such as JSON-Schema (cf. [[Technical details>>Technical details||target="_blank"]]). Let us explain in the following why these technical JSON-LD properties are needed and how they are correctly provided for an openMINDS instance.
34	34
35	35	(% style="text-align: justify;" %)
36	36	The JSON-LD properties **##"@context"##** and **##"@vocab"##** define a common vocabulary mapping, by stating a prefix that extends all non-JSON-LD property names and **##"@type"##** values that do not correspond to an IRI or compact IRI. Within openMINDS, each metadata instance should map to the openMINDS vocabulary, meaning the **##"@context"##** and **##"@vocab"##** is the same across all metadata instances (cf. code above). If you want to learn more about the power of the openMINDS vocabulary please go to: [[Technical details>>doc:Collabs.openminds.openMINDS core.Implementation details.WebHome||target="_blank"]].
...	...	@@ -50,7 +50,7 @@
50	50	**##"@id": "http:~/~/localhost/YYY/ZZZ"##**
51	51
52	52	(% style="text-align: justify;" %)
53		-where **##YYY##** and **##ZZZ##** should be replaced with the openMINDS schema (e.g., **##ContactInformation##**) and your own collection-unique identifier (e.g. **##email_openMINDS##**), respectively. Within the EBRAINS Knowledge Graph (KG) this identifier has to be a universally unique identifier (UUID), and, therefore, will be replaced accordingly with a UUID by the EBRAINS Knowledge Graph system during the integration process of your openMINDS collection.
	53	+where **##YYY##** and **##ZZZ##** should be replaced with the openMINDS schema (e.g., **##ContactInformation##**) and your own collection-unique identifier (e.g. **##email_openMINDS##**), respectively. While locally this instance identifier only has to be unique within your collection or system, it has to be globally unique if you want to share your instances with the world. Within the EBRAINS Knowledge Graph (KG) this identifier is therefore replaced with an universally unique identifier (UUID) with integration of your openMINDS collection into the public graph database.
54	54
55	55	(% style="text-align: justify;" %)
56	56	The JSON-LD property **##"@id"##** is also used to link two different metadata instances. Let us introduce a second openMINDS instance of the openMINDS core schema Person which can link to an openMINDS instance of the openMINDS core schema ContactInformation. Here a valid JSON-LD for a person with a link to the contact information we defined above:
...	...	@@ -80,8 +80,8 @@
80	80
81	81	One possible way to write openMINDS conform JSON-LDs is to use the openMINDS Python API which will help you to interact with the EBRAINS openMINDS metadata models and schemas. It consists of two sub-modules:
82	82
83		-The **openMINDS.generator** (coming soon) facilitates the translation of the openMINDS schema template syntax to other established formats, such as HTML and JSON-Schema (cf. [[Technical details>>doc:Collabs.openminds.openMINDS core.Implementation details.WebHome]]).
84		-\\The **openMINDS.compiler** allows you the dynamic usage of openMINDS metadata models and schemas in your Python application for generating your own collection of openMINDS conform metadata representations (instances) as JSON-LDs (as described above).
	83	+The **openMINDS.generator** (coming soon) facilitates the translation of the openMINDS schema template syntax to other established formats, such as HTML and JSON-Schema (cf. also [[Technical details>>doc:Collabs.openminds.openMINDS core.Implementation details.WebHome]]).
	84	+\\The **openMINDS.compiler** allows you the dynamic usage of openMINDS metadata models and schemas in your Python application for generating your own collection of openMINDS conform metadata representations (instances) as JSON-LDs (as described above). Please note that the openMINDS.compiler only helps you to generate correctly formatted JSON-LD metadata instances. The preparation on how you want to describe your research product with openMINDS is still up to you, although we provide some hints on how to tackle your individual case in the [[Tutorials>>openminds@ebrains.eu||target="_blank"]] and can always be contacted for individual support via [[openminds@ebrains.eu>>mailto:openminds@ebrains.eu]].
85	85
86	86	===== Installation =====
87	87
...	...	@@ -123,13 +123,20 @@
123	123	(% class="wikigeneratedid" %)
124	124	To learn in general about the available openMINDS metadata models and schemas including their required or optional metadata properties, please check out the HTML representations of the schemas or the code on the corresponding GitHub (cf. [[Metadata models & schemas>>doc:Collabs.openminds.openMINDS core.Metadata models & schemas.WebHome]]).
125	125
126		-Within the openMINDS.compiler you can also get an overview of the requirement of a schema and all its properties by using the **##help_##** function. Here an example:
	126	+Interactively you can also get an overview of the requirement of a schema and all its properties by using the **##help_##** function of the openMINDS.compiler. Here an example:
127	127
	128	+{{code language="python"}}
	129	+mycollection.help_core_person()
	130	+{{/code}}
128	128
	132	+===== openMINDS.compiler documentation =====
	133	+
	134	+((% style="color:#7f8c8d" %)**//coming soon//**(%%))
	135	+
129	129	=== The openMINDS spreadsheet templates ===
130	130
131	131	(% style="text-align: justify;" %)
132		-For users with no programming experience, it is possible to provide at least openMINDS conform metadata by using the openMINDS spreadsheet templates.
	139	+((% style="color:#7f8c8d" %)**//coming soon//**(%%)) For users with no programming experience, it is possible to provide at least openMINDS conform metadata by using the openMINDS spreadsheet templates.
133	133
134	134	=== The Knowledge Graph Editor ===
135	135