MadCap Flare ZIP Package
|Resources||MadCap Flare software|
Smartling supports Madcap Flare
Non-HTML files in the archive are excluded from processing.
Directory structure and non-HTML files are preserved when downloading the translated archive.
File directives are supported, both inline and via our API. Directives are specified in comments within the files, in the following format:
Inline File Format
|<!-- smartling.[directive_name] = [value] -->|
|smartling.[directive_name] = [value]|
Here are some examples of [directive_name], along with example values or paths.
Exact delivery depends on file type.
true (or yes)
false (or no)
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.
To use inline:
For example, your translation might look like this:
By default, using the "auto" setting, we will assume this is HTML from the
When the translated file is downloaded, the translated string will be escaped as:
XML Characters (always escaped)
|Character (name)||Escape sequence|
' (apostrophe or single quote)
|Values||propagate | none|
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.
This directive can be placed inline, in the API or in a template (consult your SA 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.
To use inline:
|Description||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.
This is off by default.
|Examples||smartling.flare_madcap_tags_as_inline = on
Any <external_link> or <reference> tags will be parsed as inline tags. Smartling will not create separate strings for content in these tags.
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
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 will trim leading and trailing whitespaces (default)
Smartling will not trim leading or trailing whitespaces
Smartling will trim only leading whitespaces
Smartling will trim only trailing whitespaces