Skip to content

String resources

String resources let administrators customise the text displayed throughout the platform. Whether you need to tailor messages to fit your brand's voice, accommodate different languages, or provide clearer instructions, string resources give you the flexibility to make changes.

Navigate to Settings > String Resources.

In the example below, string resources are used to change the language of the login screen.

Login screen translated via string resources

There are five things you can do with string resources:

  1. Change particular labels and text. Change the actual terms used by the CLS so they match your organisation. Customise instructions, warnings, and messages.
  2. Translate all labels and text. Use a different language for all labels and text. The CLS can be presented in completely different languages depending on the user's browser language.
  3. Inject a custom page into My Learning Dashboard. Develop a custom page and use it to customise the My Learning dashboard. Only available with the Smart Dashboard plugin.
  4. Customise the links in the footer of screens. Link to custom pages or external sites.
  5. Hide text. Hide text that's not part of the menu.

The CLS has a default set of terminology. For example, the primary categories are:

Default category terminology

Using string resources you can:

  • Rename Manage People to Staff Admin.
  • Rename a Group to a Cohort.
  • Translate error messages into terms your organisation is familiar with.

The CLS supports best-practice management of string resources — different instances of the same resource can be translated differently.

Edit string resources

Navigate to Settings > String Resources.

String Resources screen

Important note about language settings

The CLS checks the user's browser language setting to determine the string resources delivered. Ensure browsers are set to the correct language (for example, en-AU).

When you change string resources, the CLS notes its own language settings and links the updated string resources only to that language. Languages are set at Settings > Languages — see Languages.

Languages setting

There's a difference between English and English (Australian). If your user base contains different English cultures (for example, English (Ireland) and English (Caribbean)) and you want changes to target all English cultures, set the CLS to the parent category English before making changes.

English parent language

Inspect

After selecting Settings > String Resources you see a list of all possible string resources that can be changed.

  1. Search for a particular string resource. Narrow by plugin (for example, Janison.CompetencyManagement) and/or language (for example, en-AU).
  2. The list can be sorted by four headings:

    • Type — type of string resource.
    • Key — CLS internal name.
    • Value — the new value of the string resource. Blank if you haven't made changes.
    • Default Value — the default value.
  3. The icons let you edit the string resource.

    Inspect string resources

Edit a string resource

As an example, change the word Manage to Administer.

  1. Find the default value to alter.

    Find the default value

  2. Select the pencil icon to edit.

  3. Type Administer Learning into Value.
  4. Select Save String Resource.

    Edit string resource form

You can also select the lightning bolt to make the same change in the Quick edit screen:

Quick edit

  1. The change appears on the list under Value.

    Edited value in list

  2. A reset button is generated — use the cross icon to return the resource to its default value.

  3. Manage Learning has been changed to Administer Learning.

    Updated UI

Four links appear by default in the footer of each page.

Default footer links

To customise — for example, change the Privacy link to a link to the Janison website — navigate to Settings > String Resources.

  1. Search for Privacy.
  2. Select the pencil icon for the UI element PrivacyFooterLink.

    Edit privacy footer link

  3. Enter the HTML code specifying the new link.

  4. Select Save String Resource.

    Save footer link

The footer is updated. Selecting About Janison takes users to the Janison website.

Updated footer

The My Learning dashboard is where learners access their catalogue enrolments. You can add a custom page to the top.

Locate and update the string resource with key JService/UiElements.DashboardIntro. A more detailed guide is in Custom Pages Modules.

Example with a custom page linked:

Custom page on My Learning

Hide text

Inserting a non-breaking space ( ) into the Value field hides the text.

Note

Text in menus is hidden using a custom menu at Settings > Menu.

Hiding text with non-breaking space

Settings

This page is itself the Settings documentation for string resources. All operations are at Settings > String Resources.

Related settings:

Languages (Settings > Languages) — controls the default culture, which in turn determines which string resources are displayed.