Skip to content

Commit

Permalink
docs: File Management and String Management
Browse files Browse the repository at this point in the history
  • Loading branch information
andrii-bodnar committed Jul 31, 2024
1 parent 06668eb commit 5614118
Show file tree
Hide file tree
Showing 22 changed files with 256 additions and 31 deletions.
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.
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.
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.
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,9 @@ To change the file's name, right-click on the necessary file or click <Icon name

## Checking Progress

You can check the translation and approval progress for a branch, folder, or file you need. Right-click on the needed branch, folder or file, and select the **Progress**. To see how many words are translated and approved for each language, hover over the progress bar. To open the selected file in the Editor, click on the needed language. To download translations for the chosen file, select the required languages, and click **Build & Download**. Optionally, you can select **Preserve folder hierarchy for export** to export translation files along with the folders they're stored in Crowdin.
You can check the translation and approval progress for a branch, folder, or file you need. Right-click on the needed branch, folder or file, and select the **Progress**. To see how many words are translated and approved for each language, hover over the progress bar. To open the selected file in the Editor, click on the needed language.

To download translations for the chosen file, select the required languages, and click **Build & Download**. Optionally, you can select **Preserve folder hierarchy for export** to export translation files along with the folders they're stored in Crowdin.

<Image src={filesManagementProgresses} alt="File Progress" width="600" />

Expand Down Expand Up @@ -125,6 +127,7 @@ You can create folders and branches in **Sources > Files** with **New Folder** a
Folders represent your content structure, while branches help to manage different versions of the content.

Usually, branches in Crowdin are created automatically if you use GitHub, GitLab, or other VCS integration. Still, if you need to create branches manually, make sure to upload the master branch first, as all the others will be considered the feature branches.

Duplicates might be managed in **Settings > Import > Source Strings** by choosing the corresponding option for *Duplicate Strings*.

<Image src={filesFolderBranch} alt="Branches and Folders" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@ sidebar:
import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';
import ReadMore from '~/components/ReadMore.astro';
import Include from '~/components/Include.astro';
import stringHide from '!/crowdin/project-management/sources/string_hide.png';
import stringFilter from '!/crowdin/project-management/sources/string_filter.png';
import stringEdit from '!/crowdin/project-management/sources/string_edit.png';
import labelsAdding1 from '!/crowdin/project-management/sources/labels_adding_1.png';
import labelsAdding2 from '!/crowdin/project-management/sources/labels_adding_2.png';
import labelsAddingToOneString from '!/crowdin/project-management/sources/labels_adding_to_one_string.png';
import labelsAddingToMultipleStrings from '!/crowdin/project-management/sources/labels_adding_to_multiple_strings.png';

You can view all the project's strings and manage strings settings via **Sources > Strings**.

Expand All @@ -39,66 +40,49 @@ Once the translation limits are exceeded, the system notifies the contributor th

Some file formats allow editing (adding, deleting, and modifying) of the source texts and string identifiers directly in Crowdin so you can do the necessary corrections without updating the source file via **Sources > Files**. Check the full list below:

* [Android XML](https://store.crowdin.com/android-xml)
* [iOS Strings](https://store.crowdin.com/strings)
* [JSON](https://store.crowdin.com/json)
* [i18next JSON](https://store.crowdin.com/i18next-json)
* [XLIFF 1.2](https://store.crowdin.com/xliff)
* [XLIFF 2.0](https://store.crowdin.com/xliff2.0)
* [Angular XLF](https://store.crowdin.com/angular)
* [GNU Gettext PO](https://store.crowdin.com/gnu-gettext)
* [Unreal Engine Gettext PO](https://store.crowdin.com/gettext-unreal)
* [YAML](https://store.crowdin.com/yaml)
* [RESX](https://store.crowdin.com/resx)
* [CSV](https://store.crowdin.com/csv)
* [ARB](https://store.crowdin.com/arb)
* [Java Properties](https://store.crowdin.com/java-properties)
* [Properties Play](https://store.crowdin.com/properties-play)
* [Properties XML](https://store.crowdin.com/properties-xml)
<Include file="editable-formats-list.mdx" />

<Image src={stringEdit} alt="String Editing" width="500" />

To edit some particular word or phrase that appears in multiple source strings, you can use the **Find & Replace** feature in **Sources > Strings**.

<Aside>
<Aside type="caution">
When editing the identifier of a string contained in a group of strings (string array for Android XML, segments for XLIFF), the existing translations will be removed for all group strings but the edited one.
</Aside>

## Labels

Use labels in your project for an easy way to add context to the strings or organize them by certain topics. Labels are also useful while creating translation and proofreading tasks or searching for specific strings in the Editor with the help of [Advanced Filter](/online-editor/).
Use labels in your project for an easy way to add context to the strings or organize them by certain topics. Labels are also useful while creating translation and proofreading tasks or searching for specific strings in the Editor with the help of [Advanced Filter](/online-editor/#advanced-filter).

<LinkCard
title="Managing Project Labels"
description="Learn how to make your Crowdin project labels."
href="/project-settings/labels/"
/>

### Adding Labels to Strings

There are a few possible ways you can add labels to the strings.

#### Add labels to one string at a time via the *Edit String* dialog
##### Add labels to one string at a time via the *Edit String* dialog

<Steps>
1. Click **Edit** on the string in the list.
2. Select needed labels in the *Labels* field. <Image src={labelsAdding1} alt="Add Labels" width="500" />
2. Select needed labels in the *Labels* field. <Image src={labelsAddingToOneString} alt="Add Labels" width="500" />
3. Click **Save**.
</Steps>

#### Add labels to multiple strings via the *Manage Strings Labels* dialog
##### Add labels to multiple strings via the *Manage Strings Labels* dialog

<Steps>
1. Select a few strings you want to add the same labels to.
2. Click **Labels**.
3. Select needed labels in the *Labels to be added* field. <Image src={labelsAdding2} alt="Add Labels" width="500" />
3. Select needed labels in the *Labels to be added* field. <Image src={labelsAddingToMultipleStrings} alt="Add Labels" width="500" />
4. Click **Save**.
</Steps>

#### Add labels to the source strings in CSV and XLSX files using a dedicated column for labels
##### Add labels to the source strings in CSV and XLSX files using a dedicated column for labels

<ReadMore>
Read more about [Configuring Columns for Import for XLSX and CSV Files](/csv-xlsx-configuration/).
Read more about [Configuring Columns for Import](/csv-xlsx-configuration/#configuring-columns-for-import).
</ReadMore>

<Aside>
Expand Down
5 changes: 5 additions & 0 deletions src/content/docs/enterprise/online-editor/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ sidebar:
---

https://support.crowdin.com/enterprise/online-editor/


#### File Context

### Advanced Filter
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ slug: enterprise/csv-xlsx-configuration
---

https://support.crowdin.com/enterprise/csv-xlsx-configuration/

## Configuring Columns for Import

## Changing Scheme for CSV and XLSX Files
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,129 @@ sidebar:
order: 2
---

https://support.crowdin.com/enterprise/file-management/
import { Aside } from '@astrojs/starlight/components';
import { Icon } from 'astro-icon/components';
import ReadMore from '~/components/ReadMore.astro';
import { Image } from 'astro:assets';
import filesParserConfiguration from '!/enterprise/project-management/sources/files_parser_configuration.png';
import filesFileContext from '!/enterprise/project-management/sources/files_file_context.png';
import filesProgress from '!/enterprise/project-management/sources/files_progress.png';
import filesFileTargetLanguages from '!/enterprise/project-management/sources/files_file_target_languages.png';
import filesRestore from '!/enterprise/project-management/sources/files_restore.png';
import filesSettings from '!/enterprise/project-management/sources/files_settings.png';
import filesUpdate from '!/enterprise/project-management/sources/files_update.png';

You can manage all the project's files via **Sources > Files**. Here you can manually upload files for localization using various [supported formats](/enterprise/supported-formats).
When the files are uploaded, you'll be able to take a glance at how many *Strings* your files include and how many *Revisions* (changes) were done to each of them.

If you want to configure an automatic files' synchronization with your project, use the **Integrations** tab.

## Prioritizing Files

You can set a specific priority for each file by clicking an arrow icon next to the needed file. Then translators will be able to see files sorted according to their priority on the language page and in the Editor.

Files might have the following priorities:

- <Icon name="mdi:arrow-down" class="inline-icon text-emerald-700" /> – low
- <Icon name="mdi:arrow-up" class="inline-icon text-orange-700" /> – normal
- <Icon name="mdi:arrow-up" class="inline-icon text-red-700" /> – high

## File Settings

To access the configurations of specific files, right-click on the necessary file or click <Icon name="mdi:dots-vertical" class="inline-icon" /> next to it and then select **Settings**.

### Title as it is shown to translators

Set more descriptive titles for the files to provide additional details for translators.

<Aside type="caution">
The file title is only shown in the Crowdin Enterprise UI and doesn't rename the actual file.
</Aside>

### File Export

Define a file name or full path in the resulting archive, use the available placeholders to indicate the structure of exported content.

For example, you want the source file `Overview.csv` with Ukrainian translation to be named `Overview.ukrainian.csv` before integrating it with the application. In this case, you'd need to set the *Resulting file after translations export* to the following: `Overview.%language%.csv`.

By default, Crowdin Enterprise adds [Crowdin language codes](https://developer.crowdin.com/language-codes/) during the file export. To use custom ones for specific languages in the whole project, set up [Language Mapping](/enterprise/project-settings/languages#adding-custom-language-codes).

<Image src={filesSettings} alt="File Settings" width="600" />

### Parser Configuration

Some file formats allow you to configure import and export behavior. In this case, file's Settings dialog will also contain the **Parser configuration** tab.

<Image src={filesParserConfiguration} alt="Parser Configuration" width="600" />

<ReadMore>
Read more about [Parser configuration](/enterprise/project-settings/parser-configuration).
</ReadMore>

### File Target Languages

By default, the source files are available for translation into all target languages of the project. Clear the checkboxes next to the languages your file shouldn't be translated into, and click **Save**.

<Image src={filesFileTargetLanguages} alt="File Target Languages" width="600" />

### File Context

Add additional context or instructions for translators to better understand how to translate a file. You can use either plain text or Markdown. The provided context will be visible to translators in the Editor in the [File Context](/enterprise/online-editor#file-context) tab.

<Image src={filesFileContext} alt="File Context" width="600" />

<Aside type="caution" title="Limitations">
File Context is only available for [file-based](/enterprise/creating-project#project-types) projects.
</Aside>

## Renaming Files

To change the file's name, right-click on the necessary file or click <Icon name="mdi:dots-vertical" class="inline-icon" /> next to it and select **Rename**.

## Checking Progress

You can check the translation and approval progress for a branch, folder, or file you need. Right-click on the needed branch, folder or file, and select the **View progress**. To see how many words are translated and approved for each language, hover over the progress bar. To open the selected file in the Editor, click on the needed language.

To download translations for the chosen file, select the required languages in the **Details** tab in the right-hand side menu, and click <Icon name="mdi:cloud-download" class="inline-icon" />. Optionally, you can select **Preserve folder hierarchy for export** to export translation files along with the folders they're stored in Crowdin Enterprise.

<Image src={filesProgress} alt="Files Progress" />

## Updating Source Files

In case you have added some new strings to one of the source files, you'd want to update it to make newly added strings visible to translators.
Right-click on the needed file, select **Update**, and then select the new file on your machine.

If some of the source strings were modified, the system shows a dialog with a list of edited strings. You'll be able to choose which existing translations you want to keep without changes (*Current strings* column) and whether you want to keep or remove approvals. The translations for other changed strings will be removed.

<Image src={filesUpdate} alt="Files Update" width="600" />

## Restoring Previous Versions

Each time you update the source file, a new revision is created. To restore your file to the previous revision, click the number on the needed file in the *Revision* column. In the **Revisions** tab in the right sidebar, hover over the needed revision and click **Restore** next to it.

<Image src={filesRestore} alt="Files Restore" />

## Branches and Folders

You can create folders and branches in **Sources > Files** with the following buttons:

- <Icon name="material-symbols:create-new-folder-sharp" class="inline-icon" /> – create folder
- <Icon name="material-symbols:folder-data-sharp" class="inline-icon" /> – create branch

Folders represent your content structure, while branches help to manage different versions of the content.

Usually, branches in Crowdin Enterprise are created automatically if you use GitHub, GitLab, or other VCS integration. Still, if you need to create branches manually, make sure to upload the master branch first, as all the others will be considered the feature branches.

Duplicates might be managed in **Settings > Import > Source Strings** by choosing the corresponding option for *Duplicates*.

<ReadMore>
Read more about [Version Management](/enterprise/version-management).
</ReadMore>

## Changing Scheme for CSV and XLSX Files

File formats like CSV and XLSX might require changing the initially configured scheme. Usually, it might be needed when you add a new target language to your Crowdin project.

<ReadMore>
Read more about [changing the scheme for CSV and XLSX files](/enterprise/csv-xlsx-configuration#changing-scheme-for-csv-and-xlsx-files).
</ReadMore>
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,88 @@ sidebar:
order: 3
---

https://support.crowdin.com/enterprise/file-management/#strings-management (check crowdin strings management)
import { Steps, Aside, LinkCard } from '@astrojs/starlight/components';
import { Image } from 'astro:assets';
import ReadMore from '~/components/ReadMore.astro';
import Include from '~/components/Include.astro';
import { Icon } from 'astro-icon/components';
import stringHide from '!/enterprise/project-management/sources/string_hide.png';
import stringFilter from '!/enterprise/project-management/sources/string_filter.png';
import stringEdit from '!/enterprise/project-management/sources/string_edit.png';
import labelsAddingToOneString from '!/enterprise/project-management/sources/labels_adding_to_one_string.png';
import labelsAddingToMultipleStrings from '!/enterprise/project-management/sources/labels_adding_to_multiple_strings.png';

You can view all the project's strings and manage strings settings via **Sources > Strings**.

## Changing Strings Visibility

If some strings contain data that is not supposed to be translated (e.g., placeholders, other technical entities), you can hide them from translators. To do this:

<Steps>
1. Open your project and go to **Sources > Strings**.
1. Select the necessary strings.
1. Click <Icon name="mdi:eye-off" class="inline-icon" />.
</Steps>

<Image src={stringHide} alt="Hiding Strings" />

## Filtering Strings

By default, all source strings of the project are displayed in **Sources > Strings**. If necessary, you can filter out strings using the available filter options (Issues: All, With unresolved issues, Without unresolved issues; Comments: All, With comments, Without comments; Screenshots: All, With screenshots, Without screenshots; Visibility: All, Visible only and Hidden only) and project labels.

<Image src={stringFilter} alt="Filtering Strings" />

## String Editing

You can add context to the string and set the max. length of the translation. Once the translation limits are exceeded, the system notifies the contributor that translation should be shorter.

Some file formats allow editing (adding, deleting, and modifying) of the source texts and string identifiers directly in Crowdin Enterprise so you can do the necessary corrections without updating the source file via **Sources > Files**. Check the full list below:

<Include file="editable-formats-list.mdx" />

<Image src={stringEdit} alt="Editing Strings" width="500" />

To edit some particular word or phrase that appears in multiple source strings, you can use the <Icon name="mdi:find-replace" class="inline-icon" /> **Find and replace** feature in **Sources > Strings**.

<Aside type="caution">
When editing the identifier of a string contained in a group of strings (string array for Android XML, segments for XLIFF), the existing translations will be removed for all group strings but the edited one.
</Aside>

## Labels

Use labels in your project for an easy way to add context to the strings or organize them by certain topics. Labels are also useful while creating translation and proofreading tasks or searching for specific strings in the Editor with the help of [Advanced Filter](/enterprise/online-editor/#advanced-filter).

<LinkCard
title="Managing Project Labels"
description="Learn how to make your Crowdin project labels."
href="/enterprise/project-settings/labels/"
/>

There are a few possible ways you can add labels to the strings.

##### Add labels to one string at a time via the *Edit String* dialog

<Steps>
1. Right-click on the string in the list and select **Edit**.
1. Select needed labels in the *Labels* field.
1. Click **Save**. <Image src={labelsAddingToOneString} alt="Adding Labels" width="500" />
</Steps>

##### Add labels to multiple strings via the *Manage Strings Labels* dialog

<Steps>
1. Select a few strings you want to add the same labels to.
1. Click <Icon name="mdi:label" class="inline-icon" />.
1. Select needed labels from the list.
1. Click **Apply**. <Image src={labelsAddingToMultipleStrings} alt="Adding Labels" />
</Steps>

##### Add labels to the source strings in CSV and XLSX files using a dedicated column for labels

<ReadMore>
Read more about [Configuring Columns for Import](/enterprise/csv-xlsx-configuration/#configuring-columns-for-import).
</ReadMore>

<Aside>
String labels added to the project with an initial CSV/XLSX file upload won't be overwritten or removed with subsequent file updates.
</Aside>
Loading

0 comments on commit 5614118

Please sign in to comment.