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

Document how XDM models and entities are internationalized #19

Open
trieloff opened this issue Dec 4, 2017 · 3 comments
Open

Document how XDM models and entities are internationalized #19

trieloff opened this issue Dec 4, 2017 · 3 comments

Comments

@trieloff
Copy link
Contributor

trieloff commented Dec 4, 2017

We need to document how XDM models and entities will allow multi-lingual metadata to be defined for properties that are used to provide end user facing strings such as title and description.

JSON Schema has an open issue on how this might be achieved and JSON-LD defines how string internationalization should occur in their w3 spec.

I personally like the JSON schema proposal nest as it allows for the use of $ref to externalize the localized strings which will decouple the localization from the model definitions. Unfortunately, the proposal has yet to be accepted in to the JSON and the conversation in the issue seems to have trailed off over a year ago.

Once we align on the approach we'd like to take I'll open a PR with the documentation changes.

Thanks.

@lrosenthol
Copy link
Collaborator

There is now a W3C draft recommendation on how to address this. See https://w3c.github.io/string-meta/

@trieloff
Copy link
Contributor Author

@lrosenthol I can see how we would use the string-meta approach within XDM, e.g. to localize product descriptions as outlined in #79. Would you also use it within the schema itself?

@cdegroot-adobe
Copy link
Contributor

I like the syntax in Example #4
"title": [ "en": { "value": "Moby Dick", "lang": "en" },
"ar": { "value": "موبي ديك", "lang": "ar" "dir": "rtl"},
"ja": { "value": "白鯨", "lang": "ja" },
"zh-Hans": { "value": "莫比迪克", "lang": "zh-Hans", "dir": "ltr"} ],

@trieloff trieloff removed their assignment Sep 18, 2018
prabhum2 pushed a commit that referenced this issue Oct 14, 2020
Merge latest from origin/master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants