Portal dictionary

The portal dictionary stores captions, messages, tooltips, and other text constants used across most front-end and backoffice elements. You can use it to customize default texts constant as well as localize them for multiple languages.

  Note

Some content configuration-related captions, such site node names, titles, subtitles, field captions, email and notification templates, etc., are localized using the built-in configuration localization functionality. 

The dictionary can be exported in the CSV format for editing purposes, and then imported back into your portal.

  Caution

After a portal update is deployed, the default dictionary items are applied. This will overwrite your changes. Consult the Xpand Portal team for information on how to preserve your custom changes.

Edit the portal dictionary in the backoffice

You can change the dictionary items directly from the backoffice.

To edit the dictionary:

  1. In the backoffice, go to Translation. This opens the dictionary overview where you can see which portal dictionary items are missing and for which languages. Languages available in the portal dictionary are the ones that were added in Settings > Languages. The dictionary overview can always be opened by selecting Dictionary in the top left corner of this area. The dictionary contains the following sections:
    • Customized Dictionary - This section stores captions, messages, tooltips, and other text constants for custom functionalities. For example, captions of custom buttons in portal modules.
    • XPortal.Backend - This section stores captions, messages, tooltips, and other text constants for the backoffice.
    • Xportal.Frontend - This section stores captions, messages, tooltips, and other text constants for the front end.


Icon meaning:
 - A dictionary entry value is missing for this entry and language.

 - A dictionary entry value is available for this entry and language.

  1. Expand a dictionary section and locate the dictionary entry that you want to customize or fill in with localized text. Alternatively, use the search box to find and entry, and them select a dictionary entry name to open it.
  2. Change or add a localized dictionary entry text in the text box of the corresponding portal language.
  3. Select Save to save your changes.

Export the portal dictionary

You can export the dictionary in the CSV format. Exporting the dictionary may be useful when you need to make multiple changes throughout the dictionary.

To export the dictionary:

  1. In the backoffice, go to Settings, and select the More button in the bottom right corner.
  2. Select the action under Export or import dictionary items.
  3. Under Export dictionary items, select Export.
  4. On the Portal Settings tab, select Export.
  5. Browse to a location, and then select Save.

The exported CSV file with dictionary items is opened in Microsoft Office Excel.

Edit the dictionary in a CSV file

After exporting the dictionary, edit the CSV file, and then import it to the portal. It is recommended that you save the backup file before editing in case something goes wrong. 

You can only edit the existing dictionary entries; new entries cannot be created manually, as you will not be able to import such a file.

  Important

Do not edit the first three columns of the exported file, which contain the key, ID and name of each dictionary entry. Changing them may result in incorrect operation of the dictionary.

Import a dictionary file

To be able to successfully import an edited dictionary file, it must have the same structure as the exported file, with the same key, ID, and name of each dictionary entry.

To import the dictionary:

  1. In the backoffice, go to Settings, and select the More button in the bottom right corner.
  2. Select the action under Export or import dictionary items.
  3. Under Import, select Choose file.
  4. Browse to a dictionary file, and then select Open.