Skip to content
Open
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
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.
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.
Binary file not shown.
Binary file not shown.
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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is too aggressive screenshots deletion now :)

For example, this screenshot shows the location of an option in a dropdown menu (highlighted). This type of screenshot should probably be allowed because it's more than just a visual capture of a screen, it points to something.

First, let's agree on a policy for screenshots.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it might look like one, because we had a vast number of screenshots that duplicated what the text already clearly explained.

Regarding this particular one, I deleted it because the step right next to it already says to click the particular icon and lists the options (Upload / Download / Download filtered), so it felt like a repeat.
But sure, if you want to keep this kind of screenshot, I'll bring it back.

In general, I only deleted screenshots that just repeated the text (e.g., buttons, simple dialogs, plain tables) and kept the ones that show something text can't (the new concept dialog, the Editor states, the import column mapping). Where I dropped a "where is it" screenshot, I covered the location in the step text.

I've drafted a screenshot policy based on industry best practices. Still polishing it, will add it to CONTRIBUTING.md so we have it there. Let's agree on that, then I'll recheck the deletions against it.

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.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
110 changes: 60 additions & 50 deletions src/content/docs/crowdin/localization-resources/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,14 @@ description: Learn how to create, manage, and share glossaries in Crowdin
slug: glossary
---

import { Steps, Aside, LinkCard, CardGrid } from '@astrojs/starlight/components';
import { Steps, Aside, LinkCard, CardGrid, Badge } from '@astrojs/starlight/components';
import { Icon } from 'astro-icon/components';
import KBD from '~/components/KBD.astro';
import { Image } from 'astro:assets';
import termHover from '!/crowdin/localization-resources/glossary_term_hover.png';
import createGlossary from '!/crowdin/localization-resources/glossary_create_glossary.png';
import createGlossaryDialog from '!/crowdin/localization-resources/glossary_create_glossary_dialog.png';
import addConcept from '!/crowdin/localization-resources/glossary_add_concept.png';
import addConceptDialog from '!/crowdin/localization-resources/glossary_add_concept_dialog.png';
import addConceptEditor from '!/crowdin/localization-resources/glossary_add_concept_editor.png';
import conceptsView from '!/crowdin/localization-resources/glossary_concepts_view.png';
import termsView from '!/crowdin/localization-resources/glossary_terms_view.png';
import editConcept from '!/crowdin/localization-resources/glossary_edit_concept.png';
import deleteAllConcepts from '!/crowdin/localization-resources/glossary_delete_all_concepts.png';
import downloadUpload from '!/crowdin/localization-resources/glossary_upload_download.png';
import configureImport from '!/crowdin/localization-resources/glossary_configure_import.png';
import shareGlossaries from '!/crowdin/localization-resources/glossary_share_glossaries.png';

With a glossary, you can create, store, and manage all the project terminology in one place. The main aim of terminology is to explain some specific terms or the ones often used in the project to be translated properly and consistently.

Expand All @@ -36,10 +27,10 @@ To create a glossary, follow these steps:

<Steps>
1. Open your profile home page and select **Glossaries** on the left sidebar.
2. Click **Create Glossary**. <Image src={createGlossary} alt="Create glossary" />
2. At the top right, click **Create Glossary**.
3. In the appeared dialog, name your glossary and select a default language that will be displayed first in the table of glossary records.
4. *(Optional)* Assign the glossary to the needed projects. You can skip this step and assign a glossary later.
5. Click **Create**. <Image src={createGlossaryDialog} alt="Create glossary dialog" class="width-lg" />
5. Click **Create**.
</Steps>

<CardGrid>
Expand Down Expand Up @@ -80,25 +71,42 @@ Term details:
* Type &ndash; Classifies the term's function (e.g., full form, acronym, abbreviation, phrase, variant).
* Status &ndash; Defines the term's approval level (e.g., preferred, admitted, not recommended).
* Gender &ndash; The grammatical gender of the term (e.g., masculine, feminine, neuter).
* Description &ndash; A brief explanation or context for the specific term (distinct from the concept's definition).
* Description (context) &ndash; A brief explanation or context for the specific term (distinct from the concept's definition).
* Note &ndash; Short notes about a term that might be helpful to translators.
* URL &ndash; URL to the web page with relevant information about a term.

The concept dialog opens as a full-screen view with two panes:

* The left pane contains concept-level details: the **Primary term** (filled in automatically from the source-language term), **Subject**, **Definition**, and the **Translatable** toggle. The expandable **Concept details** section holds the concept **Note**, **URL**, and **Figure**.
* The right pane lists all terms across languages, grouped by language. The source language is pinned at the top and marked with a <Badge text="SOURCE" variant="success" /> badge. Each term row shows its **Part of speech**, **Gender**, **Type**, and **Status**, along with the **desc**, **url**, and **note** badges that expand the term's **Description (context)**, **URL**, and **Note** fields.

To add a new glossary concept, follow these steps:

<Steps>
1. Open your profile home page and select **Glossaries** on the left sidebar. Alternatively, open your project and go to **Settings > Glossaries**.
2. Click **View Records** on the needed glossary.
3. Click **Add concept**. <Image src={addConcept} alt="Add Concept" />
4. In the appeared dialog, select the language from the drop-down menu, and specify the term and all related details. Click <Icon name="mdi:auto-fix" class="inline-icon"/> to detect the part of speech automatically.
3. Click **Add term**.
4. In the source-language row, enter the term and set its **Part of speech**, **Gender**, **Type**, and **Status**. Hover over the row and click <Icon name="mdi:auto-fix" class="inline-icon"/> to detect the part of speech automatically.
<Aside>
Part of speech can be automatically detected only for the following languages: English, French, Spanish, German, Norwegian, Polish, Swedish, Russian, Italian, and Chinese.
</Aside>
5. *(Optional)* Click **Add term** to add a term variation (e.g., acronym, short form, etc.)
6. Specify the concept details.
7. Click **Create**. <Image src={addConceptDialog} alt="Add Concept Dialog" class="crowdin-modal"/>
5. *(Optional)* Click **Add term** below the language to add a term variation (e.g., acronym, short form, etc.)
6. *(Optional)* Click **Add language** and search for a language to add its translation.
7. Specify the concept details in the left pane (**Subject**, **Definition**, and the **Concept details** section).
8. Click **Create**. <Image src={addConceptDialog} alt="Add Term as New Concept dialog" />
</Steps>

<Aside title="Adding a new concept vs. a new term">
Use **Add term** to define a new meaning from scratch. To add a synonym or translation to an existing entry, search for the concept first and add the term there.
</Aside>

<Aside type="tip">
A few things that speed up working with concepts:
* Click the **desc**, **url**, or **note** badge in a term row to expand it and jump straight to that field.
* Click the link icon (**Open URL**) next to the **URL** field to open the link in a new browser tab.
* Turn off the **Translatable** toggle to collapse a concept to its source language only; turning it back on restores the previously added languages.
</Aside>

To add glossary concepts via the Editor, follow these steps:

<Steps>
Expand All @@ -120,13 +128,11 @@ Alternatively, you can grant full access, allowing them to manage all glossary t

### Viewing, Searching, and Filtering Glossary Concepts and Terms

Once you open a glossary, you can view and filter its glossary concepts and terms using either the **Concepts** or **Terms** tabs.
Once you open a glossary, you can switch between two views using the **Group by concept** toggle.

On the **Concepts** tab, you can view glossary content grouped as concepts (one concept per row, each term displayed in a separate language column).
With **Group by concept** enabled, glossary content is grouped as concepts (one concept per row), with each term's translations shown in separate language columns. Under each term, its part of speech, status, gender, and type appear as badges.

<Image src={conceptsView} alt="Concepts View" />

On the **Terms** tab, you can view glossary content as individual terms (one term per row) with the following details:
With **Group by concept** disabled, glossary content is shown as individual terms (one term per row) with the following details:

* **Term**: Contains either source or target language text.
* **Language**: The term's language (e.g., French, Spanish).
Expand All @@ -139,42 +145,37 @@ On the **Terms** tab, you can view glossary content as individual terms (one ter
* **Concept subject**: The subject field from the parent concept.
* **Concept definition**: The definition from the parent concept.

<Image src={termsView} alt="Terms View" />

By default, all glossary concepts and terms are displayed. To find a specific concept or term, you can use the **Search** field.
By default, all glossary concepts and terms are displayed. To find a specific concept or term, type in the **Search** field. In both views, the search matches against the following fields:

In the **Concepts** tab, you can search by the following details:

* **Terms**
* **Concept definitions**
* **Concept subjects**
* **Term text**
* **Term description (context)**
* **Concept definition**
* **Concept subject**

To refine the search results, you can use the following options:

* **Match case**
* **Match whole phrase**
* **Exact match**

To filter the list of concepts or terms, click **Filter** <Icon name="mdi:filter-variant" class="inline-icon" /> and use the available options:
To filter the list of concepts or terms, click **Filters** <Icon name="mdi:filter-variant" class="inline-icon" /> and use the available options:

* **Languages** (Specific to the **Terms** tab): Filter by **All languages** or a **Specific language**.
* **Modified**: Filter by modification date (**All**, **Custom Range**).
* **Languages** (available when **Group by concept** is disabled): Filter by **All languages** or a **Specific language**.
* **Last modified**: Filter by modification date (**All**, **Custom Range**).
* **Part of speech**: Filter by grammatical category (**All**, **Noun**, **Verb**, etc.).
* **Type**: Filter by classification (**All**, **Full form**, **Acronym**, etc.).
* **Status**: Filter by approval status (**All**, **Preferred**, **Draft**, etc.).
* **Gender**: Filter by grammatical gender (**All**, **Masculine**, **Feminine**, etc.).
* **Author**: Filter by **All** or a particular user.

To sort concepts or terms, click **Sort by** and select one of the available options:

* **Text**
* **Last modified**
* **Created**
To sort concepts or terms, click a column header. By default, the list is sorted by the source-language terms. You can also sort by the **Created** or **Last modified** column. Click a column header once to sort in ascending order and click again to sort in descending order.

To customize your viewing experience, you can use the following options on the top toolbar:

* **Word Wrap**: Click <Icon name="mdi:wrap" class="inline-icon" /> to toggle the word wrap feature. This is useful for viewing long texts (such as definitions, subjects, or notes) without expanding the column width.
* **Column Settings**: Click <Icon name="mdi:view-column" class="inline-icon" /> to configure which columns are displayed in the table. You can show or hide columns like *Definition*, *Subject*, *Translatable*, and *Note*, as well as the language columns.
* **Column Settings**: Click <Icon name="mdi:view-column" class="inline-icon" /> to configure which columns are displayed in the table. Use **All Columns** to show or hide all of them at once.
* **Concepts** view: You can show or hide columns such as *Definition*, *Subject*, *Translatable*, *Note*, *Created*, and *Last modified*, as well as the language columns. All columns and languages are shown by default, except *Translatable* and *Note*.
* **Terms** view: You can show or hide columns like *Language*, *Part of speech*, *Type*, *Status*, *Gender*, *Description (context)*, *Note*, *Concept subject*, and *Concept definition*.

### Editing Glossary Concepts and Terms

Expand All @@ -185,20 +186,29 @@ To edit a glossary concept, follow these steps:
<Steps>
1. Open your profile home page and select **Glossaries** on the left sidebar. Alternatively, open your project and go to **Settings > Glossaries**.
2. Click **View Records** on the needed glossary.
3. Open a glossary concept with a double-click or click **Edit**.
4. In the appeared dialog, make the necessary edits to the concept or terms and click **Save**. <Image src={editConcept} alt="Edit Glossary Concept" />
3. Open a glossary concept with a double-click, or click <Icon name="mdi:dots-horizontal" class="inline-icon" /> on its row and select **Edit**.
4. In the **Edit concept** dialog, make the necessary edits to the concept or its terms. The dialog uses the same two-pane layout described in [Creating Glossary Concepts and Terms](#creating-glossary-concepts-and-terms), with an added **Metadata** section that lists the concept **ID**, creation date, and last modification details.
5. Click **Save**.
</Steps>

### Deleting Glossary Concepts
<Aside>
If you close the dialog with unsaved changes, you'll be asked to confirm: select **Discard** to close without saving or **Cancel** to keep editing.
</Aside>

### Deleting Glossary Concepts and Terms

You can delete a single term, an entire concept, or several concepts at once.

When [editing a concept](#editing-glossary-concepts-and-terms), you can delete individual terms or the entire concept directly in the dialog:

You can delete one, multiple, or all the glossary concepts at once.
* Delete a single term &ndash; expand the term's row and click **Delete term**.
* Delete the entire concept &ndash; click **Delete concept** in the bottom-left corner of the dialog.

To delete all the concepts from the glossary, follow these steps:
To delete several concepts at once, follow these steps:

<Steps>
1. Select the top checkbox above the concept list.
2. Confirm the selection of all concepts.
3. Click <Icon name="mdi:delete" class="inline-icon"/>. <Image src={deleteAllConcepts} alt="Deleting Glossary Concepts" />
1. Select the checkboxes next to the concepts you want to delete. To delete all concepts, select the top checkbox and confirm the selection of all concepts.
2. Click <Icon name="mdi:delete" class="inline-icon"/>.
</Steps>

## Managing Glossaries
Expand All @@ -224,7 +234,7 @@ To upload or download the glossary, follow these steps:
3. Click <Icon name="mdi:swap-vertical" class="inline-icon" /> and select one of the following options:
* **Upload** – uploads new glossary content.
* **Download** – downloads the full glossary.
* **Download filtered** – downloads only glossary concepts that match the applied filters or search criteria. <Image src={downloadUpload} alt="Downloading and Uploading Glossary" />
* **Download filtered** – downloads only glossary concepts that match the applied filters or search criteria.
</Steps>

The project owner and managers can upload and download the glossary in the following file formats: TBX (v2), TBX (v3), CSV, XLSX.
Expand Down Expand Up @@ -295,7 +305,7 @@ To share your glossaries between all of the projects you own, follow these steps

<Steps>
1. Open your profile home page and select **Glossaries** on the left sidebar.
2. Select **Share Glossaries**. <Image src={shareGlossaries} alt="Sharing Glossaries" />
2. At the top left of the **Glossaries** page, select the **Share Glossaries** checkbox.
</Steps>

<Aside>
Expand Down
Loading
Loading