Sitecore: Types of content item sent for translation in XTM Cloud

Introduction

Sitecore is quite a versatile CMS with regard to the way particular content items can be linked/referenced to one another within the system. Furthermore, they can be nested, which can create even more complex file system structures. Taking this into account, XTM Connect – Sitecore offers a great deal of flexibility in terms of the scope and volume of the Sitecore content that can be sent to XTM Cloud for translation at the same time.


How does the XTM connector select content items for translation?

Content item types distinguished by the connector

Let’s start with listing the content item types which are distinguished by the XTM connector so that they can be identified correctly when content is sent to XTM Cloud for translation:

  1. Main item → This is the item that you click on when sending your content to Add to queue.

  1. Sub-item → This item is a child item for your parent item.

  1. Component (related content) → This is an item that constitutes a part of a page. It can contain layout information such as content fields and placeholders, and their positions on the page, as well as business logic or metadata for the page. Typically, you reuse the same components on multiple pages.

  1. Linked item → This item is linked to, or otherwise references, your main item.

How is content selected for sending to XTM Cloud for translation?

The mechanism for content selection works in accordance with the following principles:

  1. The XTM connector analyzes the selected files and adds them to the queue in a top-down fashion.

  2. The connector checks the main item's components, then goes on to check the linked items and ends with sub-items.

  3. For each content item related to your main item, i. e. components, linked items and sub-items, the XTM connector performs the same process, i. e. it searches for the content item's components, then linked items, then sub-items, and so on and so forth.

  4. The XTM connector repeats this process for each content item included in the scope of content selected for translation until it reaches the last item. How far the XTM connector actually goes in its search depends on the hierarchy level configured in the Sitecore Settings section of the XTM connector settings (described in this article).

  5. In this way, a content tree is created, with the main item at its top, and content branches spreading out.

  6. XTM Connect – Sitecore has an in-built restriction that prevents the connector from processing a particular branch further if it detects the same item in it twice. If it does so, the connector stops checking the branch at that point and goes on to check the remaining branches. Otherwise, the connector might fall into an infinite loop if the repeated content item referred back to an item that had already been processed.


Content type options in Sitecore Settings

General information

As mentioned at the start of this article, XTM Connect – Sitecore provides quite a few options for controlling both the type and volume of the content sent to XTM Cloud for translation.

First and foremost, the configuration is performed in the Content view options in Add to queue section of the Sitecore Settings tab screen, in the XTM connector settings,. There are a couple of options to set:

Filter subitems

You can restrict the sub-items that are displayed to Translation requesters in the Add to queue dialog window. To do so, select one of these options:

  • Show all items,

  • Deselect items without presentation: these items are then displayed in the Add to queue dialog window, but not selected by default.

  • Hide items without presentation: these items are then not displayed in the Add to queue dialog window.

You can specify whether or not this option is to be selected by default, in the Add to queue dialog window.

The option is quite powerful as it enables you to combine multiple components and linked items, that refer to a particular main item, into one large source file in XTM Cloud. This is especially useful when you have dozens (or even hundreds) of small content items, as it makes them easier to translate.

EXAMPLE:

We have two projects to be sent to XTM Cloud for translation:

  1. The first project contains the following content items:

  • Main itemSajzik MainItem,

  • Main item’s component and its sub-itemSajzik Component, Sajzik ComponentSubItem.

The project is sent to XTM Cloud with the option Include related content (components) and linked content in the main item source file DESELECTED.

As a result, the project is created with three separate source files in XTM Cloud:

  1. The second project contains the very same files, but this time, it is sent to XTM Cloud with the option Include related content (components) and linked content in the main item source file SELECTED.

As a result, the project is created with one combined source file in XTM Cloud:

EXAMPLE:

We have two projects to be sent to XTM Cloud for translation:

  1. The first project contains the following content items:

  • Main itemSajzik MainItem,

  • Main item’s component and its sub-itemSajzik Component, Sajzik ComponentSubItem.

The project is sent to XTM Cloud with the option Include related content (components) and linked content in the main item source file DESELECTED.

As a result, the project is created with three separate source files in XTM Cloud:

  1. The second project contains the very same files, but this time, it is sent to XTM Cloud with the option Include related content (components) and linked content in the main item source file SELECTED.

As a result, the project is created with one combined source file in XTM Cloud:

IMPORTANT!

Keep in mind that the Include related content (components) and linked content in the main item source file option does not include a main item’s sub-items. Those are always kept as separate source files, in XTM Cloud.

That option is hidden in the UI if neither of these two related options is selected:

  • Include components and their subitems (components),

  • Include items that refer to the selected item (linked items).

Hierarchy level for subitems

The hierarchy level for sub-items option defines the maximum level of depth to which the XTM connector can go, to select sub-items of the main item for translation in XTM Cloud, in the Add to queue → Select subitems dialog window.

The hierarchy starts with 0 as your main item, 1 as the sub-item of your main item, 2 as the sub-item of the sub-item of your main item, etc. In other words, if you enter 2, the top level (main item) and the next two levels down (sub-item and sub-item’s sub-item) will be displayed.

 

Additionally, you can change the default configuration, set in the Sitecore Settings tab screen, by selecting the Filter subitems option.

The Hierarchy level for related content (components) option defines the maximum level of depth to which the XTM connector can go, to select the sub-items of a particular component for translation in XTM Cloud.

The hierarchy starts with 0 as your component, 1 as the sub-item of your component, 2 as the sub-item of the sub-item of your component, etc. In other words, if you enter 2, the top level (component) and the next two levels down (sub-item and sub-item’s sub-item) will be displayed.

Hierarchy level for items linked in across databases

The Hierarchy level for items linked in across databases option defines the maximum level of depth to which the XTM connector can go, to select sub-items of a particular linked item for translation in XTM Cloud.

The hierarchy starts with 0 as your linked item, 1 as the sub-item of your linked item, 2 as the sub-item of the sub-item of your linked item, etc. In other words, if you enter 2, the top level (linked item) and the next two levels down (sub-item and sub-item’s sub-item) will be displayed.

Include components and their subitems

You can decide whether or not this option will be selected by default, in the Add to queue dialog window.

While adding content to the queue in the Sitecore CMS, or submitting it straight to XTM Cloud, select this option if you also want to include components and their sub-items for translation.

Include items linked across databases

You can decide whether or not this option will be selected by default, in the Add to queue dialog window.

While adding content to the queue in the Sitecore CMS, or submitting it straight to XTM Cloud, select this option if you also want to include linked items and their sub-items for translation.

Only include components and linked items the first time they occur

This option is available only at Administrator level (the Sitecore Settings in the XTM connector settings).

As the label suggests, if you select this option, you will ensure that you will not include the same component or linked item twice, if they happen to be embedded in some other files as well.