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(project-settings): Export section improvements #136

Merged
merged 1 commit into from
Sep 20, 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
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,40 @@ sidebar:
import { Aside } from '@astrojs/starlight/components';
import Include from '~/components/Include.astro';

By default, when exporting translations, Crowdin fills untranslated strings with source text to avoid exporting empty files. You can change this behavior in the **Export** section of the Project Settings.
In the **Export** section of the Project Settings, you can configure the translations export behavior. There are several options available to customize the export settings according to your needs including advanced options for each specific language.

## Save context information in the files
## Translations Export Settings

By default, when exporting translations, Crowdin fills untranslated strings with source text to avoid exporting empty files. You can change this behavior by using the options below.

### Save context information in the files

The context and max.length added in Crowdin will be visible in the downloaded files. This option only applies to CSV, Android XML, iOS strings, and RESX formats.

<Aside type="caution" title="Limitations">
This option only partially applies to iOS strings and RESX formats (i.e., only the context added in Crowdin will be visible in the downloaded files).
</Aside>

## Skip untranslated strings
### Skip untranslated strings

Only translated strings will be included in the exported translation files.

This option works in three different ways, depending on the file format. This option is not applied to text-formatted documents since missing texts can make downloaded files unreadable. Others are exported with empty values. And for the third file category, untranslated strings are entirely removed from the exported translation files.

<Include file="skip-untranslated-strings-formats.mdx" />

## Skip untranslated files
### Skip untranslated files

Only 100% translated files will be included in the exported translation archive.

<Aside>
if this option is enabled, it overrides the effect of the *Skip untranslated strings* option.
</Aside>

## Export only approved translations
### Export only approved translations

Only texts that are both translated and approved will be included in the exported translation files.

## Automatically fill in regional dialects
### Automatically fill in regional dialects

Useful when the project is translated into the language dialects (e.g., Spanish, Argentina). On export, translations from Spanish will be automatically copied to untranslated strings in Spanish, Argentina.
Original file line number Diff line number Diff line change
Expand Up @@ -11,56 +11,66 @@ import { Aside } from '@astrojs/starlight/components';
import ReadMore from '~/components/ReadMore.astro';
import Include from '~/components/Include.astro';

By default, when exporting translations, Crowdin Enterprise fills untranslated strings with source text to avoid exporting empty files. You can change this behavior in the **Export** section of the Project Settings.
In the **Export** section of the Project Settings, you can configure the translations export behavior. There are several options available to customize the export settings according to your needs including advanced options for each specific language.

## Export strings with at least 1 translation
## Translations Export Settings

By default, when exporting translations, Crowdin Enterprise fills untranslated strings with source text to avoid exporting empty files. You can change this behavior by using the options below.

### Export strings with at least 1 translation

Choose if you want to export all translated strings without approval.

## Export translations with a specific number of approvals
### Export translations with a specific number of approvals

Choose if you want to export only strings with approved translations. Make sure the number of required approvals set isn't higher than the actual number of proofreading steps in your project workflow.

<Aside>
<Aside type="caution">
Number of required approvals cannot be higher than number of proofreading steps present in the project workflow.
</Aside>

## Export strings that passed workflow
### Export strings that passed workflow

Strings that reached the End step will be included in the exported files.

<ReadMore>
Read more about [Workflows](/enterprise/workflows/).
</ReadMore>

## Automatically fill in regional dialects
### Automatically fill in regional dialects

Useful when the project is translated into the language dialects (e.g., Spanish, Argentina). On export, translations from Spanish will be automatically copied to untranslated strings in Spanish, Argentina.

## Skip untranslated strings
### Skip untranslated strings

Only translated strings will be included in the exported translation files.

This option works in three different ways, depending on the file format. This option is not applied to text-formatted documents since missing texts can make downloaded files unreadable. Others are exported with empty values. And for the third file category, untranslated strings are entirely removed from the exported translation files.

<Include file="skip-untranslated-strings-formats.mdx" />

## Skip untranslated files
### Skip untranslated files

Only 100% translated files will be included in the exported translation archive.

<Aside>
if this option is enabled, it overrides the effect of the *Skip untranslated strings* option.
</Aside>

## Save context information in the files
### Save context information in the files

The context and max.length added in Crowdin Enterprise will be visible in the downloaded files. This option only applies to CSV, Android XML, iOS strings, and RESX formats.

<Aside type="caution" title="Limitations">
This option only partially applies to iOS strings and RESX formats (i.e., only the context added in Crowdin Enterprise will be visible in the downloaded files).
</Aside>

# Advanced Options
## Advanced Export Options

You can configure individual export settings for each specific language in your project by clicking on **Advanced Options**.

In this section, you can configure the following settings for each target language in your project:

- [Export strings with at least 1 translation](#export-strings-with-at-least-1-translation).
- [Export translations with a specific number of approvals](#export-translations-with-a-specific-number-of-approvals).
- [Export strings that passed workflow](#export-strings-that-passed-workflow).