Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(crowdin+enterprise): Update Online Editor, For Translators articles #117

Merged
merged 5 commits into from
Sep 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/comment_new.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/html_preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/multi_approve.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/qa_pop-up.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/quick_access.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/request_context.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified src/assets/screenshots/crowdin/online-editor/rtl.png
Diff not rendered.
Diff not rendered.
Binary file modified src/assets/screenshots/crowdin/online-editor/search_tm.png
Binary file modified src/assets/screenshots/crowdin/online-editor/search_tm_tab.png
Diff not rendered.
Diff not rendered.
Binary file modified src/assets/screenshots/crowdin/online-editor/task_menu.png
Binary file modified src/assets/screenshots/crowdin/online-editor/task_name.png
Diff not rendered.
Binary file modified src/assets/screenshots/crowdin/online-editor/terms.png
Diff not rendered.
Diff not rendered.
Binary file modified src/assets/screenshots/crowdin/online-editor/vote.png
Diff not rendered.
66 changes: 38 additions & 28 deletions src/content/docs/crowdin/getting-started/for-translators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ import { Image } from 'astro:assets';
import profileFull from '!/crowdin/getting-started/profile_full.png';
import showcases from '!/crowdin/getting-started/showcases.png';
import projectDashboard from '!/crowdin/getting-started/project_dashboard.png';
import onlineEditorSections from '!/crowdin/online-editor/sections.png';
import votingView from '!/crowdin/online-editor/voting_view.png';
import sbsEditor from '!/crowdin/online-editor/sbs_editor.png';
import vote from '!/crowdin/online-editor/vote.png';
import volunteerEditorMenu from '!/crowdin/getting-started/volunteer_editor_menu.png';

> Crowdin is a localization management platform that helps companies translate their software. In this article, you will find information on how you can contribute to localization projects as a translator.
Expand Down Expand Up @@ -44,7 +44,7 @@ Visit our [Showcases](https://crowdin.com/projects#showcases) page, where you ca
<Image src={showcases} alt="Showcases" />

<Aside type="tip" title="Volunteer translator?">
*Crowdsourcing* is an approach that engages a community for one common goal &ndash; to translate products on a volunteer basis into various target languages. As a volunteer translator, you can help organizations with localization by translating in Crowdin.
Crowdsourcing is an approach that engages a community of volunteers, often product fans, to translate products into various target languages. As a volunteer translator, you can help organizations with localization by translating in Crowdin.
</Aside>

## Explore Your Workspace
Expand All @@ -71,9 +71,9 @@ Once you find and open the needed project, you can access the following tabs:

<Image src={projectDashboard} alt="Project Home" />

## Work in the Editor
## Working in the Editor

The Editor is the main place where project members can suggest translations online. In the left section, you can see a list of strings in the selected file. An active string is highlighted. All the details about the string are shown in the middle and right sections.
The Editor is where translators and proofreaders work on translations online. The String List section displays strings from the selected file or all project strings, with the active string highlighted. String context and details for the selected string appear in the String Details section.

<LinkCard
title="Online Editor"
Expand All @@ -84,28 +84,47 @@ The Editor is the main place where project members can suggest translations onli

Collaborate with other project members, discuss any issues or questions in the Comments section, vote for the best translation variants, and take advantage of the project [Glossary](/glossary/) and [Translation Memory](/translation-memory/). Use the machine translations as a basis for your own suggestions.

<Image src={onlineEditorSections} alt="Editor Sections" />
<Image src={sbsEditor} alt="Side-by-side Editor mode" />
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved

#### Section 1 (Left sidebar)
#### String List
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved

In the left section, you will see the list of strings for translation. Strings are text elements that are either individual words, expressions, or sentences. Some of them might have replacement tokens ({0}, {1}, or %1) or elements of ICU message syntax. To work with such strings, you should copy the source string and translate only the real words.
The **String List** is your primary workspace for managing translations.

#### Section 2 (Middle-top area)
##### Layout and Status

Middle-top section is the main working area, with the source string on the top and the translation section below. The *Context* of the string is shown right below the source string. You can request context from project managers from here if necessary. In the translation window, you may also see the *maximum length* of the translation limit in case it’s exceeded.
* Source Text: On the left.
* Translations: On the right.
* Status icons indicate whether strings are untranslated, translated, or approved. Comments or issues are highlighted.

#### Section 3 (Middle-bottom area)
##### Searching and Filtering

This section contains all the resources and previous translations you may use:
* Use the *Search in file* field to locate strings.
* Apply Simple or Advanced Filters to sort and filter strings.

* Translations from other project members
##### QA Checks

Pop-up messages may appear to alert you to potential issues, such as inconsistent punctuation, mismatched spaces, or missing variables. These checks help maintain translation quality.

#### String Details

The context of the string is displayed in the *String details* section in the right panel. Typically, this can include descriptions and screenshots. You can request context from here if needed.

#### Suggestions and Translations

This section contains all the resources and previous translations that might be useful:

* Translations by other project members
* Translation Memory (TM) suggestions
* Machine Translation (MT) engine suggestions
* Translations into other languages
* Machine Translation (MT) suggestions
* Translations to other languages

#### Section 4 (Right sidebar)
If you see that there is already a correct suggestion, vote for it by clicking the *plus* <Icon name="mdi:plus" class="inline-icon" /> sign if you like the translation, or the *minus* <Icon name="mdi:minus" class="inline-icon" /> sign if you don't think the translation is correct. Translations that receive the most positive votes will have a higher rating and will appear at the top of all available translations for the string.

You can use this section to discuss the meaning of the source string or other related questions with other project members. You can mention the particular person you’d like to address or create an issue related to the string.
<Image src={vote} alt="Vote" />

#### Comments

In the *Comments* section, you can discuss the meaning of the source string or other related questions with other project members. Use “@” and a username to mention the specific person or create an issue related to the string.

### Main Menu

Expand All @@ -115,19 +134,10 @@ The Main menu <Icon name="mdi:menu" class="inline-icon" /> in the upper-left cor

### Keyboard Shortcuts

Click <Icon name="mdi:keyboard" class="inline-icon" /> in the upper-right corner to see the list of available keyboard shortcuts. They will help to do things in the Editor faster and without using a mouse, trackpad, or other input device.

Most shortcuts can be customized. Click on the needed key combination and then change it using your keyboard.

### Side-By-Side View

Using the Side-By-Side Editor view, you can comfortably vote for multiple best translations in a row made by other project members.

Click the Main menu <Icon name="mdi:menu" class="inline-icon" /> in the upper-left corner, then choose **View** > **Side-By-Side**.
Click <Icon name="mdi:keyboard" class="inline-icon" /> in the upper-right corner to see the list of available keyboard shortcuts. They can make your work in the Editor more efficient and fast.

To vote, click on the *plus* <Icon name="mdi:plus" class="inline-icon" /> sign if you like the translation or the *minus* <Icon name="mdi:minus" class="inline-icon" /> if the translation doesn't seem correct. Translations that get the most positive votes will then appear on the top of all the translations available for the string.
Most shortcuts can be customized. Click on the needed key combination and modify it using your keyboard.

<Image src={votingView} alt="Voting view" />

## Offline Translation

Expand Down
Loading