diff --git a/platform/glossaries/glossary_terms.mdx b/platform/glossaries/glossary_terms.mdx index 7003e21c..e9c11ce7 100644 --- a/platform/glossaries/glossary_terms.mdx +++ b/platform/glossaries/glossary_terms.mdx @@ -9,11 +9,11 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper'; # Glossary Terms Actions -This page explains how to create, edit, translate, delete, and bulk-manage glossary terms. +This page explains how you can edit, translate, and delete glossary terms in the Tolgee UI, including how to manage multiple terms at once. -## Edit Glossary Terms +## Edit Glossary Term -Changing the term in the base language, its description or tags, can be done in the [glossaries tab](/platform/glossaries/managing_glossaries#access-organization-glossaries) by clicking on the term. +You can edit a glossary term when you need to update its base language value, description, or tags. You do this from the [Glossaries tab](/platform/glossaries/managing_glossaries#access-organization-glossaries) by opening the term details. 1. Open the details of the term by clicking on the first column 2. Update the term details @@ -24,14 +24,18 @@ Changing the term in the base language, its description or tags, can be done in alt="Edit term dialog" /> -## Translate Glossary Terms +## Translate Glossary Term Translating glossary terms ensures they are correctly localized when using both human and machine translation. +Glossary languages are based on assigned projects. If you don't select any project, all organization languages will be included. + +To translate glossary terms: + 1. Add the desired language to the list of languages in the top right corner next to the `+ Term` button 2. Click on the translation cell for the desired language 3. Enter the translation for the term -4. Click Save +4. Click `Save` This will not work if the base language term has a "Non-translatable" tag as it will stay the same in all languages. @@ -40,7 +44,7 @@ This will not work if the base language term has a "Non-translatable" tag as it alt="Translate term editor" /> -## Delete Glossary Terms +## Delete Glossary Term and Bulk Delete If the term is not needed or was added by mistake, it can be deleted by following these steps: @@ -48,7 +52,7 @@ If the term is not needed or was added by mistake, it can be deleted by followin 2. Click `Delete` 3. Confirm the deletion -Also, it is possible to bulk select and delete multiple terms at once. +You can also delete multiple glossary terms at once using bulk selection. 1. Click on the checkboxes of the desired terms 2. Select the action at the bottom of the screen diff --git a/platform/glossaries/importing_and_exporting_glossaries.mdx b/platform/glossaries/importing_and_exporting_glossaries.mdx index f57af7cd..22f7aaed 100644 --- a/platform/glossaries/importing_and_exporting_glossaries.mdx +++ b/platform/glossaries/importing_and_exporting_glossaries.mdx @@ -12,58 +12,53 @@ import { ScreenshotWrapper } from '../shared/_ScreenshotWrapper'; Importing and exporting glossary terms helps you manage terminology at scale and keep your projects consistent. This page explains how to upload terms from a CSV file or download an existing glossary for external use. Basic glossary term actions, such as editing and deleting terms, are documented on the [Glossary Terms Actions](/platform/glossaries/glossary_terms) page. -## Import Terms to a Glossary +## Import Glossary Terms from a CSV File -If you already have a CSV file containing terms you want to add to your glossary, you can import them by following these steps: +Uploading glossary terms helps speed up your work if you already have a term base or are migrating from a different platform. -1. After creating a new glossary, click the `Import glossary` button +If you already have a CSV file in the [proper format](/platform/glossaries/importing_and_exporting_glossaries#format-of-the-csv-file) containing terms you want to add to your glossary, you can import them by following these steps: + +1. After creating a new glossary, click `Import a glossary` in the right column or select the second icon to the left of the “+ Term” button. 2. Select a CSV file in the recommended format -3. Choose an option for how you want to import your terms to the glossary: +3. Choose an option for how you want to import your terms to the glossary (usually applicable to an existing glossary): - Replace glossary - Add to glossary 4. Click `Import` -## Import Terms to an Empty Glossary - -To import terms from a CSV file into an empty glossary, create a new glossary and open it. Then click “Import a glossary” in the right column or select the second icon to the left of the “+ Term” button. - -Afterward, upload or drag and drop a CSV file, then click “Import.” -## Import Terms to an Existing Glossary - -To import terms into an existing glossary, first open the glossary you would like to import terms into. Then click the second icon to the left of the “+ Term” button. +To import terms into an **existing glossary**, open the glossary you would like to import terms into. -Afterwards, follow the steps to [Add to Glossary](/platform/glossaries/importing_and_exporting_glossaries#import-with-an-option-add-to-glossary) or to [Replace a Glossary](/platform/glossaries/importing_and_exporting_glossaries#import-with-an-option-to-replace-a-glossary). +Then, click the second icon to the left of the “+ Term” button. -## Options While Importing to an Existing Glossary +When importing into an existing glossary, you have two options: adding new terms or replacing the entire glossary with the imported terms. The differences between these options are explained below. -When importing to an existing glossary you have two options on how to add the terms. Here are the differences: +### Import Terms by Adding Them to a Glossary -### Import With an Option to Replace a Glossary +After selecting a file to import, choose the “Add to Glossary” import mode if you want to add new terms from your CSV file to the glossary. This option is useful when you have new terms to add in bulk. -After selecting a file to import, choose "Replace glossary" import mode if you want to delete all existing terms and import new ones from the CSV file. It is useful if you have a CSV file as your source of truth. +Do not use it with CSV files containing terms that already exist in the glossary, as this may create duplicates. Because a glossary can contain identical terms with different meanings, existing terms are not replaced. -### Import with an Option Add to Glossary +### Import Terms by Replacing a Glossary -After selecting a file to import, choose the “Add to Glossary” import mode if you want to add new terms from your CSV file to the glossary. This option is useful when you have new terms to add in bulk. Do not use it with CSV files containing terms that already exist in the glossary, as this may create duplicates. Because a glossary can contain identical terms with different meanings, existing terms are not replaced. +After selecting a file to import, choose "Replace glossary" import mode if you want to delete all existing terms and import new ones from the CSV file. It is useful if you have a CSV file as your source of truth. ## Format of the CSV File @@ -85,6 +80,8 @@ Ensure that the CSV file meets the recommended format. Copy the structure of the ## Export Terms from a Glossary +Exporting terms is useful when you want to use them elsewhere or edit them externally before reuploading them to Tolgee. + To export all terms, open the glossary and click the first icon to the left of the “+ Term” button. 1. If you need to download the glossary as a CSV file, click the `Export glossary` icon diff --git a/platform/glossaries/managing_glossaries.mdx b/platform/glossaries/managing_glossaries.mdx index e5250d01..91ee65ab 100644 --- a/platform/glossaries/managing_glossaries.mdx +++ b/platform/glossaries/managing_glossaries.mdx @@ -18,11 +18,12 @@ You can create glossaries at the organization level and assign them to projects. /> Glossaries can be called differently in other Translation Management Systems (TMS) or localization workflows. + To clarify, we use the term "Glossary" as it best describes the features we provide. The base functionality of a Glossary on Tolgee is a list of key terms and their preferred translations with some additional tags for special cases like abbreviations and foribdden terms. Other names for similar features include: termbase (or Term Base / TB), which can also contain data like usage and status, and terminology database / terminology management system / terminology repository / terminology list, which is a more generic term that often includes not only translations but also guidelines for how certain words should be used within an organization. -## Managing Glossaries (termbase) +## Get Started with Glossaries (Termbase) This section describes how to work with glossaries and the terms in them. Translation glossary helps with terminology management by keeping it consistent and standardized. This provides brand consistency by keeping track of non-translatable terms, case-sensitive terms, abbreviations and so on. @@ -44,7 +45,7 @@ The user can add a glossary and edit it if the access is set to at least a maint ## Create a New Glossary -To create a new glossary in your organization and add it to a project, follow the steps below: +Creating a glossary lets you add terms to ensure consistent translations across one or multiple projects. To create a new glossary in your organization and add it to a project, follow the steps below: 1. Click the `+ Glossary` button to open the dialog window to create the glossary 2. Enter a name for the glossary @@ -60,7 +61,7 @@ The base language and the glossary languages are derived from the projects that alt="Create glossary dialog" /> -## Add Terms to Your Glossary +## Add Terms to a Glossary You can [import terms](/platform/glossaries/importing_and_exporting_glossaries) or add them manually: diff --git a/platform/glossaries/using_glossaries_in_translations_view.mdx b/platform/glossaries/using_glossaries_in_translations_view.mdx index cbc4ef2e..76a1a903 100644 --- a/platform/glossaries/using_glossaries_in_translations_view.mdx +++ b/platform/glossaries/using_glossaries_in_translations_view.mdx @@ -15,17 +15,15 @@ When working in bigger teams, this feature helps ensure consistency in translati Glossaries also support translators by clarifying the meaning, context, and preferred usage of terms, reducing ambiguity and errors. A glossary is often defined by a topic expert or localization manager. It serves as a reference for all translations in the project. This tool strengthens quality control and speeds up the translation process by minimizing repetitive decision-making. -When you translate a string that contains glossary terms, these terms are highlighted, and their definitions are displayed in the glossary panel while editing translations. - ## How to Set Up Glossaries Before using glossaries and their features in the translation view, make sure you have set them up properly by referring to [Manage Glossaries](/platform/glossaries/managing_glossaries) page. ## Highlight Glossary Terms -When you click on the translation field of a key that contains glossary terms, these terms are highlighted in the base text. +When you click on the translation field of a key that contains glossary terms, these terms are highlighted in the base text, and their definitions are displayed in the glossary panel while editing translations. Hovering over highlights will display a tooltip containing the term, its suggested translation, description and tags. -Hovering over highlights will display a tooltip containing the term, its suggested translation, description and tags. +It helps not to miss any terms that are in your glossary during translation, see their tags and descriptions. -## Using Glossary Terms +## Tips for Using Glossary Terms + +In addition to seeing the suggested translation for a glossary term, it's important to consider its description and tags to ensure accurate proper localization without mistakes. When translating content with glossary terms: -1. Check the glossary panel to see the terms and their descriptions +1. Check the [glossary panel](/platform/glossaries/using_glossaries_in_translations_view#glossary-panel) to see the terms and their descriptions 2. Pay attention to the flags: - Non-translatable: Do not translate these terms - Case-sensitive: Maintain the same case in your translation