Changes for page Application details

Last modified by lzehl on 2021/10/13 13:11
From version 42.1
edited by lzehl
on 2021/05/02 14:25
Change comment: Renamed back-links.
To version 47.1
edited by lzehl
on 2021/06/24 11:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -Collabs.openminds.Documentation on.WebHome
1 +Collabs.openminds.Documentation.WebHome
Content
... ... @@ -33,7 +33,7 @@
33 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>>Collabs.openminds.openMINDS core.Application details.Technical details.WebHome||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 -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.Documentation on.Implementation details.WebHome||target="_blank"]].
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.Documentation.Implementation details.WebHome||target="_blank"]].
37 37  
38 38  Generally speaking, the JSON-LD property **##"@type"##** defines which schema should be used to validate the particular JSON-LD. The **##"@type"##** expects an entry (value) of type string with the format of an IRI. Within openMINDS, the **##"@type"##** value equals the corresponding schema-namespace with the following naming convention:
39 39  
... ... @@ -44,7 +44,7 @@
44 44  where **##XXX##** and **##YYY##** should be replaced with the openMINDS sub-module (e.g., **##core##**) and corresponding schema-name (e.g., **##ContactInformation##**), respectively.
45 45  
46 46  (% style="text-align: justify;" %)
47 -In return, the JSON-LD property **##"@id"##** defines the particular metadata instance (node). For this reason, the **##"@id"##** also expects an entry (value) of type string with the format of an IRI. In particular when you plan to submit your metadata collection later to the EBRAINS Knowledge Graph, we recommend you use the following naming convention on your local machine for this identifier:
47 +In return, the JSON-LD property **##"@id"##** defines the particular metadata instance (i.e., graph database node). For this reason, the **##"@id"##** also expects an entry (value) of type string with the format of an IRI. In particular when you plan to submit your metadata collection later to the EBRAINS Knowledge Graph, we recommend you use the following naming convention on your local machine for this identifier:
48 48  
49 49  (% style="text-align: center;" %)
50 50  **##"@id": "http:~/~/localhost/YYY/ZZZ"##**
... ... @@ -80,7 +80,7 @@
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. also [[Technical details>>doc:Collabs.openminds.Documentation on.Implementation details.WebHome]]).
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.Documentation.Implementation details.WebHome]]).
84 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. If you need support in designing your own openMINDS metadata collection, check out the [[Tutorials>>openminds@ebrains.eu||target="_blank"]] which might give you hints on how to tackle your individual case or, of course, get in touch with us via [[openminds@ebrains.eu>>mailto:openminds@ebrains.eu]].
85 85  
86 86  ===== Installation =====
... ... @@ -121,7 +121,7 @@
121 121  {{/code}}
122 122  
123 123  (% class="wikigeneratedid" %)
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 (cf. [[Metadata models & schemas>>doc:Collabs.openminds.Documentation on.Metadata models & schemas.WebHome]]) or the code on the corresponding GitHub.
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 (cf. [[Metadata models & schemas>>doc:Collabs.openminds.Documentation.Metadata models and schemas.WebHome]]) or the code on the corresponding GitHub.
125 125  
126 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  
... ... @@ -129,8 +129,6 @@
129 129  mycollection.help_core_person()
130 130  {{/code}}
131 131  
132 -
133 -
134 134  === The openMINDS spreadsheet templates ===
135 135  
136 136  (% style="text-align: justify;" %)
... ... @@ -139,4 +139,19 @@
139 139  === The EBRAINS Knowledge Graph Editor ===
140 140  
141 141  (% style="text-align: justify;" %)
142 -For curators of the EBRAINS Data & Knowledge service, it is possible to register openMINDS conform metadata into the EBRAINS Knowledge Graph database by using the EBRAINS Knowledge Graph Editor.
140 +For curators of the EBRAINS Data & Knowledge service and users with an EBRAINS account, it is possible to register openMINDS conform metadata into the EBRAINS Knowledge Graph database by using the EBRAINS Knowledge Graph Editor. This editor not only allows the manual registration of openMINDS conform metadata, but also has many project management related features establishing a controlled and secured environment for curating metadata of submitted research products that should be published via the EBRAINS Knowledge Graph database (including the assignment of an EBRAINS DOI if requested).
141 +
142 +(% style="text-align: justify;" %)
143 +To guarantee the latter, the EBRAINS Data & Knowledge service has its own EBRAINS Knowledge Graph Editor environment which reserves the rights of publicly releasing metadata and assigned EBRAINS DOIs via the EBRAINS Knowledge Graph for the members of the curation team. Nonetheless, users with an EBRAINS account can receive access to a separate EBRAINS Knowledge Graph Editor environment through a private Collab in the EBRAINS Collaboratory. All members of such a private Collab can then manually register openMINDS conform metadata through the EBRAINS Knowledge Graph Editor to a restricted space of the Knowledge Graph database that is not accessible to any user outside of the respective Collab. In order to publicly release these privately registered metadata, an official curation request has to be made through the EBRAINS Data & Knowledge service.
144 +
145 +(% style="text-align: justify;" %)
146 +Independent of the different user environments, the EBRAINS Knowledge Graph Editor has the following features to facilitate the manual registration of openMINDS conform metadata:
147 +
148 +(% style="text-align: justify;" %)
149 +(1) Input masks for all openMINDS metadata schemas. New metadata instances can be easily created through an intuitive input mask that validates the user entries already against the respective openMINDS schema.
150 +
151 +(% style="text-align: justify;" %)
152 +(2) Drop down menus for existing metadata instances. In accordance with the openMINDS metadata models, registered metadata instances can be linked with each other. Establishing these linkages is facilitated by drop down menus for selecting existing and fitting instances in dedicated properties of each input mask.
153 +
154 +(% style="text-align: justify;" %)
155 +(3)
Public

openMINDS