Editing an existing Style Guide
As an XTM Cloud Administrator, you can edit existing 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 in 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, find the required Style Guide.
Select the context menu icon
to the left of the relevant Style Guide's name. Next, from the dropdown, select Edit.
Alternatively, left-click in the relevant Style Guide's table row.
Result: the Edit Style Guide popup is displayed.
In the Edit Style Guide popup, make the required changes. For example, you can:
edit the Style Guide name in the mandatory Name text field. Ensure that it is unique and meaningful. It will help Project Managers to select the correct Style Guide for their project or project template. The field limit is 255 characters.
edit the 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: the edited Style Guide will be active.
cleared: the edited Style Guide will be inactive.
In the General rules tab screen, in the Edit Style Guide popup, make the required changes. For example, you can:
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 edit an existing general rule, select the required general rule and start typing in its text field. The character counter for that rule is adjusted automatically.
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.
There is no need to confirm each change separately. All changes will be noted and saved automatically once you select the Save button in the bottom right-hand corner of the Edit Style Guide popup.
define language-specific rules if it has not been done yet, and it is now required. 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 Edit Style Guide popup, make the required changes. For example:
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 edit an existing language-specific rule, select the required rule and start typing in its text field. The character counter for that rule is automatically adjusted.
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, within the limit. These are:
/,\, and"– each occurrence takes 2 characters.emojis – each occurrence can take up to 11 characters.
There is no need to confirm each change separately. All changes will be noted and saved automatically once you select the Save button in the bottom right-hand corner of the Edit Style Guide popup.
repeat these steps for every required target language. If you do not add any rules for a language in the Language-specific rules dropdown, this language will be deleted from the list when you save changes to the 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 make all required changes to the selected Style Guide, in the bottom right-hand corner of the popup, select Save.
Result: your changes to the Style Guide are saved. They are automatically applied to all projects and project templates in which they are used. Project Managers will NOT be informed automatically about the changes that you have made. We recommend that you inform them. If required, you can:
list all existing Style Guides. For details, see Listing all existing Style Guides.
add a new Style Guide. For details, see Creating a new Style Guide.
activate a Style Guide (if the Style Guide has been created as 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.
delete a Style Guide. For details, see Deleting an existing Style Guide.