-
Notifications
You must be signed in to change notification settings - Fork 17
docs:uxw-localization-in-support #268
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
Open
tokyojen
wants to merge
24
commits into
main
Choose a base branch
from
uxw-localization
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
6fa9928
docs:uxw-localization-in-support
tokyojen b7c90cd
Update docs/guidelines/language/support-and-resources/uxw-localizatioβ¦
tokyojen e09e7a3
docs:localization fix
tokyojen db43fb5
docs:localization tabs
tokyojen 79dd70b
docs:localization headers
tokyojen efb0c6a
docs:localization infobox
tokyojen cd16219
Merge branch 'main' into uxw-localization
tokyojen f969be0
docs:localization fixes
tokyojen 756ab86
Merge branch 'uxw-localization' of https://github.com/siemens/ix-docsβ¦
tokyojen 4dd4f71
docs:localization puctuation fix
tokyojen 7180697
docs:support and resources ordering fix
tokyojen d6b4252
docs:localization align design system formatting
tokyojen 5dd74e5
docs:localization formatting
tokyojen 6705751
Merge branch 'main' into uxw-localization
tokyojen 0d0bd6a
docs:localization conflict fixed
tokyojen 81f8266
docs: fix text problem
tokyojen 7381405
Apply suggestion from @kathrinschalber
tokyojen 39c9479
Apply suggestion from @kathrinschalber
tokyojen 3af15a6
Apply suggestion from @kathrinschalber
tokyojen 360577f
docs:localization updates
tokyojen ca8def6
Merge branch 'main' into uxw-localization
tokyojen e5a6cb3
revert(package.json): remove accidental @babel/runtime dependency addβ¦
tokyojen 8d3fffb
docs:code files reverted
tokyojen cb8424a
docs:revert the revert back
tokyojen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/guidelines/language/support-and-resources/AI-and-UX-writing.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/guidelines/language/support-and-resources/UX-writing-principles.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/guidelines/language/support-and-resources/UX-writing-resources.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 4 additions & 0 deletions
4
docs/guidelines/language/support-and-resources/uxw-localization/_category_.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| { | ||
| "label": "Localization", | ||
| "position": 3 | ||
| } |
6 changes: 6 additions & 0 deletions
6
docs/guidelines/language/support-and-resources/uxw-localization/index.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| doc-type: "tabs" | ||
| description: 'Localization (l10n) is the adaptation of a product or content for a specific language, locale, region or market.' | ||
| title: 'Localization' | ||
| deprecated: | ||
| --- |
97 changes: 97 additions & 0 deletions
97
docs/guidelines/language/support-and-resources/uxw-localization/overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| --- | ||
| doc-type: 'tab-item' | ||
| sidebar_label: 'Localization' | ||
| description: 'Overview' | ||
| --- | ||
|
|
||
| # | ||
|
|
||
| ## Overview | ||
|
|
||
| Localization adapts a product to a specific language, region, and culture. It includes | ||
|
tokyojen marked this conversation as resolved.
|
||
| translation, formats, visual conventions, legal requirements, and user expectations. | ||
|
tokyojen marked this conversation as resolved.
tokyojen marked this conversation as resolved.
|
||
|
|
||
| ## Language and tone | ||
|
|
||
| Language and tone must be clear, accurate, and appropriate for the target audience. Good | ||
| localization preserves meaning, not just words, and must also account for plural rules and | ||
| punctuation. | ||
|
|
||
| ### Best practice | ||
|
|
||
| - Support translatable strings and integration with translation frameworks. | ||
| - Support fallback text for missing translations. | ||
| - Use the [UX Writing Guidelines](../../writing-style-guide-getting-started.md) for tone or wording. | ||
|
|
||
| ## Imagery and colors | ||
|
|
||
| Images, symbols, and colors can have different meanings across markets. Review them for cultural | ||
| fit and local expectations. | ||
|
|
||
| ### Best practice | ||
|
|
||
| - Validate visuals and semantics per market. | ||
|
|
||
| ## Currency, date, time, measurement, and measurement system formats | ||
|
|
||
| Users expect values to follow local conventions. This includes currencies, dates, times, numbers, | ||
| units, and measurement systems such as Β°C/Β°F, km/mi, or kg/lb. | ||
|
tokyojen marked this conversation as resolved.
|
||
|
|
||
| ### Best practice | ||
|
|
||
| - Use locale-aware formatting for dates, times, numbers, percentages, and currencies. | ||
|
tokyojen marked this conversation as resolved.
|
||
| - Allow users locale selection and persistence, e.g. via the `SiLocaleService`. | ||
| - Use translated unit labels in components where units are shown. | ||
|
tokyojen marked this conversation as resolved.
|
||
|
|
||
| ## User experience and design | ||
|
|
||
| Localized interfaces must work with different text lengths and different reading directions. Use | ||
| design options such as flexible growing areas, line wrapping, or fixed layouts with scrollbars, | ||
| and plan enough space for longer translations. | ||
|
|
||
| ## LTR and RTL {#ltr-rtl} | ||
|
|
||
| LTR (Left-to-Right) refers to languages and scripts that are written and read from left to right. | ||
|
|
||
| RTL (Right-to-Left) refers to languages and writing systems that are written and read from right to left. | ||
| RTL can require mirrored navigation, icon direction, alignment, and interaction patterns. | ||
|
tokyojen marked this conversation as resolved.
|
||
|
|
||
| ### Best practice | ||
|
|
||
| - Support RTL-aware behavior in components and overlays. | ||
| - Provide dynamic directionality support for Angular CDK integrations. | ||
| - Layout and design with variable text length in mind. | ||
|
|
||
| ## Payment methods | ||
|
|
||
| Payment expectations differ by country, including preferred methods, flows, and trust signals. | ||
|
|
||
| ## Legal and safety | ||
|
|
||
| Legal notices, safety texts, consent flows, and compliance content may vary by market and | ||
| jurisdiction. | ||
|
|
||
| ### Best practice | ||
|
|
||
| - Request local lawyers to provide tailored legal artifacts for relevant markets and regions. | ||
| - Manage market-specific legal and safety requirements, compliance logic, and legal services in your application. | ||
|
|
||
| :::info | ||
| The About and Legal components require specific content to comply with Siemens AG regulations. The official content and guidelines are exclusively available for Siemens employees and can be accessed [here](https://code.siemens.com/siemens-ix/ix-brand-theme/-/blob/main/apps/documentation/src/pages/about-legal-information.md?ref_type=heads). | ||
| ::: | ||
|
|
||
| ## Customer support | ||
|
|
||
| Support channels, contact details, hours, and escalation paths often differ by country or | ||
|
tokyojen marked this conversation as resolved.
|
||
| language. | ||
|
|
||
| ## Localization (l10n) vs. Internationalization (i18n) | ||
|
|
||
| Internationalization (i18n) is the technical preparation that makes localization possible without | ||
| code changes. Typical activities include separating translatable text from code, enabling | ||
| locale-aware formatting, supporting plural rules, and preparing layouts for text expansion and | ||
|
tokyojen marked this conversation as resolved.
|
||
| RTL. | ||
|
|
||
| Localization (l10n) is the adaptation of content and behavior for a specific market, language, or | ||
| region. Typical activities include translation, terminology review, adapting formats and units, | ||
|
tokyojen marked this conversation as resolved.
|
||
| checking imagery and legal content, and validating the user experience for the target audience. | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.