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.

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

Make it clear that @id is URIpath with / seperators #80

Merged
merged 1 commit into from
Jul 2, 2020
Merged

Conversation

stain
Copy link
Contributor

@stain stain commented Jun 3, 2020

Added below Core Metadata for Data Entities to clarify #77

Encoding file paths

Note that all @id identifiers must be valid URI references, care must be taken to express any relative paths using / separator, correct casing, and escape special characters like space (%20) and percent (%25), for instance a File Data Entity from the Windows path Results and Diagrams\almost-50%.png becomes "@id": "Results%20and%20Diagrams/almost-50%25.png" in the RO-Crate JSON-LD.

In this document the term URI includes international _IRI_s; the RO-Crate Metadata File is always UTF-8 and international characters in identifiers SHOULD be written using native UTF-8 characters (_IRI_s), however traditional URL encoding of Unicode characters with % MAY appear in @id strings. Example: "@id": "面试.mp4" is preferred over the equivalent "@id": "%E9%9D%A2%E8%AF%95.mp4"

@stain stain added this to the RO-Crate 1.1 milestone Jun 10, 2020
@stain stain added the enhancement New feature or request label Jun 10, 2020
@stain
Copy link
Contributor Author

stain commented Jun 24, 2020

Would @marcolarosa or @ptsefton be able to review?

@stain stain requested a review from ptsefton June 24, 2020 16:17
@marcolarosa
Copy link
Contributor

@stain Yep - that makes sense and it looks like that commit is putting that text into Core Metadata for Entities section which I think is also a good place for it.

@stain stain merged commit 7a80e29 into master Jul 2, 2020
@stain stain deleted the issue-77 branch July 2, 2020 15:20
@stain stain mentioned this pull request Sep 15, 2020
@stain stain mentioned this pull request Sep 24, 2020
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc update : make it clear that Dataset @id is a URIPath w/ *nix separators
2 participants