| ... | ... | @@ -45,7 +45,51 @@ However for adoption of your application- or domain-level metadata and semantics |
|
|
|
- cite the EM-Glossary in appropriate places of your output or publication.
|
|
|
|
|
|
|
|
### Metadata schemas
|
|
|
|
Application level metadata is often collected and validated with metadata schemas. Different formats may be used for this, such as XML or JSON-Schema. We here highlight the latter as a very commonly used way of defining schemas, but envision similar implementations also in other formats or serialisation. In JSON schema fields like "external reference" that could carry an emg.owl class label and "identifier" carrying the related class IRIs is encouraged.
|
|
|
|
Application level metadata is often collected and validated with metadata schemas. Different formats may be used for this, such as XML or JSON-Schema. We here highlight the latter as a very commonly used way of defining schemas, but envision similar implementations also in other formats or serialisation. Embedding links of the EM Glossary classes into a JSON Schema requires incorporating IRIs as references into the schema definitions. This can enhance the semantic richness of the JSON Schema and relate values in the schema to classes in the EM Glossary OWL artifact.
|
|
|
|
|
|
|
|
In order to do this you need to:
|
|
|
|
1. Identify the class in EM Glossary OWL you want to link to & copy its IRI.
|
|
|
|
2. Define the schema structure including properties that can represent EM Glossary IRIs.
|
|
|
|
3. Embed the IRIs as links to the respective EM Glossary class in the JSON Schema. For this keywords such as `description`, `examples` or custom annotations (using custom-defined keywords) can be used.
|
|
|
|
|
|
|
|
Here an example how that could look in an example schema. The link to EM Glossary classes is established by embedding selected IRIs that relate to a data item in the schema by using and object called `ontologyLink`, with the properties `uri` and `label`. These are defined by custom-defined keywords:
|
|
|
|
```
|
|
|
|
{
|
|
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
|
|
"title": "ExampleSchema",
|
|
|
|
"description": "An example schema representing some imaginary data",
|
|
|
|
"type": "object",
|
|
|
|
"properties": {
|
|
|
|
"dataItem1": {
|
|
|
|
"type": "string",
|
|
|
|
"description": "A first data item in the example schema",
|
|
|
|
"ontologyLink": {
|
|
|
|
"uri": "https://purls.helmholtz-metadaten.de/emg/EMG_00000009",
|
|
|
|
"label": "Coherent beam"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
"dataItem2": {
|
|
|
|
"type": "string",
|
|
|
|
"description": "Another data item in the example schema",
|
|
|
|
"ontologyLink": {
|
|
|
|
"uri": "https://purls.helmholtz-metadaten.de/emg/EMG_00000047",
|
|
|
|
"label": "Tilt correction"
|
|
|
|
}
|
|
|
|
},
|
|
|
|
},
|
|
|
|
"required": ["dataItem1", "dataItem2"]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
In JSON schema fields like "external reference" that could carry an emg.owl class label and "identifier" carrying the related class IRIs is encouraged.
|
|
|
|
|
|
|
|
:construction: under construction - further content will be added :construction:
|
|
|
|
### Semantic file formats
|
| ... | ... | |
| ... | ... | |