HTML

include_translatable_attributes

An attribute name or comma-separated names

By default, HTML tag attributes are captured as part of the tag itself and therefore are not translatable.

This directive instructs Smartling to capture the text of a list of HTML attributes for translation. For example, this can be used to capture the title attribute of a button.

exclude_translatable_attributes

An attribute name or comma-separated names

This directive treats HTML attributes as non-translatable. This has a priority over the include_translatable_attributes directive.

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 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 -->

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.

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. 

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

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

force_inline_for_tags

A comma-separated HTML tag list

This parameter forces the HTML parser to treat the listed tags as inline. The difference between block and inline tags is that block tags are used to split HTML into strings, whereas inline tags are included in strings.

<!-- smartling.force_inline_for_tags = external_link,reference -->

Any <external_link> or <reference> tags will be parsed as inline tags. Smartling will not create separate strings for content in these tags.

force_block_for_tags

A comma-separated HTML tag list

This parameter forces the HTML parser to treat the listed tags as string separators.

The difference between block and inline tags is that block tags are used to split HTML into strings, whereas inline tags are included in strings.

If pointing to the same tag list, this directive overrides forcing inline tags.

<!-- smartling.force_block_for_tags=br -->

Enables string separation by <br> tags

text_break_method

• DO_NOT_BREAK
• BREAK_BY_NEWLINE (default)
• BREAK_BY_BLANK_LINE 

This directive control line breaks in HTML files:

• BREAK_BY_NEWLINE - strings are bound by line breaks (default)
• BREAK_BY_BLANK_LINE - strings are bound by blank lines
• DO_NOT_BREAK - all content ingested as one string

<!-- smartling.text_break_method=DO_NOT_BREAK

-->

plain_text_tags

By default, the HTML contents of block tags as a single string. If this directive is used, strings are parsed as plain text to parse the content of a block tag with the default text_break_method=BREAK_BY_BLANK_LINE.

Text break method for nested plain text parser can be overridden with text_break_method directive

<!-- smartling.plain_text_tags=pre

-->

variants_strategy

• none (default)
• context_match
• repetition_indexed

(case-insensitive)

This directive can only be used as an API parameter.

context_match: enables ICE variants functionality.

repetition_indexed: enables the "string indexes as variants for repeated strings" functionality that is the default behavior for business docs.

'smartling.variants_strategy':'repetition_indexed'

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.

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.

collapse_html_whitespace

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

(case-insensitive)

Disables or enables the HTML whitespace collapsing.

By default, this is enabled, so the HTML parser turns all new lines (including tab, LF and CR - i.e. \t, \n, and \r) into spaces and collapses (removes) a sequence of spaces into one space.

<!-- smartling.collapse_html_whitespace = off -->

Disables whitespace collapsing and retains new lines.

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