Build multi-language template(s) - Word Add-in

Insert translation tags into the document template

Place the cursor in the Word document where the translation key should be inserted. In the add-in on the Home tab, click on the + next to the Translation Key menu.

The Add translation key panel is opened. You can then: Create a new translation key OR Pick in a drop down already created keys in the same document. Important: No space is allowed in the key name.

On the Word side a new tag has been inserted as follow: #Trans_ + ID + key name defined in the add-in Important: Translation keys can be reused in the document (by picking them in the picklist) and will be translated only once in the translation file.

Provide translation locale reference & fallback locale

In the Dedicated tab, you will be able to manage your multi-languages templates

When opening the tab, you can see first the Locale definition section that will be used to define which field of your document is the one driving the translation.

When editing Locale definition section, you will have to select a quote field (of type LOCALE) that will be used at generation time to pick the right language type in a Fallback Locale with a valid format in case no translation has been found for the dynamic language. Important: Field list available are narrowed to fields with LOCALE type. Fallback Locale format validity will be checked. This step is mandatory to be able to generate the translation file.
After setting the two locales, you can save your choices. If only one of the two settings is filled, you will not be able to save. In that case cancel the operation by using the cross icon.
If you need to remove those settings because you don't need them anymore, use the trash icon to reset the parameters.

Download the translation keys from the Add-in

1	On the same tab, you can see first the Translation keys section that will be used to generate the translation file containing all the translation keys defined in the template. Once the user has finished inserting the translation keys in the document, he's able to click on a "Generate translation file" button. Note: if the document contains scale pricing columns or per quantity values, the user can edit the settings and check the two corresponding boxes to ensure the translation keys for these items will also be generated.
2	The output format must be a csv file as follow: the name of the file will be: the default locale chosen above the format is csv the content: is separated by semicolon TranslationKey; Value

SPECIFIC CASE FOR SCALE PRICING & PER QUANTITY

If you are using complex tags like Scale pricing and or Per Quantity values, some of the static content generated in the document comes from labels directly entered in the add-in that will also need to be translated. You will have to check the corresponding options before generating your translation file to be able to translate this content.

Scale Pricing

For Scale Pricing, you will find below the different translation keys that would be generated for each tag present in the file depending on the presence or not of the values in the template. In the example below the tag inserted in one of the table of the document is Col_178_ScalePricing.

Per Quantity

For Per Quantity, you will find below the different translation keys that would be generated for each tag present in the file depending on the presence or not of the values in the template. In the example below the tag inserted in one of the table of the document is Col_182_MyPrice.

PER QUANTITY LABEL#TRANS_PQL_COL_182_MYPRICE

Create the translation files

Overview of the translation file(s) in the en-US.csv

in the fr-FR.csv

Publish multi-language template(s)

LOADING TRANSLATION FILES WITH TEMPLATE

All translations files must be provided anytime the templates are uploaded into the Document Designer.

VALIDATION RULES

• Translation files must have unique names
• Translation files name must have the formatting of a locale
• The maximum size for each csv file containing the translations is 500Ko
• The maximum number of translation files attached to a template is 30

Generating documents with translations

Generation principles

• Each translation key will be replaced by the content coming from the translation file.
• The formatting (bold, bullet) is set in the Word template.

In a case where multiple formatting is needed, the content will be split into multiple translations. Example: To render in the generated document the paragraph below:

Conga est un innovateur de premier plan dans le secteur du logiciel, dédié à fournir des solutions de pointe et un service exceptionnel. Avec un engagement envers l’excellence et une passion pour l’innovation, nous nous efforçons de dépasser les attentes de nos clients et de favoriser le succès grâce à notre gamme complète de produits et services. Notre équipe d’experts est dédiée à promouvoir une culture de collaboration et d’amélioration continue, garantissant que nous restons à la pointe des avancées de l’industrie.

The Translation key will need to look like this: #Trans_BoilerPlate1 #Trans_BoilerPlate2 #Trans_BoilerPlate3 And the translation file as follow:

The spaces between the tags should be respected in the Word document. Fallback Mechanism

The mechanism happens at translation key level.

GENERAL PRINCIPLE

EXAMPLE 1 : TRANSLATION LOCALE PROVIDED AND AVAILABLE & FALLBACK PROVIDED AND AVAILABLE

EXAMPLE 2 : TRANSLATION LOCALE PROVIDED AND NOT AVAILABLE & FALLBACK PROVIDED AND AVAILABLE

EXAMPLE 3 : TRANSLATION LOCALE PROVIDED AND NOT AVAILABLE & FALLBACK PROVIDED AND NOT AVAILABLE