XML

character_limit_paths

• Any integer value
• NONE

Source string level instructions for character length. character_limit_paths point to elements that define character limits.

Order is important. The element with the limit must be a sibling of the corresponding element with the translation (as specified by translate_paths), and it must appear before the translation in the file.

<!-- smartling.character_limit_paths = data/unit/limit, data/sub-level/unit/limit, data/item/limit -->

<data>
   <unit>
      <string id="id1">data 0</string>
   </unit>
   <unit>
      <limit>10</limit>
      <string id="id2">data 1</string>
   </unit>
   <sub-level>
   <unit>
   <limit>20</limit>
   <string id="id3">data 2</string>
   </unit>
   </sub-level>
   <unit>
   <limit>30</limit>
   <string id="id4">data 3</string>
   <string id="id5">data 4</string>
   </unit>
   <unit>
   <limit>40</limit>
   <string id="id6">data 5</string>
   <limit>50</limit>
   <string id="id7">data 6</string>
   </unit>
   <unit>
   <limit>60</limit>
   <string id="id8">data 7</string>
   <limit>NONE</limit>
   <string id="id9">data 8</string>
   <string id="id10">data 9</string>
   </unit>
   <item>
   <limit>100</limit>
   <text name="name1">data 10</text>
   </item>
</data>

entity_escaping

• auto (default) 
• true
• yes 
• false
• no

(case-insensitive)

Controls whether base characters ( > < & " ) are "escaped" into entities when delivering translations. This can be set universally for the whole file via API, or by setting the directive at the top/start of the file. The directive can also be placed inline to control the behavior of specific strings.

For example, your translation might look like this:
This is an <hr> & " example string4

By default, using the "auto" setting, we will assume this is HTML from the <hr> tag.

When the translated file is downloaded, the translated string will be escaped as:
This is an <hr> &amp; &quot; example string4

Using <!-- smartling.entity_escaping = false --> will allow is above string to appear unescaped.

entity_escaping_type

• html4 (default)
• html5

(case-insensitive)

By default, all html4 entities are unescaped, except the basic set: &lt; &gt; &amp; &quot;.

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

<!-- smartling.entity_escaping_type = html5 -->

entity_escaping_strategy

• none (default)
• propagate

(case-insensitive)

Used to retain entity escaping for all non-base entities. For example, normally we turn &copy; 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.

If HTML5 entities are required as well, you must use the entity_escaping_type=propagate directive.

<!-- smartling.entity_escaping_strategy = propagate -->

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 does not affect source content at all - so using it will not result in new strings.

propagate will only affect non-base entities - all named entities except &amp; , &quot;, &lt;, &gt;. Base entities continue to be controlled by HTML detection and the entity_escaping directive.

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

force_inline_for_tags

This directive allows for specified tags to be treated as inline tags (visible and moveable for translators and editors) versus block-level tags (creates a new string and are not visible).

This only works for nested HTML parsing in XML, which must be in entity escaped form.

<!-- smartling.force_inline_for_tags = fine -->

<!-- smartling.translate_paths = root/text --> 

<!-- smartling.string_format_paths = html: /root/text --> 

<!-- smartling.force_inline_for_tags = fine --> 

<root> 

<text> 

I have some <fine>text</fine> that is in three pieces. 

</text> 

<text> I have some other &lt;fine&gt;text&lt;/fine&gt; that is not. 

</text> 

</root>

Instructions from XML file. Order is important. The element with the instruction must be a sibling of the corresponding element with the translation (as specified by translate_paths), and it must appear before the translation in the file. 

<!-- smartling.instruction_paths = data/unit/instruction --> 

<data>
   <unit>
      <instruction>instruction text</instruction>
      <string>translation text</string>
   </unit>
</data>

placeholder_format

• NONE
• C
• IOS
• PYTHON
• JAVA
• YAML
• QT
• RESX

Used to specify a standard placeholder format.

<!-- smartling.placeholder_format = IOS -->

Specifies iOS-style placeholders for the file.

placeholder_format_custom

• Custom (Java Regex)
• NONE - disables any current custom placeholders.

Specifies a custom placeholder format. Any text in your file matching the regular expression you provide will be captured as a placeholder.

See Placeholders in Resource Files for more on placeholders.

<!-- smartling.placeholder_format_custom=\{([^}]+)\} -->

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

pseudo_inflation

Integer values between

0 - 100

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.

sltrans

• translate
• notranslate

Use this directive to enable or disable processing of translation strings in the file. You must turn translation back on once you're done with notranslate.

Any content with this tag will not appear in the Smartling dashboard, but will appear in your translated file in your original source language.

<!-- smartling.sltrans = notranslate -->

Strings below this directive will be captured as strings, but excluded from translation.

<!-- smartling.sltrans = translate -->

Strings below this directive will be translated. 

source_key_paths

A comma separated list of paths, as used to create “keys” for strings on translate_paths.

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

Specify the full path to the value, then indicate which part of the path should be used as the key using {} notation.  Each part of the path that has {} will be used to construct the key, with each part separated by a ':#:' in the key.

You can use the value of an attribute in the path by using the '.' notation to indicate the attribute you want to capture as part of the key.

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 will create new strings 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 Memory to manually apply the translation.

Keys are not created if the element is a sibling of the element that has the string, e.g.:

string_format_paths = /data/value
and
source_key_paths = /data/

{key}

Result: though there are no errors, no key is created.

<!-- smartling.source_key_paths = data/item/{content.id}/value -->

Smartling will capture the value of the id attribute of the data/item/content/ node as part of the key.

<!-- smartling.source_key_paths = data/item/{key_name} -->
Smartling will capture node name key_name as the key.

<!-- smartling.source_key_paths = {data}/{item}/{key_name} -->
Smartling will capture the entire path as the key.

• NONE
• HTML
• PLAIN_TEXT
• MARKDOWN

Control trans-unit level HTML parsing.  If this is set to HTML a single trans-unit can be ingested by Smartling as multiple strings, depending on block level tags. 

<!-- smartling.string_format=html -->

<trans-unit id="HTML string1">
 <source>&lt;p>&lt;div>String1 div1.&lt;/div>&lt;div>String1 div2&lt;/div>&lt;/p></source>
</trans-unit>

<!-- smartling.string_format=html -->
<trans-unit id="HTML string2">
 <source>&lt;p>&lt;div>String2 div1&lt;/div>&lt;div>String2 div2&lt;/div>&lt;/p></source>
</trans-unit>

<!-- smartling.string_format=none -->
<trans-unit id="HTML string3">
 <source>&lt;p>&lt;div>String3 div1.&lt;/div>&lt;div>String3 div2&lt;/div>&lt;/p></source>
</trans-unit>

<p><div>String1 div1</div><div>String1 div2</div></p>

String2 div1

String2 div2

<p><div>String3 div1</div><div>String3 div2</div></p>

The value of this directive is expressed as [format]:[paths].

Current supported formats are:

• HTML - string value will be parsed as HTML
• @default - (note the leading at-sign) string value will be treated as simple text.
• TXT - string value will be parsed as plain text with strings separated by new lines.
• Markdown - string value will be parsed as Markdown.
• block - passes all elements within the block as a single Smartling string.

Specifies the format of strings for the specified paths and can enable HTML inside another file format. 

Separate multiple paths by commas.

You may specify a single path for a format or a comma-separated list of paths enclosed in square brackets. The list may be empty.

Wildcards are allowed in path definitions.

• If no wildcards are used, then the path identifies a single node and all its children ("exact subpath").
• If wildcards are used, then a path identifies a set of nodes and all their children ("path pattern"). Currently, only * (asterisk) wildcard is implemented, which means "one or more nodes with any names".
• Exact subpaths have precedence over path patterns.

See Content Parsing for more information.

<!-- smartling.string_format_paths = -->

Disables the effect of the previous string_format_paths instruction.

<!-- smartling.string_format_paths = html: /product/description -->

Enables HTML in /product/description only.

<!-- smartling.string_format_paths = html: /product/description/ -->

Enables HTML in /product/description and all its child nodes.

<!-- smartling.string_format_paths = html: /product/description/, html: /product/title -->

Enables HTML in /product/description and all its child nodes, and the product/title node.

<!-- smartling.string_format_paths = block: /product/description -->

Enables block and everything inside of root to be one string.

When included in this list, all plain text within the specified tag will be considered a translatable string. Optionally, you can append a “.” and a relevant attribute name to the path to translate tag attributes with the file. You can end the path with a trailing slash, “/” and it will treat all child nodes as translatable (content must still be text within a tag). 

<!-- smartling.translate_paths = data/localize/string, data/localize.title, data/localize/root/ --> 

Smartling will translate content in the data/localize/string & data/localize/root nodes. The title attribute of the data/localize node will also be translated.

• true
• TRUE
• on
• ON
• false
• FALSE
• off
• OFF

(case-insensitive)

This controls string uniqueness. It must be used with the source_key_paths directive, which provides the information needed to generate variant metadata. 

If you have previously uploaded a file with variants turned off, and re-upload the file with variants on, Smartling will capture all content as new strings. You can configure SmartMatch to automatically match the existing translations.

<!-- smartling.variants_enabled = TRUE --> 

Smartling will make strings unique using variant metadata.

whitespace_trim

• on (default)
• yes
• true
• off
• no
• false
• leading
• trailing

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 manage whitespace trimming.

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

Content inside the listed custom tags will be captured as a placeholder. 

<!-- smartling.xliff_tags_to_placeholders = g, mrk, ept, bpt -->

g, mrk, ept, and bpt will be captured as tags.