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 2 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.
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved
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.
Binary file modified src/assets/screenshots/crowdin/online-editor/plural_tabs.png
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved
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/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
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/save.png
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
Binary file modified src/assets/screenshots/crowdin/online-editor/section_2.png
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved
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
45 changes: 29 additions & 16 deletions src/content/docs/crowdin/getting-started/for-translators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ slug: for-translators
---

import { Aside, LinkCard } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved
import { Icon } from 'astro-icon/components';
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 sbsEditor from '!/crowdin/online-editor/save_translation.png';
import votingView from '!/crowdin/online-editor/voting_view.png';
import volunteerEditorMenu from '!/crowdin/getting-started/volunteer_editor_menu.png';

Expand Down Expand Up @@ -71,7 +72,7 @@ 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.

Expand All @@ -84,28 +85,40 @@ 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.
String list section is the main working area, which displays the list of strings for translation with the source texts on the left and translations on the right. Each string is marked with the symbol that helps you identify its state - untranslated, translated, or approved. You'll also be able to identify strings that have comments or related issues.

#### Section 2 (Middle-top area)
To find the needed string, type your search phrase in the *Search in file* (*Search strings*) field in this section. You can filter and sort the source strings using the Simple or Advanced Filter.

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.
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.

#### Section 3 (Middle-bottom area)
At the top of the string list, you may also see the translation *maximum length* of the currently selected string. It will be marked with red if the translation limit is exceeded.

This section contains all the resources and previous translations you may use:
The terms added to the project glossary are underlined in the source string. You can review the additional explanation added to the term to make sure the translation is correct. A project manager can also give you permission to add terms to the project glossary.

* Translations from other project members
If the source string has highlighted elements, it means that the string contains the elements of ICU message syntax. You should copy the source to translate this type of source string.

<ReadMore>
Read more about the [ICU Message Syntax](/icu-message-syntax/) in the Editor.
</ReadMore>

You may also get pop-up messages about QA checks that will help you avoid translation inaccuracies, such as inconsistent punctuation, mismatched spaces, missing variables, etc.

#### 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)
#### Comments

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.
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,9 +128,9 @@ 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.
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.

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

### Side-By-Side View
rohalskyy marked this conversation as resolved.
Show resolved Hide resolved

Expand Down
Loading