Skip to content
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
760 changes: 385 additions & 375 deletions package-lock.json

Large diffs are not rendered by default.

24 changes: 12 additions & 12 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,14 @@
"og-images": "npm run generate-og-images && npm run convert-og-images"
},
"dependencies": {
"@docusaurus/babel": "^3.9.1",
"@docusaurus/core": "^3.9.1",
"@docusaurus/mdx-loader": "^3.9.1",
"@docusaurus/plugin-content-docs": "^3.9.1",
"@docusaurus/preset-classic": "^3.9.1",
"@docusaurus/theme-classic": "^3.9.1",
"@docusaurus/theme-common": "^3.9.1",
"@docusaurus/utils": "^3.9.1",
"@docusaurus/babel": "^3.9.2",
"@docusaurus/core": "^3.9.2",
"@docusaurus/mdx-loader": "^3.9.2",
"@docusaurus/plugin-content-docs": "^3.9.2",
"@docusaurus/preset-classic": "^3.9.2",
"@docusaurus/theme-classic": "^3.9.2",
"@docusaurus/theme-common": "^3.9.2",
"@docusaurus/utils": "^3.9.2",
"@emotion/react": "^11.11.4",
"@emotion/styled": "^11.11.5",
"@mui/icons-material": "^5.15.15",
Expand Down Expand Up @@ -63,10 +63,10 @@
]
},
"devDependencies": {
"@docusaurus/eslint-plugin": "^3.9.1",
"@docusaurus/module-type-aliases": "^3.9.1",
"@docusaurus/plugin-client-redirects": "^3.9.1",
"@docusaurus/tsconfig": "^3.9.1",
"@docusaurus/eslint-plugin": "^3.9.2",
"@docusaurus/module-type-aliases": "^3.9.2",
"@docusaurus/plugin-client-redirects": "^3.9.2",
"@docusaurus/tsconfig": "^3.9.2",
"@types/imagemagick": "0.0.31",
"@types/node": "18.6.3",
"@types/react": "^18.2.29",
Expand Down
36 changes: 18 additions & 18 deletions platform/getting_started/about_tolgee.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: about_tolgee
title: About Tolgee
sidebar_label: About Tolgee
title: What is Tolgee? Developer-Friendly TMS
sidebar_label: What is Tolgee?
slug: /
image: /img/og-images/platform.png
---
Expand All @@ -11,34 +11,34 @@ import { ReviewAuthor } from '../shared/_ReviewAuthor';
Tolgee is a **localization platform** that allows you to translate your application into any language without modifying your code.
It is designed to be used with web applications, but it can be used also with mobile apps and desktop applications.

Tolgee is a developer-focused platform, so it is **easy to integrate** with your application.
Tolgee is a developer-focused Translation Management System (TMS) that helps with internationalization (i18n), and it is **easy to integrate** with your application.
No more looking for keys in your source code, no more editing localization files, and no more manual exporting data for translators.

## Features
<ReviewAuthor
author={{
imageURL: '/img/reviewers/thibaud.jpeg',
name: 'Thibaud C.',
title: 'Lead Developper',
}}
description="Tolgee is very easy to use and to integrate with i18n libraries. We like it a lot for its collaboration capabilities."
capterraReview="https://www.capterra.com/p/10002120/Tolgee/reviews/Capterra___4438876/"
/>

## Key Features of Tolgee Localization Platform

- **Developer-friendly** - Tolgee is designed to be easy to integrate with your application. There are integrations for web frameworks via the [Tolgee JS SDK](/js-sdk) and for native mobile apps via the [Tolgee iOS SDK](/ios-sdk) and [Tolgee Android SDK](/android-sdk).
- **Easy to use** - Tolgee is easy to use for developers, but also for translators, so you can easily involve your translators into your localization process.
- **Open-source** - Tolgee is open-source, you can contribute to the project on our [GitHub repository](https://github.com/tolgee/tolgee-platform). You can also [host your own instance](/platform/self_hosting/getting_started) of Tolgee, so you can have full control over your data.
- **Free** - Our **cloud version** includes Business plan with 10,000 keys is **free for any open-source projects**. For commercial projects, you can use Tolgee for free up to 500 keys. For more information, see [pricing](https://tolgee.io/pricing).
- **In-context editor** - Tolgee provides in-context editor, so translators can easily translate your application without leaving your application.
- **AI translator** — [AI Translator](/platform/translation_process/ai_translator) can make software localization much faster and more autonomous. It provides more accurate translations than general translators as it gathers context through Tolgee's native JS SDKs, which provide in-context dialogs.
- **AI translator** — [AI Translator](/platform/translation_process/ai_translator) can make software localization much faster and more autonomous. It provides more accurate translations than general translators as it gathers context through Tolgee's native JS SDKs, which provide in-context dialogs.

## Intrigued yet?
## Start using Tolgee

If you want to try Tolgee, you can [sign up](https://app.tolgee.io/sign_up) for free and start using it right away. After you sign up, you will be able to [create your first project](/platform/getting_started/creating_project) and start translating your application.

## Other Tolgee Docs

- [JavaScript SDK](/js-sdk)
- [Tolgee JavaScript SDKs](/js-sdk)
- [Tolgee CLI](/tolgee-cli)
- [REST API](/api)

<ReviewAuthor
author={{
imageURL: '/img/reviewers/thibaud.jpeg',
name: 'Thibaud C.',
title: 'Lead Developper',
}}
description="Tolgee is very easy to use and to integrate with i18n libraries. We like it a lot for its collaboration capabilities."
capterraReview="https://www.capterra.com/p/10002120/Tolgee/reviews/Capterra___4438876/"
/>
- [Tolgee REST API](/api)
8 changes: 5 additions & 3 deletions platform/getting_started/creating_project.mdx
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
---
id: creating_project
title: Creating Project
sidebar_label: Creating Project
title: How to Create a Project in Tolgee
sidebar_label: How to Create a Project
image: /img/og-images/platform.png
---

import { ScreenRecording } from '../shared/_ScreenRecording';

After logging in or clicking on Tolgee logo in left top corner, you will be redirected to the Projects list view.

## Tolgee Project Setup: A Tutorial Setting Up Base Language

To create a project, click the `+ Add` button in the upper right corner. Then fill the name of the project and select the languages (you can also create a custom language).

You need to select one of the languages as a **base language** this language will be used as a source of translations. You can add more languages later in the [Languages settings](/platform/projects_and_organizations/languages#editing-languages).
You need to select one of the languages as a **base language** - this language will be used as a source of translations. You can add languages to a project later in the [Languages settings](/platform/projects_and_organizations/languages#edit-language-settings-and-properties).

<ScreenRecording>
<source src="/create-project.mov" />
Expand Down
20 changes: 10 additions & 10 deletions platform/getting_started/translation_content.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
---
id: files_and_integrations
title: Translation Files and Integrations
sidebar_label: Translation Files and Integrations
title: Import and Export Translation Files
sidebar_label: Import and Export Files
description: Learn how you can import existing files into the project and use our JS SDK or Android SDK to seamlessly integrate your code with your Tolgee project.
image: /img/og-images/platform.png
---

After you have [created a project](creating_project), you can import existing files into the project, use our JS SDK or Android SDK to seamlessly integrate your code with your Tolgee project, or use our API to integrate your project with your own system.

## Importing files
## How to Import Translation Files into Tolgee

To import existing translation files into your project, open the created project and click on the `Import` menu item.
Then select what language and [namespace](/platform/translation_keys/namespaces) (not required) you want to import the files into and click the `Import` button.
To import existing translation files (or, in other words, localization files) into your project (like JSON translation files), open the created project and click on the `Import` menu item.
Then select what language and [namespace](/platform/translation_keys/namespaces) (not required) you want to import the files into and click the `Import` button. This way you can bulk import translations and save time on manually adding translations.

More information about importing files can be found in the [Import](/platform/projects_and_organizations/import) page.
More information about importing files and file format can be found in the [Import](/platform/projects_and_organizations/import) page.

## Exporting files
## How to Export Translation Files into Tolgee

To export the translations, open the project and click on the `Export` menu item.
Then select what languages, file formats and [namespaces](/platform/translation_keys/namespaces) you want to export and click the `Export` button.

More information about exporting files can be found in the [Export](/platform/projects_and_organizations/export) page.

## JS SDK
## JavaScript SDK Integration for Localization

Tolgee provides a [JS SDK](/js-sdk) that can be used to easily integrate your Tolgee project with your codebase.
This way, you can use the same translation keys in your code as you use in your Tolgee project.
Expand All @@ -31,11 +31,11 @@ In production mode, you should use data exported from the Tolgee platform.
To export the translation files, see [exporting translations](/platform/projects_and_organizations/export).
Then provide the data via Tolgee configuration options described in [Providing static data](/js-sdk/providing-static-data).

## iOS SDK
## iOS SDK for Localization

Tolgee provides a native [iOS SDK](/ios-sdk) with a great support for SwiftUI that integrates with your app and supports OTA updates of strings from a CDN.

## Android SDK
## Android SDK for Localization

Tolgee also provides an [Android SDK](/android-sdk) for native Android apps, including Jetpack Compose support. Follow the Android docs to:

Expand Down
12 changes: 6 additions & 6 deletions platform/projects_and_organizations/ai_settings.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
id: ai-settings
title: AI Settings
title: AI Translation Settings
image: /img/og-images/platform.png
---

import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';

## Prompts section
## Custom AI Prompts for AI translation

<ScreenshotWrapper
alt="Providing project description"
Expand All @@ -15,12 +15,12 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';

In this section, you can see all custom prompts for the current project.

### Adding new prompt
### Create Custom Translation Prompts

Click on `+ Prompt` (or `OpenAi Playground` if the list is empty); this will redirect you to the
[AI Playground](../translation_process/ai_playground.mdx) with default prompt, which you can edit and save as a custom prompt.

### Managing prompts
### Edit and Manage AI Prompts

Click on the`⋮` icon next to any custom prompt to see a prompt menu.

Expand All @@ -31,15 +31,15 @@ Click on the`⋮` icon next to any custom prompt to see a prompt menu.

From here you can edit the prompt (redirects to the playground with the selected prompt opened), rename or delete the prompt.

## Context data (formerly AI customization)
## AI Context Data (formerly AI customization)

:::info
This feature is only available with a Business subscription or higher on Tolgee cloud and Subscribed Self-hosted
instances with [AI translator](/platform/translation_process/ai_translator) enabled as the translation provider.
:::

If you wish to enhance the results from the [AI translator](/platform/translation_process/ai_translator),
you can customize it according to your needs. Tolgee enables you to input key descriptions,
you can customize AI translation according to your needs. Tolgee enables you to input key descriptions,
project descriptions, or language notes. This information is provided along with the actual string
that requires translation. It helps to understand the context of your translation project and provide
more accurate translations.
Expand Down
6 changes: 3 additions & 3 deletions platform/projects_and_organizations/content_delivery.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: content_delivery
title: Content Delivery
sidebar_label: Content Delivery
title: Content Delivery (Deploy Files to Cloud)
sidebar_label: Content Delivery to Cloud
description: Content Delivery will deploy your localization files to reliable and fast cloud storage so you can confidently use them in your application.
image: /img/og-images/platform.png
---
Expand Down Expand Up @@ -71,7 +71,7 @@ Content delivery is made to be rapidly available all around the world, so we pri

> Read more about [providing Tolgee SDK with static data](/js-sdk/providing-static-data).

## Manual publishing
## Manual publishing of Localization Files

If you opted out of automatic publishing, you can do so manually in the list of content deliveries by `Publish` button.

Expand Down
16 changes: 8 additions & 8 deletions platform/projects_and_organizations/editing_translations.mdx
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
id: editing_translations
title: Editing translations
sidebar_label: Editing translations
title: How to Edit Translations in Tolgee
sidebar_label: How to Edit Translations
image: /img/og-images/platform.png
---

For editing translation strings, Tolgee provides an editor, which helps translators translate strings in a
convenient way.

## The translations view
## How to Edit Translation Strings: The Translations View
The translations view enables you to access translation keys, the translation text in the target languages. It allows you to
add comments or see the history. When translating, you can also get the results from [machine translation](../translation_process/machine_translation.mdx) providers and
[translation memory](../translation_process/translation_memory.mdx).
Expand All @@ -19,8 +19,8 @@ import { ScreenshotWrapper } from "../shared/_ScreenshotWrapper";
alt="Translations View" />

## Editing the translation
You can enter translation editing mode by clicking on the translation text. This will open the translation editor.
When editing translation, translation memory, machine translation, comments and history are displayed in the right panel.
You can edit translations by entering editing mode by clicking on the translation text. This will open the translation editor.
When using the localization editor, translation memory, automatic translation (machine translation and AI translation), comments and history are displayed in the right panel.

### Editing translation with placeholders
When translation text contains placeholders, their code is hidden by default. So you don't have to understand the actual
Expand All @@ -37,16 +37,16 @@ To add a new placeholder, you can just type the placeholder syntax into the tran
will be automatically visualized. Read more about [Tolgee Universal ICU placeholders here](/platform/translation_process/tolgee_universal_icu_placeholders)
to know about all the supported placeholder types and syntax.

### Editing placeholders as a code
Sometimes, you might want to edit the whole message as a code with placeholders and HTML tags. You can do that by switching
### Code Mode vs Visual Mode
Sometimes, you might want to edit the whole message as a code with placeholders and HTML tags instead of using translation editor. You can do that by switching
the editor to the code mode in top right of the current language translation editor above the translation input.

<ScreenshotWrapper src="/img/docs/platform/editing_translations/code_mode.webp"
alt="Switching to code mode" />

This way, you can switch between the code and visual mode to edit the translation.

## Editing plurals
## Managing and Using Plural Translations
When editing plural translations, each plural form is displayed in a separate input.

<ScreenshotWrapper src="/img/docs/platform/editing_translations/editing_plurals.webp"
Expand Down
20 changes: 10 additions & 10 deletions platform/projects_and_organizations/export.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: export
title: Export
sidebar_label: Export
title: Export Translation Files
sidebar_label: Export Translation Files
description: Translations can be exported from Tolgee. You can currently export translations in two formats (JSON and XLIFF)
image: /img/og-images/platform.png
---
Expand All @@ -10,35 +10,35 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper';

Translations can be exported from Tolgee. You can currently export translations in [many different formats](/platform/supported_formats), and you can also export only specific translations, e.g., only the ones that are not translated yet.

## Exporting from Tolgee
## Export Translations from Tolgee Dashboard

To export translations from Tolgee, select project, and then choose the "Export" item from the sidebar.

![img](/img/docs/platform/project_menu_export.webp)

Then you can choose the following options:

- **States** which translations should be exported. You can choose multiple states.
- **Languages** which languages should be exported (all languages are exported by default).
- **Format** select the format of the exported file. Currently, we support only JSON and XLIFF formats.
- **Namespaces** which namespaces should be exported (all namespaces are exported by default). Learn more about namespaces in [this article](/platform/translation_keys/namespaces).
- **Nested structure** whether the exported file should be structured as nested objects or not (based on the "." separator in key names). This option is available **only for JSON format**.
- **States** - which translations should be exported. You can choose multiple states.
- **Languages** - which languages should be exported (all languages are exported by default).
- **Format** - select the format of the exported file. Currently, we support only JSON and XLIFF formats.
- **Namespaces** - which namespaces should be exported (all namespaces are exported by default). Learn more about namespaces in [this article](/platform/translation_keys/namespaces).
- **Nested structure** - whether the exported file should be structured as nested objects or not (based on the "." separator in key names). This option is available **only for JSON format**.

When you are done, click the `Export` button and the file will be downloaded.

<ScreenshotWrapper src="/img/docs/platform/export.webp" alt="Export options" />

> If you want to specify exactly which keys need to be exported, you can go to [Batch operations](../translation_keys/batch_operations.mdx) and export from there.

## Exporting via CLI
## Export Translations via CLI

You can also export translations via [Tolgee CLI](/tolgee-cli). To do so, you need to have the Tolgee CLI installed. You can find the installation instructions [here](/tolgee-cli/installation).

Then you can use the [`tolgee pull`](/tolgee-cli/push-pull-strings#pulling-strings) command to export translations.

The command exports strings from the platform, and saves them in a folder of your choice. You can use this to download strings from Tolgee before bundling your app for production.

## Exporting via API
## Export Translations via REST API

You can also export translations via REST API, e.g., via the `curl` utility:

Expand Down
14 changes: 8 additions & 6 deletions platform/projects_and_organizations/import.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
---
id: import
title: Import
sidebar_label: Import
image: /img/og-images/platform.png
title: Import Translation Files
sidebar_label: Import Translation Files
image: /img/og-images/platform.png
---

Tolgee supports importing existing translations from various formats. You can import translations from JSON, XLIFF, and PO files.
Tolgee supports importing existing translations from various formats. Here is the list of [Tolgee supported formats](/platform/supported_formats).

You can import translations from JSON, XLIFF, PHP, C/C++, Python, Apple Strings, Apple Stringsdict, Apple Strings Catalog, Apple XLIFF, Android XML, Compose Multiplatform XML, Flutter ARB, Ruby YAML, i18next, CSV, .NET RESX, and XLSX files.

import { ScreenshotWrapper } from "../shared/_ScreenshotWrapper";

## Importing to Tolgee
## Importing Translation Files to Tolgee

To import translations to Tolgee, you need to have a project created. You can create a project in the [Projects](/platform/getting_started/creating_project) section.
After creating a project, you can import translations to it by navigating to the "Import" page.
Expand All @@ -26,7 +28,7 @@ When you are done, click the `Import` button and the file will be imported into

<ScreenshotWrapper src="/img/docs/platform/import/import_file.webp" alt="Import file" />

### Resolving conflicts
### Resolving conflicts during import

When you import a file, Tolgee will check if the imported strings already exist in the project. If there are some **conflicts** in the strings, you will be prompted to **resolve them**.

Expand Down
Loading