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

Add Internationalization Considerations section. #111

Merged
merged 3 commits into from
Jul 13, 2023

Conversation

msporny
Copy link
Member

@msporny msporny commented Jul 5, 2023

This PR adds an internationalization considerations section, even though the spec is largely a cryptographic enveloping mechanism (and thus doesn't interact with individuals directly). There is one consideration related to date/time values that was worth mentioning, so that's been added.


Preview | Diff

index.html Outdated
@@ -2487,5 +2487,33 @@ <h3>Selective Disclosure</h3>

</section>

<section>
<h2>Internationalization Considerations</h2>

Choose a reason for hiding this comment

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

The I18N WG generally does not request the creation of "Internationalization Considerations" sections unless there is a really specific message that needs to be communicated. We generally prefer that linguistic, cultural, regional, and other considerations be dealt with in the section(s) that are applicable (and where guidance will most likely be seen by implementers).

I would be much happier if you put a note block into the "representing time" section (the original one linked to but the new "representing time" sub-section in this PR) that says something like:

<!-- note this links to a term in the i18n-glossary -->
<div class="note">
<p>When displaying date and time values related to the
    validity of cryptographic proofs, implementers should 
    respect the <a>locale</a> and possibly local calendar
    preferences of the user. 
    Conversion of timestamps to local time values should
    consider the time zone expectations of the user.</p>
</div>

Copy link
Collaborator

Choose a reason for hiding this comment

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

So we could just put your recommended text alongside the created parameter in the Proofs (section 2.1) which is the only place we have a date/time.

Choose a reason for hiding this comment

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

@Wind4Greg exactly so.

Note that I18N in in the process of doing a review and there is a pending issue related to this (with different textual recommendations in it) here

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thanks @aphillips we'll want to be consistent with the VC Data Model 2.0 and I particularly like your point about handling cases with/without timezone information!

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, I'll make the change as you suggest @aphillips -- thank you. I'll also try to cross-link to the vc-data-model section on time representation so we take advantage of the text over there as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed in bae11c6.

Copy link
Contributor

@dlongley dlongley left a comment

Choose a reason for hiding this comment

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

+1 and happy for this to be reconfigured in the way @aphillips suggested.

@msporny msporny force-pushed the msporny-i18n-considerations branch from 508ecd6 to bae11c6 Compare July 13, 2023 21:40
@msporny
Copy link
Member Author

msporny commented Jul 13, 2023

Editorial, multiple reviews, changes requested and made, no objections, merging.

@msporny msporny merged commit b0da4fa into main Jul 13, 2023
1 check passed
@msporny msporny deleted the msporny-i18n-considerations branch July 13, 2023 21:42
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.

None yet

6 participants