Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Why are some inline tags grouped? Why are there inline tags missing at the beginning or end of the segment?

Inline tag grouping in XTM Cloud is a feature designed to minimize the number of inline tags displayed in a segment, so Linguists can concentrate on translation without worrying about tag placement. This feature is enabled by default and can be disabled globally, per file extension, without affecting TM matching, and does not require reanalysis.

Note

IMPORTANT!

Similarly, the hiding of leading and trailing inline tags is another feature intended to improve the translation experience. This can also be disabled globally, per file extension. Both features deactivate automatically if the grouped or hidden inline tags inserted in a translation or match are in a different order from the source file. However, it's important to note that leading and trailing inline tags cannot be hidden in segments with internal matches.

Which file formats can XTM Cloud process?

Visit the following XTM Cloud help page, to see what file formats are supported, for translation in XTM Cloud: Language codes (select your XTM version and search for the phrase: Language codes).

What should I do if the target file fails to generate or does not look as expected?

If the target file fails to generate or does not look as expected, this could be for several reasons. One common issue is the misplacement or lack of inline tags, which can cause target file generation to fail. To troubleshoot this, you can check if XTM Cloud is able to provide a reason for the failure by selecting Project EditorFiles → (select the relevant target language) → Target → (click on the red exclamation mark icon). If the message does not tell you what is wrong with the file, you can create a simple TEST project that is exactly the same as your original one and try to generate the target file there. If the target file still has the same problem, you should also check for any misplaced inline tags and try again.

Another issue could be that the target has been generated but will not open due to misplaced inline tags. To search for misplaced inline tags, select Project editorGeneral infoGeneral info, find the QA profile and edit it to deselect all checkboxes except for the Order of inline tags is changed or content is missing between inline tags in target segment checkbox in the Other section. Then, run the QA for the document, setting it to only list segments with warnings and review the segments to find any inline tags whose order has been changed incorrectly.

If target generation runs but never ends, this is likely to be due to stuck queues. In this case, you should raise a ticket with the XTM International Support team, on our Support Portal and provide the necessary information.

Lastly, if the target does not generate at all, the problem could be caused by headers. This issue is associated with the Initialization error in XTM Workbench. The solutions to this problem include reanalysis of the whole project or manual repair of the issue. More about it in this article: XTM Workbench – most common issues & troubleshooting.

What does the “not supported - without workflow” information mean in a project’s workflow?

...

This message means that the file intended for analysis is not supported by XTM Cloud. All the supported files formats are listed in Which file formats can XTM Cloud process?.

Can XTM Cloud process plural forms/ICU plural syntax, etc.?

Yes, XTM Cloud can localize plurals in several file formats including Android XML, DITA files, JSON with ICU syntax, PO/POT and stringdict. However, by default, plural localization is disabled. Plurals are grouped in keyword categories for naming forms: zero, one, two, few, many, and other. The other form is always required as it is used for something that does not match any other category.

How do I use a filter template in a project?

To use a filter template in a project, follow these steps:

  1. Open the project in the Project Editor.

  2. Select the General info tab.

  3. In the General info section, select the required filter template from the Filter template dropdown.

  4. Select Save to close the Project Editor.

  5. In the Project list, find the required project, click on its context’s menu, and select ActionsReanalyze project.

...

If the project has already been created, you can choose a filter template from the same dropdown in the project’s General info section. Remember to Save the change at the bottom of the page.

If you do not want to reanalyze the whole project, you can always upload a new file to it via the Files tab screen. This file can be added to the ones that are already present or replace one of them. In this case, only newly uploaded files are analyzed with new configuration rules. If you upload a file with the same name and extension as one of the source files, it will overwrite the content of the previous file during analysis.

The new or updated configuration is applied during the analysis step. If any changes are made to the configuration, full reanalysis of the project that was using this configuration must be performed to apply the changes to all the target languages/files.

Is there a difference between “parser” and “filter template”?

“Parser” and “filter template” are both broad terms for the file processing configuration, but in XTM Cloud, we use the term "filter template". You can either choose a project-level filter template (usually just called a filter template) or use a global configuration or a customer-specific configuration.

Can XLIFF source states be imported to XTM Workbench?

For XLIFF 1.2 files, the State attribute of a target element in a trans-unit is imported as a segment state in XTM Workbench. By default, signed-off is imported as completed, but we can also prepare a different mapping configuration if other XLIFF 1.2 states (as defined in the XLIFF standard) are preferred to be set as an XTM Workbench segment state. For more details, see How XLIFF/XLF Files are Handled as Source Files in XTM Cloud.

What is more, when uploading offline XLIFF files to a project, the relevant segments will be locked in XTM Workbench if any of the following attributes is used in the trans-unit node in the XLIFF file: xtm:locked="yes", xtm:locked="true", xtm:locked="y".

How do I change the segmentation in XTM Workbench?

If segments in XTM Workbench are separated with a dotted line, you might be able to merge them into one segment (by for example right-clicking on them), directly in XTM Workbench. Other changes will require reanalysis to be performed again. XTM International Support can change structure-based segmentation for any level or it can be changed at customer level, or globally, in the Analysis manager in the XTM Cloud UI. Sentence-based segmentation can be changed at any level in the Filter templates feature in the XTM Cloud UI, or by XTM International Support if you are unsure about regular expressions or not familiar enough with using them.

Why is the same segment processed differently in two languages?

The segment can be processed differently in different languages if it is a file with plurals (formats: Android XML, JSON with ICU syntax, PO, stringsdict (for more details, see How to configure plurals in XTM Cloud)). It is also possible that a source segment is the same but the inline tags are not grouped in one of the languages due to translation from a TM match.

Also, there might be different segmentation rules in different languages (e.g. one language is being segmented after a certain character, while the other is not).

Why am I unable to merge segments in XTM Cloud?

This might be for several reasons. One reason could be that the segments did not originate from the same paragraph in the source document. In XTM Workbench, segments from the same paragraph are separated by a dotted line, and only these can be merged. Segments from different paragraphs, separated by a solid line, cannot be merged. You can find more information about this in the following article: Merging/unmerging segments in XTM Workbench.

Another reason could be that one of the segments is in read-only mode, or one of them is a file repetition. These segments cannot be merged.

...

Currently, there is no option to enable/disable grouping tags at customer and/or project level. It can only be done at global level.

Inline tags in XTM are grouped together by default if they are bundled together. If during an initial analysis a TM match that has inline tags is populated to the target segment and the tags position themselves in a way that does not satisfy the grouping mechanism, they will be ungrouped. However, once the tags are moved next to each other again in the XTM Workbench session, the criteria for grouping tags are then satisfied and so redundant tags are removed.

Note

IMPORTANT!

Keep in mind that it is not possible to discriminate between types of inline tag that are grouped when using this option. All inline tags will always be grouped regardless of their type. For example:

  • span tag (e.g. span class="uitext">),

  • variable tag (e.g. <span class="uitext"><MadCap:variable name="flvar-product.SC" />).

Similarly, the hiding of leading and trailing inline tags is another feature intended to improve the translation experience. It can also be disabled globally, per file extension. Both features deactivate automatically if the grouped or hidden inline tags inserted in a translation or match are in a different order from the source file. However, it is important to note that leading and trailing inline tags cannot be hidden in segments with internal matches (Repetitions and Fuzzy Repetitions).

Which file formats can XTM Cloud process?

Visit the following XTM Cloud help page, to see what file formats are supported, for translation in XTM Cloud: Language codes (select your XTM version and search for the phrase: Language codes).

What should I do if the target file fails to generate or does not look as expected?

If the target file fails to generate or does not look as expected, this could be for several reasons. One common issue is the misplacement or lack of inline tags, which can cause target file generation to fail. To troubleshoot this, you can check if XTM Cloud is able to provide a reason for the failure by selecting Project EditorFiles → (select the relevant target language) → Target → (click on the red exclamation mark icon). If the message does not tell you what is wrong with the file, you can create a simple TEST project that is exactly the same as your original one and try to generate the target file there. If the target file still has the same problem, you should also check for any misplaced inline tags and try again.

Another issue could be that the target has been generated but will not open due to misplaced inline tags. To search for misplaced inline tags, select Project editorGeneral infoGeneral info, find the QA profile and edit it to deselect all checkboxes except for the Order of inline tags is changed or content is missing between inline tags in target segment checkbox in the Other section. Then, run the QA for the document, setting it to only list segments with warnings and review the segments to find any inline tags whose order has been changed incorrectly.

If target generation runs but never ends, this is likely to be due to stuck queues. In this case, you should raise a ticket with the XTM International Support team, on our Support Portal and provide the necessary information.

Lastly, if the target does not generate at all, the problem could be caused by headers. This issue is associated with the Initialization error in XTM Workbench. The solutions to this problem include reanalysis of the whole project or manual repair of the issue. More about it in this article: XTM Workbench – most common issues & troubleshooting.

What does the “not supported - without workflow” information mean in a project’s workflow?

...

This message means that the file intended for analysis is not supported by XTM Cloud. All the supported files formats are listed in Which file formats can XTM Cloud process?.

Can XTM Cloud process plural forms/ICU plural syntax, etc.?

Yes, XTM Cloud can localize plurals in several file formats including Android XML, DITA files, JSON with ICU syntax, PO/POT and stringdict. However, by default, plural localization is disabled. Plurals are grouped in keyword categories for naming forms: zero, one, two, few, many, and other. The other form is always required as it is used for something that does not match any other category.

How do I use a filter template in a project?

To use a filter template in a project, follow these steps:

  1. Open the project in the Project Editor.

  2. Select the General info tab.

  3. In the General info section, select the required filter template from the Filter template dropdown.

  4. Select Save to close the Project Editor.

  5. In the Project list, find the required project, click on its context’s menu, and select ActionsReanalyze project.

...

If the project has already been created, you can choose a filter template from the same dropdown in the project’s General info section. Remember to Save the change at the bottom of the page.

If you do not want to reanalyze the whole project, you can always upload a new file to it via the Files tab screen. This file can be added to the ones that are already present or replace one of them. In this case, only newly uploaded files are analyzed with new configuration rules. If you upload a file with the same name and extension as one of the source files, it will overwrite the content of the previous file during analysis.

The new or updated configuration is applied during the analysis step. If any changes are made to the configuration, full reanalysis of the project that was using this configuration must be performed to apply the changes to all the target languages/files.

Is there a difference between “parser” and “filter template”?

“Parser” and “filter template” are both broad terms for the file processing configuration, but in XTM Cloud, we use the term "filter template". You can either choose a project-level filter template (usually just called a filter template) or use a global configuration or a customer-specific configuration.

Can XLIFF source states be imported to XTM Workbench?

For XLIFF 1.2 files, the State attribute of a target element in a trans-unit is imported as a segment state in XTM Workbench. By default, signed-off is imported as completed, but we can also prepare a different mapping configuration if other XLIFF 1.2 states (as defined in the XLIFF standard) are preferred to be set as an XTM Workbench segment state. For more details, see How XLIFF/XLF Files are Handled as Source Files in XTM Cloud.

What is more, when uploading offline XLIFF files to a project, the relevant segments will be locked in XTM Workbench if any of the following attributes is used in the trans-unit node in the XLIFF file: xtm:locked="yes", xtm:locked="true", xtm:locked="y".

How do I change the segmentation in XTM Workbench?

If segments in XTM Workbench are separated with a dotted line, you might be able to merge them into one segment (by for example right-clicking on them), directly in XTM Workbench. Other changes will require reanalysis to be performed again. XTM International Support can change structure-based segmentation for any level or it can be changed at customer level, or globally, in the Analysis manager in the XTM Cloud UI. Sentence-based segmentation can be changed at any level in the Filter templates feature in the XTM Cloud UI, or by XTM International Support if you are unsure about regular expressions or not familiar enough with using them.

Why is the same segment processed differently in two languages?

The segment can be processed differently in different languages if it is a file with plurals (formats: Android XML, JSON with ICU syntax, PO, stringsdict (for more details, see How to configure plurals in XTM Cloud)). It is also possible that a source segment is the same but the inline tags are not grouped in one of the languages due to translation from a TM match.

Also, there might be different segmentation rules in different languages (e.g. one language is being segmented after a certain character, while the other is not).

Why am I unable to merge segments in XTM Cloud?

This might be for several reasons. One reason could be that the segments did not originate from the same paragraph in the source document. In XTM Workbench, segments from the same paragraph are separated by a dotted line, and only these can be merged. Segments from different paragraphs, separated by a solid line, cannot be merged. You can find more information about this in the following article: Merging/unmerging segments in XTM Workbench.

Another reason could be that one of the segments is in read-only mode, or one of them is a file repetition. These segments cannot be merged.

Last but not least, you might also mistakenly be trying to merge segments in the Review workflow step that does not allow for such actions (for more information see: What you can and cannot do in the Review step).

...

When translating in XTM Workbench, you might wonder why certain text is displayed in the editor twice. This is because of the existence of the so-called alternate content which is by default taken for translation by XTM (unless configured otherwise on your instance by the XTM International Support team). Such content is often a string of text that is contained within charts' or images' descriptions or within text boxes.

Take a look at the following screenshot which presents two segments, the first of which (70) is actual content and the second one (82) is its alternate content.

...

For more information about the alternate content, see: How are segments in MS Office files (Word, Excel, PowerPoint) extracted?.

How does XTM process newline tags? What does it look like in XTM Workbench and can I decide where to put them in the target text?

When your source file contains a newline tag (\n), such as in the Today is a \n sunny day., in the XTM Workbench, this text will appear as: today is a sunny day. Here, the \n tag is displayed as a whitespace character.

By default, XTM Cloud does not break segments on newline tags. The entire text remains in one segment, with the newline tag rendered as a white space.

However, we can configure XTM Cloud to handle newline tags in other ways, based on your preference:

...

Break Segments on \n:

  • If configured, the \n will cause the text to be split into separate segments in XTM Workbench. For example:

    • Segment 1: Today is a

    • Segment 2: sunny day.

Display \n as an Inline Tag:

...

or images' descriptions or within text boxes.

Take a look at the following screenshot which presents two segments, the first of which (70) is actual content and the second one (82) is its alternate content.

...

For more information about the alternate content, see: How are segments in MS Office files (Word, Excel, PowerPoint) extracted?.

How does XTM process newline tags? What does it look like in XTM Workbench and can I decide where to put them in the target text?

When your source file contains a newline tag (\n), such as in the Today is a \n sunny day., in the XTM Workbench, this text will appear as: today is a sunny day. Here, the \n tag is displayed as a whitespace character.

By default, XTM Cloud does not break segments on newline tags. The entire text remains in one segment, with the newline tag rendered as a white space.

However, we can configure XTM Cloud to handle newline tags in other ways, based on your preference:

  1. Break Segments on \n:

    • If configured, the \n will cause the text to be split into separate segments in XTM Workbench. For example:

      • Segment 1: Today is a

      • Segment 2: sunny day.

  2. Display \n as an Inline Tag:

    • We can make the \n visible as an inline tag rather than displaying it as a whitespace character. This allows the linguist to see the newline explicitly and decide where to place it in the target segment, while translating the text in XTM Workbench.

Why are some elements/fields/tags that exist in my source file absent from the target file?

XTM Cloud should retain all elements/fields/tags that exist in the source file, regardless of whether or not they are eligible for translation in XTM Workbench. If you state that some nodes from your source file are missing in the target file that you generated in XTM Cloud, it means that there are two possible scenarios:

  1. The data in question is absent from your source file in the first place, in which case you should double-check if this is truly the case. It might happen that clients overlook that fact when preparing source files for translation.

  2. There might be an issue on the XTM Cloud side that would need fixing. In such a case, once you have made sure that your source file does contain the nodes in question, do not hesitate to contact the XTM International Support team and describe the problem.