Dictionary Items

Creating Dictionary Items in Umbraco

Depending on how your site is set up, not all content is edited through the Content section. There might be some text in your templates or macros that needs translation. Using Dictionary Items, you can store a value for each language. Dictionary Items have a unique key that is used to fetch the value of the Dictionary Item.

Dictionary Items can be managed from the Translation section. Let's take a look at an example. In this example, we will translate "Welcome to Umbraco" from within the template and add it to the dictionary:

Adding a Dictionary Item

To add a Dictionary Item:

1. Go to the Translation section.

2. Click on Dictionary in the Translation tree and select Create.

3. Enter the Name for the dictionary item. Let's say Welcome.

   
4. Click Create.

5. Enter the values for the different language versions.

   
6. Click Save.

Grouping Dictionary Items

To group dictionary items:

1. Go to the Translation section.

2. Click on Dictionary in the Translation tree and select Create.

3. Enter the Name for the dictionary item. Let's say Contact.

4. Click Create.

5. Click on Contact and select Create.

6. Enter the Name of the item to be created under the Contact group.

7. Click Create.

8. Enter the values for the different language versions.

   
9. Click Save.

Editing Dictionary Items

To edit a dictionary item, follow these steps:

1. Go to the Translation section.

2. Use the Dictionary tree to locate the item you need to update/edit.

   • Alternatively, you can use the search field in the top-right corner.

3. Make the edits you need to make.

4. Click Save to save the changes.

It will only be possible to edit the language(s) that the given user has access to. The value of the remaining languages will be read-only.

Which language a user has access to is determined by the "Language permissions" set on the User Group. Learn more about this feature in the Users article.

Using Dictionary Values in Document Types

In some cases, you might want to render the dictionary values in the Document Type. This is to display the labels depending on the language configured for the logged-in user.

To use dictionary values in the Document Type, follow these steps:

1. Go to the Settings section.

2. Open the Document Type where you want to use the Dictionary value.

3. Locate the label and type #MyDictionaryKey. For example: #Welcome or #WelcomeDescription.

Using Dictionary Value in Document Type

1. Click Save.

2. Go to the Content section.

3. View the content node using the Welcome property. The property will display the dictionary value per the user's configured backoffice language.

You can translate tabs and property groups in the backoffice as well. For more information, see How to Translate Umbraco Backoffice Document Types video.

Fetching Dictionary Values in the Template

To fetch dictionary values in the template, replace the text with the following snippet:

@Umbraco.GetDictionaryValue("Welcome")

Rendering dictionary item

Alternatively, you can specify an altText which will be returned if the dictionary value is empty.

@Umbraco.GetDictionaryValueOrDefault("Welcome", "Another amazing day in Umbraco")

Rendering dictionary item

Importing and exporting Dictionary Items

In some cases, you might want to use the same Dictionary Items on multiple Umbraco websites. For this, you can use the export and import functionality to quickly copy the items from one website to another.

Exporting Dictionary Items

1. Go to the Translation section in the Umbraco backoffice.

2. Locate the Dictionary Item (or group) you want to copy in the section tree.

3. Right-click the item.

4. Select Export....

5. Decide whether you want to also include descendants.

6. Click Export.

This will download a .udt file which you can use to import the Dictionary items on another Umbraco website.

Right-click the Dictionary Item to open the options menu with the Export feature

Importing Dictionary Items

1. Go to the **Translation section in the Umbraco backoffice.

2. Right-click on the top of the Dictionary tree.

3. Select Import....

4. Click on Import.

5. Find and select the .udt file containing the Dictionary Items.

6. Click Open in the file browser.

7. Review the Dictionary Items for import.

8. Choose where to import the items.

9. Click on Import.

The Dictionary Items have now been added to your website.

Review the Dictionary Items for import before confirming

Using Dictionary Item in a Multilingual website

To use Dictionary Items in a multilingual website, see the Creating a Multilingual Site article.

Related Links

• API reference for the DictionaryItem

• Localization Service

• Creating a Multilingual Site