Skip to content

Commit 14f6300

Browse files
committed
address comments by @elichad
1 parent 9a1a0d6 commit 14f6300

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/_specification/1.2-DRAFT/appendix/implementation-notes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ When implementing tools to work with RO-Crate it is not necessary to use JSON-LD
4646

4747
## Combining with other packaging schemes
4848

49-
RO-Crates may co-exist with other packaging schemes, such as [BagIt] or [ELN] using two general approaches; either (a) _adding_ RO-Crate into a package as part of the payload or (b) _wrapping_ another kind of package.
49+
RO-Crates may co-exist with other packaging schemes, such as [BagIt] or [ELN] (Electronic Lab Notebook) using two general approaches; either (a) _adding_ RO-Crate into a package as part of the payload or (b) _wrapping_ another kind of package.
5050

5151
### ELN examples
5252

53-
An "ELN" archive (with file extension **.eln**, see [IANA assignment](https://www.iana.org/assignments/media-types/application/vnd.eln+zip) and [specification](https://github.com/TheELNConsortium/TheELNFileFormat/blob/master/SPECIFICATION.md)), is a valid RO-Crate packaged in a certain way. It is a ZIP file that contains a folder, and this folder _is_ the RO-Crate and contains the `ro-crate-metadata.json` file. See [Structure of the archive](https://github.com/TheELNConsortium/TheELNFileFormat/blob/master/SPECIFICATION.md#structure-of-the-archive) from the specification.
53+
An "ELN" archive (with file extension `.eln`, see [IANA assignment](https://www.iana.org/assignments/media-types/application/vnd.eln+zip) and [specification](https://github.com/TheELNConsortium/TheELNFileFormat/blob/master/SPECIFICATION.md)), is a valid RO-Crate packaged in a certain way. It is a ZIP file that contains a folder, and this folder is the _RO-Crate Root_ containing the `ro-crate-metadata.json` file. See [Structure of the archive](https://github.com/TheELNConsortium/TheELNFileFormat/blob/master/SPECIFICATION.md#structure-of-the-archive) from the specification.
5454

55-
As such, when processing a **.eln** file, one needs to extract the ZIP archive, look for the only folder present at root directory of the ZIP archive, and process its content as a normal RO-Crate.
55+
As such, when processing a `.eln` file, one needs to extract the ZIP archive, look for the only folder present at root directory of the ZIP archive, and process its content as a normal RO-Crate.
5656

5757
### BagIt examples
5858

@@ -190,7 +190,7 @@ reference a downloadable file by relative paths within `data/`, even if
190190
this file is not itself described in the RO-Crate metadata.
191191

192192

193-
#### Snapshots of external files
193+
##### Snapshots of external files
194194

195195
As an alternative to the above, [web-based data entities](../data-entities#web-based-data-entities)
196196
can be used in the RO-Crate:
@@ -217,7 +217,7 @@ primarily pointing at a web resource which is allowed to change
217217
without causing a BagIt checksum error.
218218

219219

220-
### Example of wrapping a BagIt bag in an RO-Crate
220+
#### Example of wrapping a BagIt bag in an RO-Crate
221221

222222
Alternatively, an RO-Crate can _wrap_ a BagIt bag, so that the RO-Crate metadata
223223
is outside of the bag directory and can be changed without changing the payload's checksums.

0 commit comments

Comments
 (0)