Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: packaging: add ELN implementation note in appendix #389

Merged
merged 2 commits into from
Jan 10, 2025
Merged

doc: packaging: add ELN implementation note in appendix #389

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a1a0d6
doc: packaging: add ELN implementation note in appendix
NicolasCARPi Jan 9, 2025
14f6300
address comments by @elichad
NicolasCARPi Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_includes/references.liquid
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ and is also rendered into the end of the PDF.
[DataCite Schema]: https://schema.datacite.org/
[DataCite Schema v4.0]: https://schema.datacite.org/meta/kernel-4.0/metadata.xsd
[DCAT]: https://www.w3.org/TR/vocab-dcat/
[ELN]: https://the.elnconsortium.org/
[Exif]: https://en.wikipedia.org/wiki/Exif
[Flattened Document Form]: https://json-ld.org/spec/latest/json-ld/#flattened-document-form
[FRAPO]: http://www.sparontologies.net/ontologies/frapo
Expand Down
16 changes: 12 additions & 4 deletions docs/_specification/1.2-DRAFT/appendix/implementation-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,15 @@ When implementing tools to work with RO-Crate it is not necessary to use JSON-LD

## Combining with other packaging schemes

RO-Crates may co-exist with other packaging schemes, such as [BagIt] using two general approaches; either (a) _adding_ RO-Crate into a package as part of the payload or (b) _wrapping_ another kind of package. Examples using BagIt follow.
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.
NicolasCARPi marked this conversation as resolved.
Show resolved Hide resolved

### ELN examples

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.
NicolasCARPi marked this conversation as resolved.
Show resolved Hide resolved

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.
NicolasCARPi marked this conversation as resolved.
Show resolved Hide resolved

### BagIt examples

BagIt is described in [RFC 8493]:

Expand All @@ -59,7 +67,7 @@ BagIt is described in [RFC 8493]:
BagIt and RO-Crate have largely separate concerns - RO-Crate is focussed on rich
metadata, the semantics of data, while BagIt is about reliable transfer.

### Adding RO-Crate to Bagit
#### Adding RO-Crate to Bagit

RO-Crate can be combined with BagIt simply by placing the RO-Crate files
within the BagIt payload (`data/`) directory.
Expand Down Expand Up @@ -136,14 +144,14 @@ measures, e.g.
`gpg --detach-sign --armor --output tagmanifest-sha512.txt.asc tagmanifest-sha512.txt`
in combination with a secure PGP key exchange or equivalent trust network.

#### Base URI in BagIt
##### Base URI in BagIt

The arcp specification suggests how [BagIt UUID identifiers] can be used to calculate the base URI of a bag, see section [Establishing a base URI inside a ZIP file](relative-uris#establishing-a-base-uri-inside-a-zip-file). For this purpose it is RECOMMENDED that `bag-info.txt` includes a fresh UUID like:

External-Identifier: urn:uuid:24e51ca2-5067-4598-935a-dac4e327d05a


#### Referencing external files
##### Referencing external files
NicolasCARPi marked this conversation as resolved.
Show resolved Hide resolved

The [BagIt fetch file](https://www.rfc-editor.org/rfc/rfc8493.html#section-2.2.3) MAY
be used to reference files to be downloaded into particular `data/` paths
Expand Down