Translation and Review Guidelines

From Localization Lab Wiki
Revision as of 08:13, 13 February 2021 by Erin (talk | contribs) (Changed capitalization of "Style Guide")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Please review the tips and guidelines below prior to localizing projects. The following information will help you navigate the Transifex interface and more effectively and accurately translate and review projects.

Do not Machine Translate

Machine translation tools like Google Translate and Microsoft Translator Hub are useful resources, however they should never be used as the foundation of your translation, particularly long-form text which is less and less likely to be accurate the longer it is.
Keep in mind that even if you heavily post-edit machine translations, the grammar, style, tone and terminology used in the machine translation can still greatly affect your translation.

Communicate

Leave Comments for other translators
Localization in the Localization Lab community is a group effort! If you are simply fixing a typo or grammatical error, feel free to make the changes necessary without leaving a comment. If you are changing key terminology or significantly changing the structure of a translation, leave a comment for the previous translator to briefly explain the change. Be sure the mention them by including @ followed by their username in your comment.
Leaving comments ensures that other contributors understand why you have made changes, can learn from them, and can make sure to apply the changes to future translations.
Leave Issues for project maintainers
If you don't understand what a string means, need more context or there is a typo or fundamental issue with the source text, let the project maintainer know! You can do this by creating an Issue. Developers and project maintainers are notified of issues so that they can be addressed efficiently.
There are several priority levels to chose from when creating an issue:
  • Low: Minor and cosmetic changes to a source string.
  • Normal: Typos, questions or changes affecting the meaning of a source string that may hinder translation.
  • High: Significant issues with the localizability or coherence of the source string.
  • Critical: Issues with the source string that might break the software.

Read the Developer Notes and Translation Instructions in Transifex

The Developer Notes and Instructions are located in the Web Editor in between the source text and the translation text field. Make sure to read and follow any available instructions for the string you are translating.
Example of Developer Notes.


Do not translate or transliterate application or project names.

Do not translate or transliterate project, company or application names that do not have an official or widely adopted regional variation.
Some projects have widely used and accepted translations or transliterations of their names. If this is the case in your language, feel free to use the localized version.
Example: تويتر (Transliteration of Twitter in Arabic)

Focus on Consistency

In addition to recurring terminology, you will often encounter strings that are duplicate or directly reference other strings. It is important to ensure these translations are consistent across the entirety of a project.

Example: If "Create Account" appears in a string in a project, use the filters in the Web Editor to see where else "Create Account" appears in the rest of the project resources and make sure the translation is consistent.
Reference to "Create Account" in a string.

Original "Create Account" string.

Transifex has several features to help you manage consistency across translations:
  • The Concordance Search allows you to search for words and phrases across multiple resources within the same project and across different projects within the same organization. You can use it to see how something is translated in different strings and contexts.
  • The Search Strings feature in Transifex allows you to search words and phrases across all Localization Lab projects using more filters than are available in the simple Concordance Search. You can filter matches by project, resource, target language, source language, tag, date etc.
  • Web Editor Filters allow you to filter and search strings across one or multiple resources in a project. Among many options, you can filter by word or phrase in the source text or in the translation text.
  • The Suggestions tab in the web editor lets you view translations from the Localization Lab Translation Memory from other strings and resources in related projects. Translations of strings which are up to 60% the same will appear in this tab. Referencing these suggestions can help you maintain consistency across projects.
  • The Localization Lab Glossary is very robust in English, however not all languages have translations for each term. Use the Glossary tab to double check translation of a term. If the term is not there, select View Glossary to add the translation to the glossary.
Key project terms will have the label "[project name]" in the Comments field for the term.

Watch out for Placeholders, HTML and Unicode Character Entities, and Markup Language.

Placeholders and Variables

Many project strings contain placeholders which may replace HTML, XML or words and numbers that change within the application's interface. It is important to keep these placeholders unchanged in the translation. You can move the placeholders depending on where they grammatically make the most sense in your language.

Hover your mouse over the variable in the English source text to see what the placeholder is replacing.
Variables in Transifex

Sometimes a variable will not be recognized by Transifex and will be editable in the web editor. If you see an element within curly brackets, you can assume that in most cases you should not translate anything inside the brackets. Double check the Developer Notes to see if there are any special notes about how to treat the content in brackets. If you are still unsure, create an "Issue" for the string so that a project maintainer can clarify.
Curly bracket variables in Transifex

Placeholders will often provide hints as to what they replace in the app's user interface. If you cannot determine what the placeholder will replace in the app and as a result, don't know how to translate the surrounding content, create an issue and ask the project maintainer.
Below, the placeholder "{language}" will be replaced by the name of a language.
Language Variable in Transifex

Below you can see how the variables "{author}", "{title}" and "{status}" are replaced by different text in the Check user interface.
Status and Author Variables in Check

Author and Title Variables in Check

Context for Check Variables

Review the Transifex documentation to learn how to manage placeholders in the translation editor.

HTML and Unicode Character Entities & Mark Down Language

Sometimes an HTML character entity will not be recognized and replaced by Transifex. In these cases, you can either copy the exact character entity or you can replace it with what it corresponds to.
You can look up HTML entities on the W3 website.
Examples: & nbsp; is equivalent to a non-breaking space; & lt; is equivalent to <; & gt; is equivalent to >.
HTML variable in Transifex

HTML variable in Transifex

New lines

The little blue arrows in the source text are equivalent to a new line (/n). Make sure to input new lines where indicated in the source text. Do so by simply selecting the Enter or Return key on your keyboard. The number of new lines in the translation should be the exact same as the number in the English source text.

Pay Attention to the "notranslate" Tag

Some strings will be assigned the "notranslate" tag and you will find a special message at the bottom of the translation input field. These strings should be copied exactly using the copy icon in the web editor. If you do not copy these strings exactly, Transifex will give you an error warning.
The translation in the example below is incorrect because this string should be an exact copy of the English source text.
Notranslate tag in Transifex

Punctuation, Capitalization, Double Spaces and Typos

The small details make a big difference in the end product. Individuals are less likely to trust a tool whose interface is messy or has inconsistent punctuation and capitalization, even if the translation itself is correct.

While you are translating and reviewing, make sure that you:
  • Use the correct and consistent punctuation;
  • Use correct and consistent capitalization. If there are individual terms that are capitalized in the English source, they are most likely capitalized for a reason. Double check to see if you should also capitalize in the target language translation;
  • Add the correct number of brackets, parentheses and curly brackets in your translation; and
  • Do not add double spaces unless they are present in the original source content. You can turn on "Display Spaces" in your Transifex Editor Settings which will help you visualize spaces in the source text and your translation.
Display Spaces Transifex

Reference other Languages

If you are multi-lingual, you can view both the English source text and current translations in another language that you speak. This can be helpful when trying to understand the context and meaning of the English source text.

You can add an additional source language through the Transifex Editor Settings in the web editor.

Please remember that the current translations in another language may or may not be reviewed by a trusted contributor, and you should ultimately defer to the English source text.

Know the Style Guide

Check on this wiki if we have a style guide for your language.