Internationalization & Localization

Internationalization (i18n) is the process of designing software applications so that it can be adapted to various languages and regions without engineering changes. Localization (l10n) is the process of adapting internationalized software for a specific region or language by adding locale-specific components and translating text.

Here are a number of guidelines for designing content with international audiences in mind:

Flags

Avoid using flags to represent languages, language and country are different concepts. Flags are symbols that represent countries or nations while languages represent a shared method of communication between people. For example, Spanish is spoken in 29 countries and Spain is only one of them. Countries like Canada have more than 1 official language, hence is not suitable to be represented by a single flag.

When designing a language selector, use plain text despite its lack of visual appeal. Only use flags to represent countries, not languages. Language names in the select component should always appear in that language in order to make it easy for users to always be able to return to their language of chose regardless of the current language selected. e.g English will always be labelled as ‘English’ even if Hebrew is selected as the current language.

Right to Left

In certain languages like Arabic and Hebrew, text is read from right-to-left (RTL) necessitating your entire design to be flipped. A modular design approach will come in handy while accommodating RTL languages. For example, the application below is designed to flip neatly for Hebrew and other RTL languages as shown below:

When localizing for RTL, the elements below should be mirrored:

• Horizontally positioned sections

• Text (from LTR to RTL)

• Text fields icons should be displayed on the opposite side of a field

• Navigation and menu buttons should be displayed in reverse order

• Icons that communicate direction, like arrows, should be mirrored

the elements below should not be mirrored:

• Vertically positioned sections

• Clocks

• Video/audio controls and timeline indicators

Most of the recent native frameworks are now mirroring aware, making it easier to create a mirrored layout with very limited code changes.

Text Expansion

Always design with text expansion in mind. When English text gets translated to another language, the translated text can be as much as three times longer. Make UI components expandable whenever possible. Do not assign a fixed-width or height to your UI component unless you have a good reason to.

For longer text, wrapping is a good solution. Be aware of the potential vertical expansion since translated text will take more lines. Truncation with hover text can be a compromise. Be aware that this brings the risk of making the UI less effective.

Length and Size

The general rule for text expansion is: “the shorter the English text, the longer the translated text is likely to be”. The following table shows the average text expansion rate for different English text lengths:

English word expansion guidelines

In addition to English text length, the target language also has an impact upon the amount of expansion. The following table shows the expansion factor for the English text “Share” into various languages:

Expansion factor for the English word “Share”

In general, Asian languages are more space-friendly since they tend to be more compact than European languages.

Date and Time

Date and Time should always be stored in UTC to allow it to be converted and displayed in multiple time zones. LUX components and guidelines follow the conventions detailed below by default:

• Basic date format: dd/mm/yyyy. For example 03/08/2017.

• For the current day and the day before that, the default is Today and Yesterday.

• Basic time format: 00:00 PM/AM. For example 05:55 AM.

• For combined date and time the default uses the word at. For examples: 03/08/2017 at 00:55 AM or Yesterday at 12:55 PM.

All applications built for Verint should allow the above defaults to be automatically changed based on the users specified browser locale (or manual setting if an application allows it). Details of country and region specific conventions are available here.

Many frameworks and libraries (such as Moment.js) offer full and constantly updated internalization features for easy localization of dates and times.

Decimals

Despite being the conventional standard (and the LUX default) Great Britain and the United States are two of the few places in the world that use a period to indicate the decimal place. Many other countries use a comma instead. Likewise, while the UK and US use a comma to separate groups of thousands, many other countries use a period instead, and some countries separate thousands groups with a space.

As with Date and Time above, all applications built for Verint should allow the decimal character defaults to be automatically changed based on the users specified browser locale (or manual setting if an application allows it). Details of country and region specific conventions are available here.

Headers

Content Headers

Headers are titles and subtiles used to illustrate the importance of a section or page. The underlying heading order is used to index the structure and content of your applications pages for assistive tools.

In LUX, all headers should be at the same size as its corresponding section text using the matrix below. Headers one stop higher (two at most) than the section text may be used when there is no exact match or extra emphasis is required for that specific section.

Accessibility

To add to our general compliance information in Fundamentals - Accessibility, here are a few extra factors to follow for accessible headers:

• Don't skip HTML heading hierarchy levels in order to comply with screen reader guidelines.

• Use title case capitalization (see Capitalization section below).

Labels

Effective form labelling helps users understand what information to enter into a form Input. Using a placeholder text as a label is often applied as a space-saving method. However, this is not recommended because it hides context and can present accessibility issues. Use of placeholder labels should be restricted to forms in which field purpose is a universal standard and accessibility can be guaranteed e.g. login forms.

• Provide a text label, left aligned to its associated field. Checkbox and Radio buttons are exceptions to this rule.

• In situations when horizontal UI real estate is scarce or responsive design is used, render the label above it’s associated field.

• Ensure that all labels and associated fields are vertically aligned as columns in a table

Required fields

It’s well known that users don’t always read instructions, and they are particularly less likely to read instructions at the top of a form. Form fields are primarily self-sufficient and each field has a specific instruction — its label, hence all required fields should be marked in close proximity with its associated label.

• Provide a star (asterisk) symbol positioned in superscript.

• Use the Verint warning color with the star symbol to identify it’s necessity.

Accessibility

To add to our general compliance information in Fundamentals - Accessibility, here are a few extra factors to follow for accessible labels:

• Use the appropriate HTML <label> element and label for attribute.

• Labels must remain visible when an input gets focus.

• Labels must be announced to the screen reader on focus.

• Ensure the helper text that appears under an input is read when an assistive technology user stops at an input using ARIA.

• Use sentence case capitalization (see Capitalization section below).
  

Capitalization

We use different capitalization styles for different types of content to improve scannability, organize information, and guide users to key actions.

When building new LUX applications, also align capitalization practices with platform conventions to match user expectations (e.g. IOS specific conventions).

Styles

Title Case (Most Words Are Capitalized)

Use title case for menu labels, buttons, navigation, and section headers.

Do capitalize

• The first letter of nouns, adjectives, verbs, adverbs, and pronouns

• The first and last words of the text element

• The second word of a hyphenated compound unless it is an article or preposition (for example: “Quick-Search Options” and “Add-on Choices”).

Don’t capitalize

• Articles (“a,” “an,” “the”) or prepositions with fewer than five letters (“to,” “on,” “at,” “by,” “from”) unless they’re the first or last words of the text element.

Sentence Case (Most words are lowercase)

Use sentence case for all body copy, image captions, and secondary, editorial subheadings.

Only capitalize the first word of the text element, as well as any proper nouns.