|
1 | 1 | {% set product_url_format = "https://localhost:9443" %} |
2 | | -{% include "../../../../../includes/guides/branding/localization.md" %} |
| 2 | +{% include "../../../../../includes/guides/branding/localization/localization-overview.md" %} |
3 | 3 |
|
4 | | -## Configuring localization for authentication endpoints |
| 4 | +{% include "../../../../../includes/guides/branding/localization/add-remove-locales.md" %} |
5 | 5 |
|
6 | | -WSO2 Identity Server provides internationalization support for its web applications (such as the authentication endpoint located in the `<IS_HOME>/repository/deployment/server/webapps/` directory). The following steps describe how you can configure this: |
7 | | - |
8 | | -1. Navigate to `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/org/wso2/carbon/identity/application/authentication/endpoint/i18n/` |
9 | | - |
10 | | -2. Duplicate the `Resources.properties` file in the same location and rename it with the required locale suffix as follows: |
11 | | - - For British English: `Resources_en_GB.properties` |
12 | | - - For French (Standard): `Resources_fr.properties` |
13 | | - |
14 | | - !!! note |
15 | | - |
16 | | - Refer to [Web browser language identification codes](https://www.localeplanet.com/icu/){target="_blank"} for more information on locale suffixes. |
17 | | - |
18 | | -3. Update the values for each key as follows: |
19 | | - ``` |
20 | | - login=<Value in the required locale> |
21 | | - ``` |
22 | | - |
23 | | -4. Save the file. |
24 | | - |
25 | | -5. Navigate to `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/` and open the `LanguageOptions.properties` file. |
26 | | - |
27 | | -6. Add information about the new language in the following format & save the file. |
28 | | - ``` |
29 | | - <language switcher name>=<language code>,<language name>,<text direction>` |
30 | | - ``` |
31 | | - |
32 | | - !!! note |
33 | | - |
34 | | - - `<text direction>` is optional. |
35 | | - - The default text direction is set to "ltr" (Left-to-Right). To enable support for Right-to-Left (RTL) languages, refer to the documentation on [Right-to-Left (RTL) Language Support]({{base_path}}/guides/branding/localization/#right-to-left-rtl-language-support) for detailed instructions. |
36 | | - |
37 | | -7. Go to the browser settings and add the language you configured above. |
38 | | - |
39 | | -8. Restart the server. To try out, do the following: |
40 | | - 1. Open up a browser. |
41 | | - 2. Type the My Account portal URL. (If you are running the server in your localhost, the URL is: [https://localhost:9443/myaccount/](https://localhost:9443/myaccount/)). You will see the login screen having the contents in the configured language. |
42 | | - |
43 | | -## Configuring localization for recovery endpoints |
44 | | - |
45 | | -You can enable localization for `accountrecoveryendpoint` by applying the same steps 1 through 8 in the previous [section](#configuring-localization-for-authentication-endpoints), for the following location: |
46 | | - |
47 | | -`<IS_HOME>/repository/deployment/server/webapps/accountrecoveryendpoint/WEB-INF/classes/org/wso2/carbon/identity/mgt/recovery/endpoint/i18n/`. |
48 | | - |
49 | | -Update the LanguageOptions.properties file located at: `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/LanguageOptions.properties` to include the new language options. |
50 | | - |
51 | | -## Right-to-Left (RTL) Language Support |
52 | | - |
53 | | -{{product_name}} supports Right-to-Left (RTL) languages like Arabic, Hebrew, and Persian, ensuring login and recovery screens dynamically adjust their layout and text direction for a seamless user experience. When an RTL language is selected, the interface, including text alignment and content flow, automatically mirrors to follow RTL formatting conventions. |
54 | | - |
55 | | -If you need to enable Right-to-Left (RTL) support for a language in authentication and recovery endpoints, follow these steps: |
56 | | - |
57 | | -1. Navigate to the following directory based on the endpoint you want to configure: |
58 | | - |
59 | | - - Authentication endpoint: `<IS_HOME>/repository/deployment/server/webapps/authenticationendpoint/WEB-INF/classes/` |
60 | | - - Recovery endpoint: `<IS_HOME>/repository/deployment/server/webapps/accountrecoveryendpoint/WEB-INF/classes/` |
61 | | - |
62 | | -2. Open the `LanguageOptions.properties` file. |
63 | | - |
64 | | -3. Add the ,rtl suffix to the language entry in the file. For example, to enable RTL for Arabic, update the entry as follows: |
65 | | - |
66 | | - ```text |
67 | | - lang.switch.ar_AE=ar,Arabic - العربية,rtl |
68 | | - ``` |
69 | | -
|
70 | | -4. Save the file and restart the server for the changes to take effect. |
71 | | -
|
72 | | -This will apply RTL formatting for the specified language across authentication and recovery endpoints. |
| 6 | +{% include "../../../../../includes/guides/branding/localization/configure-text-direction.md" %} |
0 commit comments