You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: episodes/14-common-pitfalls.md
+26-4Lines changed: 26 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,14 +46,14 @@ Creating RO-Crate packages by hand is a great way to understand their structure,
46
46
### 3. Using nested JSON instead of flat structure
47
47
48
48
-**Problem**: Embedding full descriptions of related entities instead of referencing them with `@id`.
49
-
-**Fix**: Use cross-referencing. Define each entity once and refer to it using its `@id`.
49
+
-**Fix**: Use cross-referencing. Define each entity once in the `@graph` array and refer to it using its `@id`.
50
50
51
51
### 4. Repeating or mismatched @id values
52
-
-**Problem**: Accidentally defining two entities with the same @id, or referencing an entity with an @id that doesn’t exist.
53
-
-**Fix**: Ensure every @id is unique and points to an entity defined in the metadata.
52
+
-**Problem**: Accidentally defining two entities with the same @id, or referencing an entity with an @id that doesn’t exist in the `@graph`.
53
+
-**Fix**: Ensure every @id is unique and cross-references point to an entity defined in the metadata.
54
54
55
55
### 5. Forgetting required metadata on key entities
56
-
-**Problem**: The root dataset doesn’t have name or license, or files are missing type.
56
+
-**Problem**: The root dataset doesn’t have `name` or `license`, or files are missing `@type`.
57
57
-**Fix**: Always include the required fields for the root (./) and for files:
58
58
```json
59
59
{
@@ -93,6 +93,28 @@ Here's an incorrect metadata example. Identify and fix the issues.
93
93
5. Missing required properties (description, datePublished, license) on the root dataset.
94
94
::::::::::::::::::::::::::::::::::::::::
95
95
96
+
## RO-Crate validation tools
97
+
98
+
The [RO-Crate Playground](https://ro-crate.ldaca.edu.au) and the [rocrate-validator](https://rocrate-validator.readthedocs.io/en/latest/) Python package can both be used to check for errors in your RO-Crate metadata. Each of them performs a different set of checks.
0 commit comments