Below are key concepts that everyone should know when using Smartling.
The first three items in the list are related to your account structure.
Account
Each Smartling customer gets one account, and all translation-related activity takes place within the structure of that account. Each account can be configured with settings, people, and projects.
Project
A project is the environment within which translation work is done in Smartling.
Despite the name, projects are long-lived configurations within a Smarting account. They are often segregated based on content types or integrations. For example, you might have one Smartling project for your Marketing content and a different one for your legal documents.
For more information on projects, read Introduction to Projects.
File
A file is a container of content that is recognized as unique once per project. It can be in the form of a source file or a translated file.
Job
Within each Project, you then create translation orders, which are called Jobs in Smartling.
You can think of a Job as a translation event occurring within a Project, where content is being translated from one source language into one or more target languages.
For each Job, you can choose who should work on the translation by selecting the right workflow. Before initiating the translation of a Job, you can see a cost estimate directly in Smartling. Jobs typically have a due date (or deadline), so your linguists know exactly when the translations need to be delivered. A particular string can be in only one job at a time. This can be a source of confusion when a new version of a file is added to a new job, and much of the content doesn’t appear in the job because it is in another job from an earlier upload.
The term ‘project’ is sometimes used in the translation industry for what is referred to as a 'job' in Smartling.
Source language
The language from which content is being translated.
Each project in Smartling has a single source language. Any content sent for translation in a project will be assumed to be in the language defined as the source language for that project.
Target language
The language into which content is being translated.
A project is configured with one or more target languages. To see which languages are defined in a project, go to Project Settings > Languages in the Smartling Dashboard.
Locales and locale codes
A locale is a variation of a language as spoken in a particular location.
In Smartling, a locale is written in the form “Language (Location)”. For example, “French (Canada)”. A locale code is a code in the form ab-CD representing a particular locale, where ‘ab’ is the language code and CD is the country code. For example, the locale code for “French (Canada)” is fr-CA
. When integrating with Smartling, either via a Connector or API, it is important to ensure that locales are mapped appropriately. This means that the target language in the Smartling project should match the target languages of the connecting software.
Translation memory
A database of previous translations recorded in Smartling as source-target pairs at the string and segment level.
Translation memory is automatically surfaced for translators working in the Smartling in the form of suggestions to use in their translation work. It can also be used to apply translations automatically using a capability called SmartMatch. In general, you won’t interact with translation memory in your integration work. However, you can directly influence how effectively translation memory is leveraged by how your content is parsed into strings. As a result, it’s essential to have a solid understanding of how strings are parsed and handled in the platform.
Source File
The original file your source content is in.
It is the file that is prepared and sent to Smartling for translation. File preparation impacts how the content within the source file is parsed into strings. Once translation is complete, you will have a translated version of the source file.
For more information, read Introduction to Files.
Translated File
The primary method of integrating with Smartling for translation is to upload source files and download translated files.
In most cases, a translated file is in the same format as the source file, except that the source translatable text is replaced with the corresponding translation. Files are uniquely identified within a project by the file URI, which is also used as the default namespace for the translatable strings from the file. When new versions of previously uploaded files are uploaded, Smartling automatically identifies what's changed (i.e., performs a diff) and only presents the changes for translation.
For more information, read Introduction to Files.
Strings
The basic unit of content in Smartling.
Strings are uniquely identified within a Smartling project by the combination of the text of the string, its ‘variant’, and its ‘namespace’. How strings are parsed from files, and how their variant and namespace attributes are set, is based partly on the file type and partly on how you prepare the file for translation. Some key aspects of strings that you should account for carefully in your file preparation are placeholders keys, and HTML tags.
For more information, read Strings.
Placeholders
Dynamic content or variables in your text.
You should use placeholders in your content rather than string concatenation, which can render your content untranslatable. Ensure that your placeholders are recognized as such by Smartling so that automatic QA checking happens (e.g., ensuring that placeholders in the source string appears in the translation), and translators are prevented from modifying and possibly corrupting your placeholders. Some placeholders are recognized automatically, and some require directives.
For more information, read Placeholders in Resource Files.
Keys
Unique identifiers for a string in a file.
If your content has keys, make sure they are being picked up by Smartling and used as variant attributes for your strings. In some cases, this will happen automatically, and in others it will require directives.
HTML Tags
Formatting characteristics that you can apply to text to change its appearance.
Smartling automatically recognizes HTML tags and provides tools for translators to ensure that they are protected and handled appropriately. Inline tags such as <bold>
and <a>
are retained in the content surfaced to translators, allowing them to position the tags around the appropriate words in the target language. For larger chunks of HTML with block-level tags such as <div>
and <li>
, it is usually recommended to break them into smaller strings to reduce the chance of translation errors and to get better translation memory leverage. This can be done automatically through the use of a directive.
Directives
Directives are instructions to Smartling indicating how content should be processed.
For example, if your content uses a custom placeholder format, you can supply a directive with a regular expression that Smartling can use to recognize placeholders in your content. Directives can be included in files that are uploaded to Smartling, or can be supplied via API parameters. It’s also possible to configure default directives that are always applied when files are uploaded. Available directives for each file type are listed in the documentation for that file type.
For more information, read Supported File Types.
Workflow
A customizable sequence of steps through which content moves as part of the translation process.
All workflows have a Translation step, and they may have one or more additional Edit, Review, and Hold steps depending on what’s required for the content in question. The last step in a Smartling workflow is called Published. When all content in a file reaches the Published step for a given locale, it’s ready to be downloaded in that locale. It’s also possible to configure Dynamic workflows that contain multiple branches, through which content is routed based on decision steps. Accounts are usually configured with multiple workflows to be used in different situations.
For more information, read Workflows.
Authorize
Content enters a workflow through an action called Authorization.
Typically, a job is manually authorized after it has been assessed and its cost estimated; but it’s also possible for it to be authorized via API. Content that is in a job but not yet authorized is said to be Awaiting Authorization.
CAT Tool
The primary user interface for translating in Smartling.
It provides various tools to help translators produce high-quality translations quickly.
For more information, read CAT Tool.
Visual Context
A powerful feature of the CAT Tool, in which translators see the text being translated in the context where it ultimately is to be displayed.
Instead of translating a list of isolated sentences, the translator sees the sentences in the web page they’re a part of, and sees how the layout of the page accommodates the translations. Visual context results in higher-quality translations in a shorter time with simpler review workflows. Smartling provides a number of tools for capturing and loading context into the platform, including a set of API endpoints.
For more information, read Visual Context.