Skip to content

Commit ef158ba

Browse files
improved wordings on the locale docs
1 parent 620dcc7 commit ef158ba

File tree

2 files changed

+43
-31
lines changed

2 files changed

+43
-31
lines changed

en/includes/guides/branding/localization/add-remove-locales.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ You can add or remove language support to customize the user interface for diffe
44

55
{% raw %}
66

7-
### Authentication, Recovery & Accounts endpoints {#add-remove-locales-in-authentication-recovery-accounts-endpoints}
7+
### Authentication, recovery & accounts endpoints {#add-remove-locales-in-authentication-recovery-accounts-endpoints}
88

99
{% endraw %}
1010

1111
Configure localization for authentication, recovery, and accounts endpoints using traditional properties files.
1212

1313
#### Add a locale to endpoints
1414

15-
Follow these steps to add a new language to your authentication, recovery, and accounts endpoints:
15+
To add a new locale to the authentication, recovery, and accounts endpoints:
1616

1717
##### Step 1: Create locale-specific resource files
1818

en/includes/guides/branding/localization/localization-overview.md

Lines changed: 41 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
# Localization in {{ product_name }}
22

3-
{{ product_name }} enables a language picker on the following interfaces exposed to business users, allowing business users to select their preferred language.
3+
{{ product_name }} lets you pick the language for the following interfaces exposed to business users.
44

5-
- Interfaces related to the business user registration/sign-up flow, login flows (including MFA), and the account recovery flow.
6-
- Interfaces of the self-care portal (My Account)
5+
- User registration, sign-up, login and the account recovery flows.
6+
- Self-care portal, **My Account**.
77

88
The **default language** on these interfaces is configured as explained in the [language settings](#language-settings) section.
99

1010
!!! note "Important"
11-
When [user attributes]({{base_path}}/guides/users/attributes/manage-attributes/) configured on {{ product_name }} are displayed to users (during user sign-up and consent management flows), only the default user attributes get translated.
1211

13-
These interfaces are i18n-supported, which allows {{ product_name }} to update the text content from i18n resource files. This feature allows your business users to experience these use cases in their preferred language. The languages that {{ product_name }} currently supports are listed below.
12+
In the user **sign-up** and **attribute consent** screens, {{product_name}} only translates the default user attributes.
13+
14+
These interfaces support i18n, allowing {{product_name}} to load text content from i18n resource files. This ensures that your business users can experience these use cases in their preferred language.
1415

1516
## Supported languages
1617

17-
Below are the languages currently available for the i18n-supported user interfaces of {{ product_name }}.
18+
{{product_name}} provides i18n-supported user interfaces in the following languages.
1819

1920
<table>
2021
<tr>
@@ -99,46 +100,53 @@ Below are the languages currently available for the i18n-supported user interfac
99100
</tr>
100101
</table>
101102

102-
## Language settings
103+
## Configure language settings
103104

104-
The following methods can set the language used by {{ product_name }} interfaces exposed to business users.
105+
You can use the following language settings to configure the {{product_name}} interfaces exposed to the business user.
105106

106107
### Language switcher
107108

108-
The language switcher is available at the footer of the (i18n-supported) {{ product_name }} interfaces, which allows business users to select the preferred language for {{ product_name }}.
109+
Users can use the language switcher available at the footer of the i18n-supported {{ product_name }} interfaces to select the preferred language.
110+
111+
!!! note
109112

110-
Note that {{ product_name }} will remember the language selected from this switcher, and it will be applied to all i18n-supported interfaces.
113+
{{ product_name }} remembers this setting and applies it to all i18n-supported interfaces.
111114

112115
### Browser-level settings
113116

114-
{{ product_name }} interfaces automatically adapt to the language preference set in the user's browser, as long as the language is supported by {{ product_name }}. However, the user can still change the language on the {{ product_name }} interfaces by using the [language switcher](#language-switcher).
117+
{{product_name}} automatically adapts to each user's browser language preference as long as it's a supported language. Users can still manually change the language using the [language switcher](#language-switcher).
115118

116119
### Application-level settings
117120

118-
As an application developer, you can configure the application to send the `ui_locales` parameter in the sign-in request or authorization request when the user signs in to the application.
121+
You can configure the application to send the `ui_locales` parameter in the sign-in or authorization request when a user signs in to the application.
122+
123+
It works as follows,
124+
125+
- You provide a list of strings, separated by a space, to define the locales.
126+
127+
- {{ product_name }} searches through the list until it finds a supported locale.
128+
129+
- If found, {{product_name}} sets that language as the default locale. If not, it uses the [browser-level](#browser-level-settings) setting.
119130

120131
!!! note "Important"
121-
The `ui_locale` parameter is only available for OIDC flows and not for SAML flows.
122132

123-
You can provide a list of strings, separated by a space, to define the locales. {{ product_name }} will search through the list until an {{ product_name }}-supported locale is found, and the first {{ product_name }}-supported locale in the list will be used as the default locale. If a supported locale is not found, {{ product_name }} will use the [browser-level locale](#browser-level-settings).
133+
The `ui_locale` parameter works only with OIDC flows and not with SAML flows.
124134

125135
Consider the following examples:
126136

127-
- If the `ui_locales` is sent as `fr_FR`, **French** is used as the default locale.
128-
- If the `ui_locales` is sent as `fr_FR en_US`, **French** will be the default locale since it's the first {{ product_name }}-support locale in the list.
129-
- If the `ui_locales` is sent as `it_IT en_US`, **English (en_US)** will be used as the default locale because the first given locale (`it_IT`) is not supported.
137+
- If the `ui_locales` set to `fr_FR`, {{product_name}} sets **French** as the default locale.
138+
- If the `ui_locales` set to `fr_FR en_US`, {{product_name}} sets **French** as the default locale since it's the first language in the list that {{ product_name }} supports.
139+
- If the `ui_locales` set to `it_IT en_US`, {{product_name}} sets **English (en_US)** as the default locale as it doesn't support `it_IT`.
130140

131-
The following examples demonstrate how to set the `ui_locales` parameter in your application.
141+
The following examples show how to set the `ui_locales` parameter in your application.
132142

133-
- **Example 1:** Setting the default locale from the `signIn` request.
143+
- **Example 1:** Using the SDK.
134144

135-
You can send the `ui_locales` in the signIn request as a parameter.
145+
The following sample illustrates how to set the `ui_locales` parameter in the `signIn` request using the JS/React SDK.
136146

137147
!!! note
138148
Learn more about [setting the signIn request](https://github.com/asgardeo/asgardeo-auth-spa-sdk#signin){:target="_blank"} using the {{ product_name }} SDKs.
139149

140-
The following sample illustrates the `signIn` request using the JS/React SDK.
141-
142150
``` Js
143151
<SecureApp
144152
fallback={<div>Loading</div>}
@@ -152,13 +160,17 @@ The following examples demonstrate how to set the `ui_locales` parameter in your
152160
</SecureApp>
153161
```
154162

155-
- **Example 2:** Setting the default locale from the authorization request.
163+
- **Example 2:** Directly in the authorization request.
156164

157-
If you are sending the locale in the authorization request directly, you can append the `ui_locales` query parameter with the list of locales as shown below.
165+
You can append the `ui_locales` directly in the authorization request as a query parameter as shown below.
158166

159-
```
160-
{{ product_url_format }}/oauth2/userinfo?scope={scope}&response_type=code&redirect_uri={redirect_uri}&client_id={client_id}&ui_locales={ locales list }
161-
```
167+
```
168+
{{ product_url_format }}/oauth2/userinfo?scope={scope}\
169+
&response_type=code\
170+
&redirect_uri={redirect_uri}\
171+
&client_id={client_id}\
172+
&ui_locales={ locales list }
173+
```
162174
163-
!!! note "Privacy policy and Terms of conditions URLs"
164-
The privacy policy and terms of conditions URLs are specified in your [branding configurations]({{base_path}}/guides/branding/configure-ui-branding/#advanced-preferences). The `ui_locales={ locales list }` parameter is appended to these URLs, which allows you to show the translated content for the user from your end.
175+
!!! note "Translation of privacy policy and terms of conditions"
176+
{{product_name}} attaches the `ui_locales={ locales list }` parameter to the privacy policy and terms of condition URLs set in the [branding configurations]({{base_path}}/guides/branding/configure-ui-branding/#advanced-preferences). This allows you to show users the translated content.

0 commit comments

Comments
 (0)