CSV

DEFAULT PARSING

HTML PARSING

1 string with variant only. Keys must be applied before translations can be imported.

5 strings with variant only - Keys must be applied before translations can be imported.

1. ​<p>​This ​<br>​is​</br>​ another example source string​</p>​​
2. <h1>​This is a header ​<i>​maybe​</i>​?​
3. <p>​One more for the ​<strong>​road​</strong>​​</p>​

Applies a character limit to the translation, which will be visible on the string details in the dashboard and the CAT Tool. The character limit column should be placed somewhere before the source column. 

The directive should point to the column that contains a character limit for the string.

Each string character limit is applied to the next source string, so you must place the character limit column to the left of (or before) the source string.

The character limit applies only to the first translatable column placed after the character limit field. You can apply a character limit for each string by inserting a character limit number alongside each string cell.

To remove a character limit from a CSV file that had been previously applied, the number in the character limit column must be set to "none". Simply removing the limit number from the column will not be successful.

Specifies which columns contain string instructions. This directive must be used together with smartling.paths to specify translatable strings.

Each string instruction is applied to the next translatable string, so you must place your instruction column to the left of (or before) the source string. You may have more than one instruction column per translatable string.

Note: When string_format_paths is set to HTML or Markdown, keys and instructions are not ingested. 

Smartling will capture the content in the files as follows. Column 1 will be captured as key metadata, Columns 2 and 3 will be string instructions. Column 4 contains the translatable strings.

# smartling.string_instructions_paths=2

For uploading original file:
Comma-separated list of column numbers. # smartling.paths=1,2

For multi-language imports:
Comma-separated list of column/locale pairs # smartling.paths=1/[LocaleID],2/[LocaleID]

# smartling.paths=2,3

Specifies that columns 2 and 3 of the uploaded CSV file should be ingested as translatable strings.

# smartling.paths=2/es-ES,3/fr-FR

When importing translations, specifies that column 2 contains Spanish-SPAIN translations and column 3 contains French-FRANCE translations.

source_key_paths

A comma separated list of paths to use creates “keys” for strings on translate_paths.

The key will be a space-separated string of all the keys leading to the source string. For example: “string”, “group1 string”.

Used to define the schema for capturing a key for each source string. Keys are required:

If you want to import pre-existing translations from a file with the same structure
If you want to create variants of strings that would otherwise be duplicates (By default, Smartling does not create duplicate strings.)

Creating or updating variants for previously uploaded strings cause new strings to be created that will not have translations. The SmartMatch feature can be configured to automatically apply the existing translations, or translators can use the 100% match from the Translation to manually apply the translation.

Specify the full path to the value, then indicate which part of the path should be used as the key using {} notation.

# smartling.source_key_paths = 1

Smartling will capture data from column 1 as keys. Each key will be applied to the next translatable string after it, so keys need to be placed to the left of translatable strings in each row for this directive to work.

placeholder_format

Specifies iOS-style placeholders for the file.

# smartling.placeholder_format_custom = REGEX

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

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

entity_escaping_type

html4 (default)|html5

(case-insensitive)

By default, all html4 entities are unescaped, except the basic set: < > & ".

When this directive is set to html5, all html5 entities will be unescaped as well. 

If you choose to set this directive to html5, you must also use the entity_escaping_strategy=propagate directive

# smartling.entity_escaping_type=HTML5

Used to retain entity escaping for all non-base entities. For example, normally we turn © into © but if we use this new directive the translation will automatically update to use escaping from the source. For each entity character, we'll check to see if it was escaped in the source and try to match (propagate) it in the target.

The default is none which is the current behavior, which recognizes HTML4 entities only - if HTML5 entities are required as well, you must use the entity_escaping_type=propagate directive.

propagate will only affect non-base entities - all named entities except & , ", <, > . Base entities continue to be controlled by HTML detection and the entity_escaping directive.

If the same character is both escaped and unescaped in the same string, propagate will return the characters in the translation escaped in the same order as they were in the source. However, if there are a different number of characters in the translation where the translation process removed or added some and the escaping is inconsistent among them, propagate will escape all entities for that character.

This directive can be placed inline, in the API or in a template (consult your Customer Success Manager about configuring directive templates).

This does not affect source content at all - so using it will not result in new strings.

Numerical entities are not considered at all with this directive, and are treated normally.

#smartling.entity_escaping_strategy=propagate

Sets the percentage by which original strings are inflated when downloading pseudo translations. If this directive is not set, pseudo translations are 30 percent longer than the original strings.’

# smartling.pseudo_inflation = 80

Downloaded pseudo translations will increase the length of original strings by 80 percent.

string_format_paths

When set to HTML, the strings in the file are parsed as HTML.

When set to markdown, the string in the file are parsed as markdown.

Note: When string_format_paths is set to HTML or Markdown, keys and instructions are not ingested. 

# smartling.string_format_paths=HTML:*

# smartling.field_separator=,

Fields are separated with a , character.

String of characters.

The default is the double quotation marks,

e.g.: "example string".

Example

# smartling.string_encloser=*

String literals are enclosed in * characters

# smartling.locales_map={"es-ES":"Spanish","de-DE":"German"}

Downloaded translations will be labeled as Spanish for es-ES and German for de-DE.

Determines whether to force the addition of a UTF-8 Byte Order Mark (BOM) to the output file when downloading translations.

If set to FALSE (default), output files will only include a BOM if the original file did.

If set to TRUE, a UTF-8 BOM will be added to the output file, even if none existed in the original file.

Note: This applies to UTF-8 only. For UTF-16, BOM is always used.

Allows you to include all translations in one file, where the translations are in row, by defining the column to record the language for each row. Output will display a language code for each column, e.g. de, en, es, etc.

This column should exist in the original file as an empty column.

If using this directive, you should also include this column in the  #smartling.paths to ensure it is not overwritten by translations.

# smartling.translation_language_path = 4

When the translated file is downloaded, column 4 will record the language for each row.

# smartling.translations_in_columns=TRUE

whitespace_trim

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.

Whitespace is optionally trimmed from content then re-inserted on download for convenience so that translators do not have to manage the extra spaces. However, content owners may want to retain surrounding whitespace so that translators can
manipulate it during translation.

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 only be used 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