Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Each A Locale Key represents each text string that you see in the EmpowerID web UI is represented by a Locale Key. Developers use the Locale Key for locale keys for elements like titles, descriptions, and labels in across the UI, and the user interface (UI). The Localized Text page in EmpowerID allows you administrators to customize the default text and add translations for any languages you supportyour organization supports. 

Easy html macro
theme{"label":"solarized_dark","value":"solarized_dark"}
contentByMode{"html":"<!doctype html>\r\n<link href=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css\" rel=\"stylesheet\" integrity=\"sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC\" crossorigin=\"anonymous\">\r\n<link href=\"https://docs.empowerid.com/new_docs.css\" rel=\"stylesheet\">\r\n<script src=\"https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js\" integrity=\"sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM\" crossorigin=\"anonymous\"></script>\r\n<p class = \"bd-callout bd-callout-success\">The Default Value of a localized string is what appears by default, in the <b>en</b>, or English locale.</p>","javascript":"","css":".bd-callout {\n overflow:hidden;\n}"}

This article demonstrates localizing text by showing walks you through how to:

  1. Customize

strings
  1. Default Strings

  2. Localize Strings by adding translations for other supported languages.

Customizing Default strings

Customize strings

Customizing default strings in EmpowerID allows you to adjust terminology to suit your organization's needs better. In this example, a company already uses the word we’ll change the term "recertification" extensively for keeping up with educational and certification requirements for their industry. Therefore the company wants to substitute the word "attestation" for to avoid confusion in an industry where "recertification."" has specific connotations.

Follow these steps to customize a default setting:

  1. Access the Localized Text Page:

    • On the navbar, expand Admin > Miscellaneous and select Localized Text.

  2. Search for the String to Customize:

    • Select the Localized Strings tab and

then
    • use the search bar to find the term you want to modify. For this example, search for recertification.

  1. Edit the Locale Key Entry:

    1. Click the Key Entry Name link for the one you want to customize, for example, RecertificationRevokesAllDescription.

Image Removed
    1. Image Added

    2. On the View page for the Locale Key that appears, click the Edit button.

Image Removed
    1. Image Added

  1. Update the Default Value:

    • In the Default Value field, replace

recertification
    • “recertification” with

attestation
    • “attestation” and save your changes.

Localize

Localizing Strings for Specific Languages

Localization involves adding translated values for specific locales so that users can view the interface in their preferred language.

To localize a string is to add a translated value for a particular locale. This allows the string to be displayed in the preferred language of users with that locale., follow these steps:

  1. Search for the String to Localize:

    1. From the Find Locale Key Entry page, select the Localized Strings tab

and search
    1. .

    2. Search for the string you want to localize.

  1. Open the Locale Key for Editing:

    1. Click the Locale Key (Unique Name) link to open the View page for the string.

    2. On the View page, click the Edit link to put the string in Edit mode.


Image Removed

    1. Image Added

  1. Add or Update a Translation:

    1. Select the Translations tab

and then do one of the following:If you want to
    1. .

    2. To edit an existing translation, click the Edit button for the desired language

and then
    1. , update the value, and save

the new value
    1. your changes.

If you want to
    1. To add a new translation, click the Add New

(blue star) above the grid and then
    1. button, select the

appropriate
    1. language,

add
    1. enter the translation, and save.

      Image Added

Best Practices for Localizing Text

  • Consistent Terminology: Ensure that translated terms are consistent with industry-specific language

and save the new translation.
Image Removed
  • used by your organization.

  • Fallback Default: Always provide a default value for each locale key to ensure a fallback option when translations are missing.

  • Testing Translations: After adding or editing translations, verify changes by setting a user profile to the specific locale and viewing the updated text in the web UI.

Div
stylefloat:left; position:fixed;
idarticleNav

IN THIS ARTICLE

Table of Contents
maxLevel4
minLevel2
stylenone
printablefalse