Translation and Review Guidelines: Difference between revisions
(→Always Keep the End User in Mind: Added technical) |
|||
(18 intermediate revisions by 2 users not shown) | |||
Line 13: | Line 13: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Communicate | ===Communicate=== | ||
:'''''Leave '''[https://docs.transifex.com/translation/tools-in-the-editor#comments Comments]''' for other translators''''' | :'''''Leave '''[https://docs.transifex.com/translation/tools-in-the-editor#comments 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. | ::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. | ||
Line 29: | Line 29: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Read the ''Developer Notes'' and ''Translation Instructions'' in Transifex | ===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. | :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. | ||
Line 38: | Line 38: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Do | ===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. | :Do not translate or transliterate project, company or application names that do not have an official or widely adopted regional variation. | ||
Line 48: | Line 48: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Focus on | ===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. | 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 [https://docs.transifex.com/translation/translating-with-the-web-editor#searching-and-filtering-for-strings 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. | ::'''Example:''' If "Create Account" appears in a string in a project, use the [https://docs.transifex.com/translation/translating-with-the-web-editor#searching-and-filtering-for-strings 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. | ||
Line 62: | Line 62: | ||
:* The Localization Lab '''[https://docs.transifex.com/translation/using-the-glossary 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 [https://docs.transifex.com/setup/glossary/adding-terms add the translation to the glossary]. | :* The Localization Lab '''[https://docs.transifex.com/translation/using-the-glossary 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 [https://docs.transifex.com/setup/glossary/adding-terms add the translation to the glossary]. | ||
:::Key project terms will have the label "[project name]" in the ''Comments'' field for the term. | :::Key project terms will have the label "[project name]" in the ''Comments'' field for the term. | ||
|} | |||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Watch out for | ===Watch out for Placeholders, HTML and Unicode Character Entities, and Markup Language.=== | ||
====Placeholders and | ====Placeholders and Variables==== | ||
::Many project strings contain '''placeholders''' which may replace [https://www.quackit.com/html/tags/ HTML], [https://www.quackit.com/xml/tutorial/about_xml.cfm 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.<br><br> | ::Many project strings contain '''placeholders''' which may replace [https://www.quackit.com/html/tags/ HTML], [https://www.quackit.com/xml/tutorial/about_xml.cfm 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.<br><br> | ||
::Hover your mouse over the variable in the English source text to see what the placeholder is replacing. | ::Hover your mouse over the variable in the English source text to see what the placeholder is replacing. | ||
Line 81: | Line 82: | ||
::Review the [https://docs.transifex.com/translation/html-files#in-the-new-editor Transifex documentation] to learn how to manage placeholders in the translation editor.<br> | ::Review the [https://docs.transifex.com/translation/html-files#in-the-new-editor Transifex documentation] to learn how to manage placeholders in the translation editor.<br> | ||
====HTML and Unicode | ====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.<br> | ::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.<br> | ||
::You can look up HTML entities on the [https://www.w3schools.com/charsets/ref_html_entities_4.asp W3 website]. | ::You can look up HTML entities on the [https://www.w3schools.com/charsets/ref_html_entities_4.asp W3 website]. | ||
::'''Examples:''' ''& nbsp;'' is | ::'''Examples:''' | ||
::* '''&nbsp;''' is a non-breaking space | |||
::* '''&lt;''' is equivalent to < | |||
::* '''&gt;''' is equivalent to > | |||
[[File:HTML character entity 2.png|500px|center|HTML variable in Transifex]]<br> | [[File:HTML character entity 2.png|500px|center|HTML variable in Transifex]]<br> | ||
[[File:HTML character entity 1.png|500px|center|HTML variable in Transifex]]<br> | [[File:HTML character entity 1.png|500px|center|HTML variable in Transifex]]<br> | ||
Line 95: | Line 99: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Pay | ===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. | :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. | ||
Line 105: | Line 109: | ||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | {|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | ||
| | | | ||
===Punctuation, | ===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. | 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:''' | :'''While you are translating and reviewing, make sure that you:''' | ||
:*Use the correct and consistent punctuation; | :*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; | |||
:*Use correct and consistent capitalization. If there are individual terms that are capitalized in the English source, | :*Add the correct number of brackets, parentheses and curly brackets in your translation; and | ||
:*Add the correct number of brackets, parentheses and curly brackets in your translation. | :*Do not add double spaces unless they are present in the original source content. You can turn on "Display Spaces" in your [https://docs.transifex.com/translation/translating-with-the-web-editor#editor-settings Transifex Editor Settings] which will help you visualize spaces in the source text and your translation. | ||
::[[File:Display_Spaces.png|500px|center|Display Spaces Transifex]] | |||
|} | |||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | |||
| | |||
===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 [https://docs.transifex.com/translation/translating-with-the-web-editor#editor-settings 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. | |||
|} | |||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | |||
| | |||
===Always Keep the End User in Mind=== | |||
Ask yourself: "If my 65-year-old parent read this (who has a total of 3 apps on their phone and uses only one of them on a weekly basis), would they understand this without anyone's help?". | |||
The goal is not to literally translate words and sentences, but to make the text understandable - while still maintaining accuracy - for people coming from different linguistic, cultural and technical backgrounds. | |||
|} | |||
{|class="wikitable" style="margin-right: auto; margin-left: 0px; width: Auto; background-color:#ffcccc;" | |||
| | |||
===Know the Style Guide=== | |||
Check to see if there is a style guide for [https://wiki.localizationlab.org/index.php/Language_Resources your language] on this wiki. | |||
No style guide on the Localization Lab wiki for your language team? Refer to [https://wiki.localizationlab.org/index.php/Language_Resources#Multi-Lingual_Style_Guides style guides for other technical projects]. | |||
|} | |} |
Latest revision as of 15:12, 26 July 2021
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
|
Communicate
|
Read the Developer Notes and Translation Instructions in Transifex
|
Do Not Translate or Transliterate Application or Project Names
|
Focus on ConsistencyIn 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.
|
Watch out for Placeholders, HTML and Unicode Character Entities, and Markup Language.Placeholders and Variables
HTML and Unicode Character Entities & Mark Down Language
New lines
|
Pay Attention to the "notranslate" Tag
|
Punctuation, Capitalization, Double Spaces and TyposThe 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.
|
Reference other LanguagesIf 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. |
Always Keep the End User in MindAsk yourself: "If my 65-year-old parent read this (who has a total of 3 apps on their phone and uses only one of them on a weekly basis), would they understand this without anyone's help?". The goal is not to literally translate words and sentences, but to make the text understandable - while still maintaining accuracy - for people coming from different linguistic, cultural and technical backgrounds. |
Know the Style GuideCheck to see if there is a style guide for your language on this wiki. No style guide on the Localization Lab wiki for your language team? Refer to style guides for other technical projects. |