-
-
Notifications
You must be signed in to change notification settings - Fork 459
Add blog post on making JSON strings work for every language #2407
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
base: main
Are you sure you want to change the base?
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| --- | ||
| title: "Making JSON Strings Work for Every Language" | ||
| date: "2026-06-08" | ||
| type: Engineering | ||
| cover: /img/posts/2026/making-json-strings-work-for-every-language/cover.svg | ||
| authors: | ||
| - name: Fuqiao Xue | ||
| photo: /img/posts/2026/making-json-strings-work-for-every-language/fuqiaoxue.jpg | ||
| twitter: XueFuqiao | ||
| excerpt: "How JSON Schema authors preserve language and text direction metadata for the web." | ||
| language: en | ||
| --- | ||
|
|
||
| JSON is one of the most successful data formats, but its `string` type is too simple. That simplicity becomes a problem when a string contains natural language text. | ||
|
|
||
| Titles, names, error message etc. often needs more than Unicode characters. Consumers may also need to know the language of the text and its direction, especially when displaying right-to-left scripts such as Arabic or Hebrew. Without that metadata, applications fall back to guessing, and guessing fails. | ||
|
|
||
| The W3C Internationalization Working Group is developing [Strings on the Web: Language and Direction Metadata](https://www.w3.org/TR/string-meta/). Its recommendations are directly useful when schemas define fields that contain human-readable text. | ||
|
|
||
| The core recommendation is simple: if a field contains natural language text, it must be possible to determine the language and direction of that specific string. Prefer explicit metadata over heuristics. | ||
|
|
||
| For example, instead of treating every human-readable value as a plain string: | ||
|
|
||
| ```json | ||
| { | ||
| "title": "HTML و CSS: تصميم و إنشاء مواقع الويب" | ||
| } | ||
| ``` | ||
|
|
||
| a format can define a localizable text object: | ||
|
|
||
| ```json | ||
| { | ||
| "title": { | ||
| "value": "HTML و CSS: تصميم و إنشاء مواقع الويب", | ||
| "lang": "ar", | ||
| "dir": "rtl" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| This gives producers and consumers a shared agreement. The producer can preserve the intended language and direction. The consumer can display the string correctly, apply the right `lang` and `dir` attributes in HTML, choose better fonts, select an appropriate text-to-speech voice, improve search and indexing, and avoid bidirectional text spillover. | ||
|
|
||
| A schema can instead make the expected structure explicit: | ||
|
xfq marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```json | ||
| { | ||
| "$defs": { | ||
| "textDirection": { | ||
| "enum": ["ltr", "rtl", "auto"] | ||
| }, | ||
| "localizableText": { | ||
| "type": "object", | ||
| "required": ["value"], | ||
| "properties": { | ||
| "value": { "type": "string" }, | ||
| "lang": { "type": "string" }, | ||
| "dir": { "$ref": "#/$defs/textDirection" } | ||
| }, | ||
| "additionalProperties": false | ||
| } | ||
| }, | ||
| "type": "object", | ||
| "properties": { | ||
| "title": { "$ref": "#/$defs/localizableText" } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The `lang` value should be a [BCP 47 language tag](https://www.rfc-editor.org/info/bcp47/). | ||
|
|
||
| The document also explains when not to add language and direction metadata. Not every JSON string is natural language text. Identifiers, protocol keywords, ISBNs, URLs, enum values, and many user-defined tokens are usually syntactic content, not localizable text. Specifications and schemas should distinguish these cases clearly. | ||
|
|
||
| For resources that contain many strings in the same language, a format can define resource-wide defaults, while still allowing string-specific overrides: | ||
|
|
||
| ```json | ||
| { | ||
| "language": "en-US", | ||
| "direction": "ltr", | ||
| "name": "Example University", | ||
| "description": "A short description.", | ||
| "alternateTitle": { | ||
| "value": "جامعة المثال", | ||
| "lang": "ar", | ||
| "dir": "rtl" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| The document recommends `language` for a resource-wide default language field and `direction` for a resource-wide default direction field. For localizable text objects, the examples use `lang` and `dir`, which align naturally with HTML attributes when the value is eventually displayed. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. JSON and HTML don't need to be kept in alignment. If the recommendation is for If the HTML/JSON alignment is warranted, an aside explaining why would be good.
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Filed w3c/string-meta#94 |
||
|
|
||
| For multilingual values, the document recommends language maps, where language tags help consumers find the best localized value: | ||
|
|
||
| ```json | ||
| { | ||
| "title": { | ||
| "en": { "value": "Learning Web Design" }, | ||
| "fr": { "value": "Apprendre le design web" }, | ||
| "ar": { "value": "تعلم تصميم الويب", "dir": "rtl" } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Producers should preserve language and direction metadata when they have it. They should avoid redundant per-string metadata when a resource-wide default already applies, but they should include string-specific metadata when a value uses a different language, a more specific language tag, or a direction opposite to the default. | ||
|
|
||
| Consumers should use the metadata they receive. For example, when inserting a string into HTML, that usually means applying `lang` and `dir` to an element that tightly wraps the inserted text, or using `bdi` when no better element is available. When metadata is absent, the language and direction should be treated as unknown. [First-strong direction](https://www.w3.org/TR/i18n-glossary/#dfn-first-strong-detection) detection can be a fallback, but it should not replace explicit metadata. | ||
|
|
||
| Language metadata also affects font selection, line breaking, hyphenation, spell checking, search, filtering, accessibility, and text-to-speech. | ||
|
|
||
| Unicode lets us exchange the characters, and metadata helps applications process and present those characters correctly. | ||
|
|
||
| We invite JSON Schema users, schema authors, and specification developers to read the recommendations of the W3C Internationalization Working Group and apply its patterns when designing JSON-based formats. Feedback on the document is welcome via the [W3C string-meta GitHub repository](https://github.com/w3c/string-meta/issues). | ||
Uh oh!
There was an error while loading. Please reload this page.