First of all, you need to set up the plugin to proceed with further work
To start configuring the plugin,
go to “Apps” → “Manage Apps” or follow the link https://{{yourcompany}}.atlassian.net/wiki/plugins/servlet/upm
In the list of installed applications,
find “TranslateX Advanced for Confluence”
and click “Configure”
This section contains the general settings of the plugin
Deepl API Key - The API Key for the Deepl translation provider
The free plan includes translation of up to 500k characters per month. You can check the pricing details on the Deepl website: https://www.deepl.com/en/pro-api
Toggles:
Enable the entire plugin - Toggle for the entire service
Enable translation service - Determines whether the translation service is enabled
If the flag is off, newly pages will be published without translation
Enable glossary - The flag determines whether a custom glossary should be used during translation
If the flag is turned off, the translation will be run without glossary
*When adding rules, ensure that:
They do not overlap. In the case of a page change that meets both rules, the first one will be applied
The Target Destination does not belong to the branch defined in the Source. This could lead to a loop and an infinite number of attempts to create a new page
The main section that defines a set of rules by which the plugin will work and the translation will be carried out
Table "Sync Rules" - The previously added sync rules define the order in which pages will be translated & translations will be published
Button "Init" - Initializes the task for bulk translation of all pages in the Source branch
Init runs in the background and may take a long (~8 sec for each page)
Button "Edit" - Edits an extisting rule
Button "Delete" - Deletes an existing rule
Button “Add new rule” - Opens the pop-up for adding a new rule
Pop-up "Sync Rule"
The UI for adding or editing a sync rule
Mode - Dropdown list:
Auto - a mode in which any change to the source page will automatically trigger the creation or update of the translated page
Manual - a mode in which the translation of a page can only be initiated manually by clicking the "Translate Page" button in the page management UI
Lang From - Selection of the original language
Lang To - Selection of the target language
Choose source page or space - The page or space that will define the subset of pages within the space to be translated
Searchable by page name, space code or URL
Choose target page or space - The Confluence space where the translations will be published
Searchable by page name, space code or URL
Page Prefix - The automatically added prefix to the title of each translated page
(example: "[RU]: ")
Page Suffix - The automatically added suffix to the title of each translated page
(example: " - translated")
DISCLAIMER
To use this feature you must have Confluence Premium enabled and the user "TranslateX Advanced for Confluence" specified in the Target Space Settings must be allowed to set restrictions
This section defines the configuration for restrictions on editing translated pages
Automatically created pages in Confluence may have editing restrictions applied
Editing Restrictions Enabled - The flag determines whether users are allowed to edit automatically translated pages
Allowed Users - If the flag above is enabled, you can set up exceptions for specific users, who will be allowed to edit translated pages