Creating a new Style Guide
As an XTM Cloud Administrator, you can add new global-level Style Guides, which can be used by Project Managers for projects and in project templates. To do so, follow the procedure below.
Important
The old Style Guide solution, created on the basis of the custom field (for details, see Data – Custom fields – Project custom fields), will be deprecated from XTM Cloud version 26.2.
If a Project Manager uses both the old and new Style Guide solution for their project, the old Style Guide will be ignored.
Note
You can access, create and manage Style Guides in the Style Guide tab screen, even if the AI Translate & TQI feature is not enabled in your XTM Cloud instance. However, the data that you enter in this tab will not be used anywhere.
Select Configuration > Settings > AI Control Center.
Select the Style Guide tab.
In the Style Guide tab screen, select the Add Style Guide button.
Result: the Add Style Guide popup is displayed.
In the Add Style Guide popup:
enter a unique, meaningful Style Guide name in the mandatory Name text field. It will help Project Managers to select the correct Style Guide for their project or project template. The field limit is 255 characters.
if required, enter a more detailed Style Guide description in the optional Description text field. This field will NOT be displayed for Project Managers, but it can help you differentiate between different Style Guides. It is also NOT passed to LLMs as part of the Style Guide. The field limit is 3000 characters.
use the mandatory Active checkbox:
selected (default): the new Style Guide will be automatically active. You can deactivate it at a later stage. For details, see Deactivating an existing Style Guide.
cleared: the new Style Guide will be inactive. You can activate it at a later stage. For details, see Activating an existing Style Guide.
select Next in the bottom right-hand corner of the Add Style Guide popup.
Result: the basic Style Guide settings are saved in the Settings tab screen, in the Add Style Guide popup. The General rules tab screen is now displayed.
In the General rules tab screen, in the Add Style Guide popup:
add up to 20 general rules, with up to 200 characters per rule. These rules will apply for all target languages in the project in which this Style Guide is used.
To add a new general rule, type your instruction in the text field at the top of the General rules tab screen. Then, select Add to the right of the text field. Your new general rule is added and listed below the text field. Rules are displayed in order, from the oldest to the newest.
To delete a general rule, select the trash can icon
to the right of it. The Confirm popup is displayed. In it, select Delete to confirm. As a result, the rule is deleted, and it is no longer displayed in the General rules tab screen.
Important
Some characters that you insert in the rule body will use more than 1 character, within the limit. These are:
/,\, and"– each occurrence takes 2 characters.emojis – each occurrence can take up to 11 characters.
if required, define language-specific rules. To do so, in the top right-hand corner of the General rules screen, select the Add language-specific rules button. Next, select one or more target languages from the list. When you do so, the Language-specific rules tab is displayed in the Add Style Guide popup. In it, you can manage all language-specific rules in your Style Guide.
In the Language-specific rules tab screen, in the Add Style Guide popup:
if you have previously selected multiple target languages, select the required target language from the Language-specific rules dropdown to set rules for that language.
for each target language, you can add up to 20 rules, with up to 200 characters per rule. These rules will only apply for the selected target language in the project in which this Style Guide is used.
Important
If there is ever a conflict between language-specific rules and general rules, the language-specific rules will take priority.
To add a new language-specific rule, type your instruction in the text field at the top of the Language-specific rules: [language name] tab screen. Then, select Add to the right of the text field. Your new rule is added and listed below the text field. Rules are displayed in order, from the oldest to the newest.
To delete a language-specific rule, select the trash can icon
to the right of it. The Confirm popup is displayed. In it, select Delete to confirm. As a result, the rule is deleted, and it is no longer displayed in the Language-specific rules: [language name] tab screen.
To delete all rules for the selected language, select the Delete rules for [language name] button. The Confirm popup is displayed. In it, select Delete to confirm. As a result, all rules for the selected language are deleted, and this language is no longer displayed in the Language-specific rules dropdown.
Important
Some characters that you insert in the rule body will use more than 1 character from the limit. These are:
/,\, and"– each occurrence takes 2 characters.emojis – each occurrence can take up to 11 characters.
repeat these steps for every required target language. If you do not add any rules or delete all existing rules for a language in the Language-specific rules dropdown, this language will be deleted from the list when you save your Style Guide. Also, if you delete all languages, the Language-specific rules tab will no longer be displayed: you cannot save an empty language-specific rule list.
Once you enter all required general and language-specific rules for your Style Guide, in the bottom right-hand corner of the popup, select Save.
Result: your new Style Guide is created. Project Managers can select it at project and project template level. If required, you can now:
edit a Style Guide. For details, see Editing an existing Style Guide.
activate a Style Guide if it has been set to inactive. For details, see Editing an existing Style Guide.
deactivate a Style Guide, if required, so that Project Managers can no longer use it for their projects. For details, see Deactivating an existing Style Guide.
list all existing Style Guides. For details, see Listing all existing Style Guides.
delete a Style Guide. For details, see Deleting an existing Style Guide.