Editing Translator Guidelines Crowdin

Editing Crowdin

English

[title|Translator Guidelines Crowdin]

[summary]Helpful tips for translating the iFixit interface via Crowdin. General guidelines are in English, with language-specific guidelines outlined in their own guideline page.[/summary]

[summary_image|1201916]

== Thanks for Helping us Translate iFixit.com! ==

=== Four Golden Rules for Translating ===

***[[Crowdin#Section_Machine_Translation|Made by you]]***—Please do not copy and paste machine translation—you’re much smarter than algorithms.

***[[Crowdin#Section_Glossary_and_Translation_Memory|Complete and accurate]]***—Make sure you've translated all words, converted all measurements, researched technical terms, used terms defined in the glossary, etc.

***[[Crowdin#Section_Ensuring_Translation_Quality|Comprehensible]]***—Would your neighbor/niece/grandpa understand?

***[[translator#Section_Style|In a modern and informal style|new_window=true]]***—Write as if you're explaining how to change a light bulb to a friend. ''(Link to the general guidelines, opens in a new window)''

== Translating the iFixit User Interface ==

We are using a tool called Crowdin to translate the user interface of the site. Actual content—guides and wikis—can be translated directly on iFixit.com. Here we have some ***[[translator|general guidelines|new_window=true]]***.

Crowdin is an online, peer-review translation platform. They offer an excellent [link|https://support.crowdin.com/crowdin-intro/|overview/tutorial|new_window=true] including information regarding your account and on how to contact iFixit employees.

We recommend you read through their overview and get familiar with the Crowdin interface before you start translating. If you are ready to dive in, make an account, ***[https://crowdin.net/project/ifixit|join the iFixit translation project|new_window=true]***, and get to work on the untranslated portions of iFixit.com.

We’d like for the entire site to sound like it was written by the same person, instead of many different people. As you translate, try to maintain consistency with the entire site. If you want to talk to your fellow translators, you can use the commentary function on Crowdin.

=== The Benefits of Crowdin ===

* In-context translation
* Per-language forums
* Awesome moderation / proof-reading interface

Crowdin separates the material that needs translating into different categories, based on where that material lives on iFixit.com. The highest priority for translation is labeled as “Base.po”—that’s essentially the base architecture of iFixit, and what most visitors to the site see.

Crowdin delivers you phrases, sentences, and strings of text that have yet to be translated on iFixit.com. Some of the phrases will be accompanied by administrator comments that provide the translator with information on where that particular phrase appears on the site. For the most part, translators just translate a phrase as they see it, and move on. But if you’re not sure how to translate the phrase, you can try searching for it In-Context and translate it directly:

[link|https://ts.ifixit.com/|https://ts.ifixit.com/|new_window=true]

One strategy to find the translation on the site, which can be quite challenging, might be to Google your target phrase, like this:

[https://www.google.com/search?q=site%3Aifixit.com+"ask+a+question."|site:ifixit.com "ask a question"|new_window=true].

***Please note:*** This will not work for strings of text that are displayed in javascript or on management interfaces. In an ideal world, every phrase waiting to be translated would include a note with a URL to find the phrase in context. That's on our roadmap. In the short term, you can email a screenshot of problematic text to translate@ifixit.com or open an issue via the comment function in Crowdin and ask for context.

Crowdin keeps track of your translation progress. As you translate more phrases (or strings) on iFixit, you’ll see the language completion percentage slowly increase. In the event that the language you’re working on has reached 100% completion, please continue to check Crowdin on a regularly basis. We are constantly adding new content to the site that needs to be translated.

== Ensuring Translation Quality ==

=== Basic Rules ===

* When you have translated a string of text, read it again and see if there are any errors and if the translation sounds right in your language.
* If the translated phrase does not make sense, it is definitely wrong and you should rephrase it.

Of course, it's very important to be correct when translating, but if you happen to mistranslate something, there's a safety mechanism engineered into Crowdin: All the translations you submit will be reviewed by someone else. So rest easy—you won't accidentally take down the site if you mess up a translation.

== Glossary and Translation Memory ==

A helpful tool on Crowdin is the Translation Memory (tab “Search TM") where you can search for specific words and how they have been translated within the iFixit project before. If you work on a string that has been translated before, Crowdin will suggest the old translation. Furthermore, you can check the memory for specific translations that have been used before (''Search TM'' below the translation box). But be careful: Just that they are in the memory is no proof they are still in use – to make sure, check the specific string. With the translation memory, we try to get a continuity in a language even though it has been translated by several different translators.

Moreover, Crowdin offers a ***Glossary*** (''Terminology'' next to ''Comments''). Terms found in the glossary are underlined in the source string. When you hover over them with your cursor, you can see the translation—and, sometimes, additional context or definitions are given. Please stick to the suggested translation to ensure consistency across translations on iFixit.

== Machine Translation ==

Machine translations are translations made by a computer, instead of a human. Crowdin offers Google Translate and Microsoft Translator right below previous translations of a specific string.

But: We see machine translation as a stop-gap. It’s not a solution and even the best machine translations tend to be pretty bad. Human translations are more nuanced, more accurate, and much better. That’s why we ask our translators not to just copy the given translation—except sometimes, when there is nothing to improve on a translation.

== What Should Not Be Translated ==

=== Data Placeholders and Variable Names ===

In many programming languages, a developer can insert data into a string by using a placeholder, such as a % sign followed by a number. You might see something like that on the site. These placeholders should not be modified.

Here are some examples of placeholders you might encounter:

==== I Have %1 Reputation ====

In this case, the" %1" is most likely going to be a number. So when you translate this sentence, place the "%1" where a number would make sense. You can also reword it to something like "I have a Reputation of %1" — but the % and the 1 must always appear in the same order. Likewise, inserting a space between the % and 1 will break the placeholder’s function on iFixit.

==== This is a %1Link%2 to Google ====

When placeholders are surrounding text, then they imply some kind of styling. It can be indicating bold type, italics, URLs, etc. We have done this to reduce the amount of HTML you need to copy. When the placeholder is substituted, the sentence might look like this:

This is a <a href="https://www.google.com">link</a> to Google

Once again, don’t change the order of the placeholders, and don’t insert spaces that didn’t appear in the original text. Otherwise, you could break the link when you translate.

==== Tips and Tricks about Placeholders ====

* In some cases, you might encounter a character that resembles a small square attached to a placeholder. Ignore the small squares in your translations.
* By default, Crowdin enables the option to validate translations. The option checks translations for missing punctuation, variables, and more. This is ideal, except for one small caveat. You may find a string of text that has a placeholder and a word without a space in between, such as "%1Find us on %2facebook"; Crowdin will think that %1F is the placeholder. In which case, if you attempt to commit the translation, you will find yourself with an error message saying you have missed or mistranslated some variables. Go ahead and click 'Save Anyway' and continue with your translations.

=== Formatting XML Tags ===

While we try to minimize it, you may see HTML/XML tags, such as <strong>, used to format text in a string. If you see code, don’t translate it. It shouldn’t be there. Report the issue to iFixit admins.

Display Title

Summary

This brief 1-2 sentence summary will appear in search results.

Additional Information

link to Google"}]},{"type":"paragraph","content":[{"type":"text","text":"Once again, don\u2019t change the order of the placeholders, and don\u2019t insert spaces that didn\u2019t appear in the original text. Otherwise, you could break the link when you translate."}]},{"type":"heading","attrs":{"level":4},"content":[{"type":"text","text":"Tips and Tricks about Placeholders"}]},{"type":"bulletList","attrs":[],"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"In some cases, you might encounter a character that resembles a small square attached to a placeholder. Ignore the small squares in your translations."}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"type":"text","text":"By default, Crowdin enables the option to validate translations. The option checks translations for missing punctuation, variables, and more. This is ideal, except for one small caveat. You may find a string of text that has a placeholder and a word without a space in between, such as \"%1Find us on %2facebook\"; Crowdin will think that %1F is the placeholder. In which case, if you attempt to commit the translation, you will find yourself with an error message saying you have missed or mistranslated some variables. Go ahead and click 'Save Anyway' and continue with your translations."}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"text","text":"Formatting XML Tags"}]},{"type":"paragraph","content":[{"type":"text","text":"While we try to minimize it, you may see HTML\/XML tags, such as <strong>, used to format text in a string. If you see code, don\u2019t translate it. It shouldn\u2019t be there. Report the issue to iFixit admins."}]}]}">

Your contributions are licensed under the open source Creative Commons license.