Skip to content

Commit 06751b4

Browse files
lu-vedderlu-vedder
committed
Update formatting
1 parent e557fa1 commit 06751b4

1 file changed

Lines changed: 62 additions & 61 deletions

File tree

‎docs/tech-guides/core_metadata_specification.en.md‎

Lines changed: 62 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
## 1. Introduction and motivation
55
FAIRagro offers a metadata framework for publishing research datasets in the agrosystem domain and is meant to be implemented in data publication services such as Research Data Infrastructures (RDIs) and data repositories.
66

7-
For generic metadata, the Publication Metadata Set builds on [Schema.org](https://schema.org) and other standards ([DC Terms](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/){:target="_blank"}, [DCAT](https://www.w3.org/TR/vocab-dcat-3/){:target="_blank"}) and combines these to define a set of types, properties and cardinalities and links between the types.
7+
For generic metadata, the Publication Metadata Set builds on [Schema.org](https://schema.org){:target="_blank"} and other standards ([DC Terms](https://www.dublincore.org/specifications/dublin-core/dcmi-terms/){:target="_blank"}, [DCAT](https://www.w3.org/TR/vocab-dcat-3/){:target="_blank"}) and combines these to define a set of types, properties and cardinalities and links between the types.
88

99
Domain specific metadata is expressed through the Agrischemas framework. It additionaly builds on [Bioschemas](https://bioschemas.org/){:target="_blank"} to add agricultural related information to [Dataset](https://schema.org/Dataset){:target="_blank"} metadata with a focus on increasing its findability. It uses existing [types](https://bioschemas.org/types/){:target="_blank"} and [properties](https://schema.org/Property){:target="_blank"} and recommends semantic concepts to achieve interoperability. It can be implemented in already existing Schema.org interfaces by mapping domain-specific information available in local data/metadata to structures described in this document. **Agrischemas offers a list of recommended types and properties for findability based on this approach.**
1010

@@ -244,9 +244,9 @@ Types and properties from following namespaces are used:
244244
```
245245

246246
#### 2.1.14 Version
247-
**Definition:** "The version number of the dataset."
248-
<br>**Cardinality:** 0-1
249-
<br>**Range:** Text
247+
**Definition:** “The version number of the dataset.”
248+
**Cardinality:** 0-1
249+
**Range:** Text
250250

251251
**Representation:**
252252
```
@@ -256,9 +256,9 @@ Types and properties from following namespaces are used:
256256
```
257257

258258
#### 2.1.15 Format
259-
**Definition:** "The file format(s) of the dataset."
260-
<br>**Cardinality:** 0-n
261-
<br>**Range:** Text
259+
**Definition:** “The file format(s) of the dataset.”
260+
**Cardinality:** 0-n
261+
**Range:** Text
262262

263263
**Representation:**
264264
```
@@ -268,9 +268,9 @@ Types and properties from following namespaces are used:
268268
```
269269

270270
#### 2.1.16 Production date
271-
**Definition:** "The date when the data were produced (not distributed, published, or archived)." (Definition taken from Dataverse)
272-
<br>**Cardinality:** 0-1
273-
<br>**Range:** Date or DateTime (ISO 8601)
271+
**Definition:** “The date when the data were produced (not distributed, published, or archived).” (Definition taken from Dataverse)
272+
**Cardinality:** 0-1
273+
**Range:** Date or DateTime (ISO 8601)
274274

275275
**Representation:**
276276
```
@@ -280,9 +280,9 @@ Types and properties from following namespaces are used:
280280
```
281281

282282
#### 2.1.17 Distribution date
283-
**Definition:** "The date when the Dataset was made available for distribution/presentation." (Definition taken from Dataverse)
284-
<br>**Cardinality:** 0-1
285-
<br>**Range:** Date or DateTime (ISO 8601)
283+
**Definition:** “The date when the Dataset was made available for distribution/presentation.” (Definition taken from Dataverse)
284+
**Cardinality:** 0-1
285+
**Range:** Date or DateTime (ISO 8601)
286286

287287
**Representation:**
288288
```
@@ -292,9 +292,9 @@ Types and properties from following namespaces are used:
292292
```
293293

294294
#### 2.1.18 Update date
295-
**Definition:** "The date on which the Dataset was most recently modified or when the item's entry was modified " (Definition changed from [https://schema.org/dateModified](https://schema.org/dateModified))
296-
<br>**Cardinality:** 0-1
297-
<br>**Range:** Date or DateTime (ISO 8601)
295+
**Definition:** “The date on which the Dataset was most recently modified or when the item's entry was modified.” (Definition changed from [https://schema.org/dateModified](https://schema.org/dateModified){:target="_blank"})
296+
**Cardinality:** 0-1
297+
**Range:** Date or DateTime (ISO 8601)
298298

299299
**Representation:**
300300
```
@@ -304,10 +304,10 @@ Types and properties from following namespaces are used:
304304
```
305305

306306
#### 2.1.19 Language
307-
**Definition:** "A language that the Dataset's files is written in." (Definition taken from Dataverse)
308-
<br>**Cardinality:** 0-n
309-
<br>**Range:** Text
310-
<br>**Comment:** Use language codes from [https://www.rfc-editor.org/info/bcp47](https://www.rfc-editor.org/info/bcp47).
307+
**Definition:** “A language that the Dataset's files is written in.” (Definition taken from Dataverse)
308+
**Cardinality:** 0-n
309+
**Range:** Text
310+
**Comment:** Use language codes from [https://www.rfc-editor.org/info/bcp47](https://www.rfc-editor.org/info/bcp47){:target="_blank"}.
311311

312312
**Representation:**
313313
```
@@ -317,10 +317,10 @@ Types and properties from following namespaces are used:
317317
```
318318

319319
#### 2.1.20 Access rights
320-
**Definition:** "Information about who accesses the resource or an indication of its security status." (taken from [http://purl.org/dc/terms/accessRights](http://purl.org/dc/terms/accessRights))
321-
<br>**Cardinality:** 0-n
322-
<br>**Range:** Text
323-
<br>**Comment:** Values for access rights statements can e.g. be "restricted", or "internal" or can come from a controlled vocabulary.
320+
**Definition:** “Information about who accesses the resource or an indication of its security status.” (taken from [http://purl.org/dc/terms/accessRights](http://purl.org/dc/terms/accessRights){:target="_blank"})
321+
**Cardinality:** 0-n
322+
**Range:** Text
323+
**Comment:** Values for access rights statements can e.g. be “restricted”, or “internal” or can come from a controlled vocabulary.
324324

325325
**Representation:**
326326
```
@@ -330,9 +330,9 @@ Types and properties from following namespaces are used:
330330
```
331331

332332
#### 2.1.21 Source RDI
333-
**Definition:** "The original Research Data Infrastructure that the dataset was published by."
334-
<br>**Cardinality:** 1
335-
<br>**Range:** DataCatalog
333+
**Definition:** “The original Research Data Infrastructure that the dataset was published by.”
334+
**Cardinality:** 1
335+
**Range:** DataCatalog
336336

337337
**Representation:**
338338
```
@@ -344,9 +344,9 @@ Types and properties from following namespaces are used:
344344
```
345345

346346
#### 2.1.22 Has part
347-
**Definition:** "Indicates a Dataset or CreativeWork that is part of this item." (Definition changed from [https://schema.org/hasPart](https://schema.org/hasPart))
348-
<br>**Cardinality:** 0-n
349-
<br>**Range:** Dataset/CreativeWork
347+
**Definition:** “Indicates a Dataset or CreativeWork that is part of this item.” (Definition changed from [https://schema.org/hasPart](https://schema.org/hasPart){:target="_blank"})
348+
**Cardinality:** 0-n
349+
**Range:** Dataset/CreativeWork
350350

351351
**Representation:**
352352
```
@@ -364,10 +364,11 @@ Types and properties from following namespaces are used:
364364
}
365365
}
366366
```
367+
367368
#### 2.1.23 Is part of
368-
**Definition:** "Indicates a Dataset or CreativeWork that this item." (Definition changed from [https://schema.org/isPartOf](https://schema.org/isPartOf))
369-
<br>**Cardinality:** 0-n
370-
<br>**Range:** Dataset/CreativeWork
369+
**Definition:** “Indicates a Dataset or CreativeWork that this item.” (Definition changed from [https://schema.org/isPartOf](https://schema.org/isPartOf){:target="_blank"})
370+
**Cardinality:** 0-n
371+
**Range:** Dataset/CreativeWork
371372

372373
**Representation:**
373374
```
@@ -387,9 +388,9 @@ Types and properties from following namespaces are used:
387388
```
388389

389390
#### 2.1.24 Is based on
390-
**Definition:** "A resource from which this Dataset is derived or from which it is a modification or adaptation. " (Definition changed from [https://schema.org/isBasedOn](https://schema.org/isBasedOn))
391-
<br>**Cardinality:** 0-n
392-
<br>**Range:** Dataset/CreativeWork
391+
**Definition:** “A resource from which this Dataset is derived or from which it is a modification or adaptation.” (Definition changed from [https://schema.org/isBasedOn](https://schema.org/isBasedOn){:target="_blank"})
392+
**Cardinality:** 0-n
393+
**Range:** Dataset/CreativeWork
393394

394395
**Representation:**
395396
```
@@ -409,9 +410,9 @@ Types and properties from following namespaces are used:
409410
```
410411

411412
#### 2.1.25 Access type
412-
**Definition:** "A flag to signal that the item, event, or place is accessible for free." (Definition taken from [https://schema.org/isAccessibleForFree](https://schema.org/isAccessibleForFree))
413-
<br>**Cardinality:** 0-1
414-
<br>**Range:** Boolean
413+
**Definition:** “A flag to signal that the item, event, or place is accessible for free.” (Definition taken from [https://schema.org/isAccessibleForFree](https://schema.org/isAccessibleForFree){:target="_blank"})
414+
**Cardinality:** 0-1
415+
**Range:** Boolean
415416

416417
**Representation:**
417418
```
@@ -425,10 +426,11 @@ Types and properties from following namespaces are used:
425426
"https://schema.org/isAccessibleForFree": "False"
426427
}
427428
```
429+
428430
#### 2.1.26 Spatial resolution
429-
**Definition:** "Minimum spatial separation resolvable in a dataset, measured in meters." (Definition taken from DCAT)
430-
<br>**Cardinality:** 0-1
431-
<br>**Range:** Text / [xsd:decimal](https://www.w3.org/TR/xmlschema11-2/#decimal)
431+
**Definition:** “Minimum spatial separation resolvable in a dataset, measured in meters.” (Definition taken from DCAT)
432+
**Cardinality:** 0-1
433+
**Range:** Text / [xsd:decimal](https://www.w3.org/TR/xmlschema11-2/#decimal){:target="_blank"}
432434

433435
**Representation:**
434436
```
@@ -438,16 +440,15 @@ Types and properties from following namespaces are used:
438440
```
439441

440442
### 2.2 Person/Organization
441-
**Person definition:** A person (alive, dead, undead, or fictional). (Definition taken from [https://schema.org/Person](https://schema.org/Person))
443+
**Person definition:** “A person (alive, dead, undead, or fictional).” (Definition taken from [https://schema.org/Person](https://schema.org/Person){:target="_blank"})
442444

443-
**Organization definition:** An organization such as a school, NGO, corporation, club, etc. (Definition taken from [https://schema.org/Organization](https://schema.org/Organization))
445+
**Organization definition:** “An organization such as a school, NGO, corporation, club, etc..” (Definition taken from [https://schema.org/Organization](https://schema.org/Organization){:target="_blank"})
444446

445447
#### 2.2.1 Type
446-
**Definition:** "Defines if an entity is a person or an organization."
447-
<br>**Cardinality:** 1
448-
<br>**Range:**[https://schema.org/Person](https://schema.org/Person) / [https://schema.org/Organization](https://schema.org/Organization)
449-
<br>**Comment**: Choosing the correct type depends on the property it is used for as a value. For the "author" property, it will most likely be a [https://schema.org/Person](https://schema.org/Person), whereas it will most likely be a [https://schema.org/Organization](https://schema.org/Organization) as a value for the "affiliation" property.
450-
448+
**Definition:** “Defines if an entity is a person or an organization.”
449+
**Cardinality:** 1
450+
**Range:**[https://schema.org/Person](https://schema.org/Person){:target="_blank"} / [https://schema.org/Organization](https://schema.org/Organization){:target="_blank"}
451+
**Comment**: Choosing the correct type depends on the property it is used for as a value. For the “author” property, it will most likely be a [https://schema.org/Person](https://schema.org/Person){:target="_blank"}, whereas it will most likely be a [https://schema.org/Organization](https://schema.org/Organization){:target="_blank"} as a value for the “affiliation” property.
451452

452453
**Representation:**
453454
```
@@ -463,9 +464,9 @@ Types and properties from following namespaces are used:
463464
```
464465

465466
#### 2.2.2 Name
466-
**Definition:** "The name of the person or the organization." (Definition changed from Dataverse)
467-
<br>**Cardinality:** 1
468-
<br>**Range:** Text
467+
**Definition:** “The name of the person or the organization.” (Definition changed from Dataverse)
468+
**Cardinality:** 1
469+
**Range:** Text
469470

470471
**Representation:**
471472
```
@@ -474,9 +475,9 @@ Types and properties from following namespaces are used:
474475
}
475476
```
476477
#### 2.2.3 Affiliation (Person)
477-
**Definition:** "The name of the organization the person is affiliated with, e.g. an organization's name." (Definition changed from Dataverse)
478-
<br>**Cardinality:** 1
479-
<br>**Range:** Text
478+
**Definition:** “The name of the organization the person is affiliated with, e.g. an organization's name.” (Definition changed from Dataverse)
479+
**Cardinality:** 1
480+
**Range:** Text
480481

481482
**Representation:**
482483
```
@@ -488,9 +489,9 @@ Types and properties from following namespaces are used:
488489
```
489490

490491
#### 2.2.4 Identifier
491-
**Definition:** "Uniquely identifies a person/organization when paired with an identifier type." (changed from DataVerse)
492-
<br>**Cardinality:** 1
493-
<br>**Range:** Identifier
492+
**Definition:** “Uniquely identifies a person/organization when paired with an identifier type.” (changed from DataVerse)
493+
**Cardinality:** 1
494+
**Range:** Identifier
494495

495496
**Representation:**
496497
```
@@ -502,9 +503,9 @@ Types and properties from following namespaces are used:
502503
```
503504

504505
#### 2.2.4 E-Mail
505-
**Definition:** "A person/organization contact email address." (Definition changed from Dataverse)
506-
<br>**Cardinality:** 0-1
507-
<br>**Range:** Text
506+
**Definition:** “A person/organization contact email address.” (Definition changed from Dataverse)
507+
**Cardinality:** 0-1
508+
**Range:** Text
508509

509510
**Representation:**
510511
```

0 commit comments

Comments
 (0)