Translating Microsoft Office Documents via API

This directive decides if Smartling should ingest content from master slides for translation.

By default, Smartling will not ingest content found on master slides (false).

This directive decides if Smartling should ingest notes from slides.

By default, Smartling will parse text content from notes to slides (true). 

This directive decides if comments in the file are ingested for translation.

The default behavior for .xls and .xlsx is on.

The default behavior for .ppt, .pptx, .doc, .docx, and .docm is off.

Values depend on the file type:

• Excel files: sheets | rows | columns
• Word files: text 
• PowerPoint: slides

By default, parser will ingest:

• All content in a spreadsheet, including hidden sheets, columns and rows.
• All content in the Word document, including hidden text.
• All content in the PowerPoint, include hidden slides.

With this directive, you can exclude hidden content from being ingested to Smartling for translation.
Multiple values can be excluded by comma separation.

This directive decides if Smartling should ingest hyperlinks for translation.

The default value is "false".

If set to "false", only the link text is ingested as translatable text, as part of the source string. The link address is not ingested for translation.

If set to "true", the link text is ingested as part of the source string; the link address is uploaded as a separate string to translate.

Values are case-insensitive.

The default value is repetition_indexed, which means that the string indexes as variants for repeated strings functionality is enabled.

context_match enables ICE variants functionality. ICE variant is defined as a variant on a string calculated by the exact character text of the preceding and following strings, if any. This combines the two surrounding strings with a separator character sequence to differentiate between ending and starting strings in a document.

The default value is off.

The name of each sheet is ingested as a translatable string, even if there is no content on the sheet.

To include sheet names for translation, use true, yes, on.

To prevent sheet names from being ingested into Smartling as a translatable string, use false, no, off (default).

One or more of the following variables:

${locale.id}
${language.id}
${country.id}
${language.description}
${country.description}

External directive that specifies a column header format for the column with translations for particular locale in downloaded xlsx file with multi-locale translation.

For instance, for the fr-FR locale, the following format:

${language.description} (${country.description})

results in this header in the translated file:

French (France)

Any text element marked with the character-type style names, provided by this directive, will not be ingested for translation.

There is no default value for this directive.

true|false|TRUE|FALSE|yes|YES|no|NO|off|OFF

Default: false|FALSE||no|NO|off|OFF

By default, Smartling translates the latest version of a document with Accept-All-Revisions before parsing the document on strings/parts.

This directive allows you to translate all revisions and have translated history of revisions, by keeping all changes/revisions as special blocks (<ins>, <del>,<span> html tags).

You may also want to use smartling.process_user_comments directive to translate comments to revisions.

curl -X POST -H "Authorization: Bearer {TOKEN}" -F "file=@user_comments_on.docx" -F "fileUri=user_comments_on.docx" -F "fileType =DOCX" -F "smartling.translate_revisions=true"

"smartling.process_user_comments=true" "https://api.smartling.com/files-api/v2/projects/{PROJECT_UID}/file"

on|yes|true or off|no|false or leading|trailing

The default value is on

A whitespace is any character or series of characters that represent horizontal or vertical space in typography. When rendered, a whitespace character is not a visible mark, but does occupy an area or space on a page.

Although whitespaces are necessary within a string (typically to separate words), unnecessary whitespaces can be found at the start of a string (leading) and at the end of a string (trailing).

With this directive, you can trim whitespaces, as it enables or disables whitespace trim management for the ingested strings.

By default, the leading and trailing whitespaces are trimmed.

You can choose to disable trimming or specify trimming for leading or trailing whitespaces.

The directive can be used inline or as the API request parameter.

smartling.whitespace_trim=on

Smartling will trim leading and trailing whitespaces (default)

smartling.whitespace_trim=off

Smartling will not trim leading or trailing whitespaces

smartling.whitespace_trim=leading

Smartling will trim only leading whitespaces

smartling.whitespace_trim=trailing

Smartling will trim only trailing whitespaces

smartling.placeholder_format_custom=\{([^}]+)\}

Any characters surrounded by curly brackets, e.g., {first name}, will be treated as a placeholder.