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

Renamed name to title and added lang & dir. #225

Merged
merged 2 commits into from
Nov 14, 2023
Merged

Renamed name to title and added lang & dir. #225

merged 2 commits into from
Nov 14, 2023

Conversation

andresuribe87
Copy link
Collaborator

@andresuribe87 andresuribe87 commented Nov 2, 2023

Fixes #224 by adding a locale field.

Additionally, this PR also renames name in favor of title, because the latter is part of the json schema spec.


Preview | Diff

@aphillips
Copy link

"locale" is probably not the right name for this field, as it implies something about the processing environment or maybe the configuration of the host serving the credentials.

A better model would probably be to follow some other specs and use lang/dir (one example: app-manifest lang and app-manifest dir) for the document-wide language and direction.

Providing for multilingual title and description would be up to your WG. It's not that uncommon to want labels in two or three languages. But it's not a blocker for getting your spec out the door.

@andresuribe87 andresuribe87 changed the title Renamed name to title and added locale. Renamed name to title and added lang & dir. Nov 3, 2023
@andresuribe87
Copy link
Collaborator Author

Thanks @aphillips , I made the changes so we use lang and dir in a similar way.

Copy link

@aphillips aphillips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. Thanks for the changes so far.

index.html Show resolved Hide resolved
index.html Show resolved Hide resolved
index.html Show resolved Hide resolved
index.html Show resolved Hide resolved
<a data-cite="ltli/#dfn-language-tag">language tag</a> for the values of the [=title=] and
[=description=] properties defined in the JSON Schema. The value of this field MUST be a
<a data-cite="ltli/#dfn-canonical-unicode-locale-identifier">canonical unicode locale identifier</a>.
When absent, implementers MUST assume that the value of this property is `en-US`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't agree with this in app-manifest (I think we have an issue open against it?). The value when the language is not present should be und ("Undetermined", also known as the "root" locale)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what issue/repo you may be referring to. Mind clarifying?

Curious, is that und guidance part of the LTLI spec?

I've updated this PR.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious, is that und guidance part of the LTLI spec?

Actually, no, it's in String-Meta and the I18N Best Practices for Specs document. I've created an issue to add it to LTLI.

Copy link
Collaborator

@decentralgabe decentralgabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

approving pending @aphillips 's recommended changes. thanks for getting this up!

Copy link

@aphillips aphillips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good. Thanks!!

@decentralgabe decentralgabe merged commit 5ac6ab2 into main Nov 14, 2023
2 checks passed
@decentralgabe decentralgabe deleted the issue_224 branch November 14, 2023 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide for localization of a VC JSON Schema document
3 participants