Skip to main content

Glossaries Overview

Glossaries in Scriptix are collections of term pairs used for translation between source and target languages.

What Are Glossaries?​

Glossaries are custom vocabulary lists containing term pairs:

Structure:

  • Source language
  • Target language
  • Term pairs (source term → target term)
  • CSV format entries

Properties:

  • Name (max 100 characters)
  • Description (optional)
  • Source language code
  • Target language code
  • Entry count
  • Active status (true/false)
  • DeepL glossary ID
  • Google glossary ID
  • Organization ID
  • Created and modified dates

How Glossaries Work​

Glossaries define term mappings between languages:

Translation Pairs:

  • Source term in source language
  • Target term in target language
  • Used for translation services
  • Integrated with DeepL and Google

Services:

  • DeepL translation service
  • Google translation service
  • Service selected based on language pair availability
  • DeepL prioritized when available

Creating Glossaries​

Basic Process​

  1. Navigate to Glossaries page
  2. Click "Create Glossary" button
  3. Enter name and description
  4. Select source language
  5. Select target language
  6. Upload CSV file OR enter CSV manually
  7. Create glossary

CSV Format​

source_term,target_term
PostgreSQL,PostgreSQL
database,base de données
server,serveur

Requirements:

  • Two columns: source_term, target_term
  • Comma-separated values
  • At least one term pair
  • UTF-8 encoding

Managing Glossaries​

View Glossaries​

Glossaries List:

  • All glossaries in data grid
  • Name, language pair, entry count, status, created date
  • Clickable name to view details

Edit Glossaries​

Editable Properties:

  • Name (max 100 characters)
  • Description
  • Active status

Non-Editable:

  • Source language
  • Target language
  • Term entries (must delete and recreate)

Download Glossaries​

Download CSV:

  • Click download action
  • Downloads all term pairs as CSV
  • File format: [name]_glossary.csv
  • Contains source_term, target_term columns

Delete Glossaries​

Delete Process:

  • Click delete action
  • Confirmation modal with details
  • Permanent deletion
  • Cannot be undone

Glossary Details​

Details Page​

Click glossary name to view:

  • Glossary metadata
  • Language pair
  • Entry count
  • Active status
  • All term entries in data grid

Entries Grid:

  • ID, Source Term, Target Term
  • No editing capability
  • Shows all entries

Language Support​

Supported Language Pairs​

Language pairs from two services:

DeepL Service:

  • Language pairs available via DeepL
  • Prioritized when creating glossaries

Google Service:

  • Language pairs available via Google
  • Used when DeepL not available

Language Pair Properties:

  • Source language code
  • Target language code
  • Source language name
  • Target language name
  • Service (deepl or google)

Service Selection​

When creating glossary:

  1. Select source language
  2. System checks available services for that language
  3. DeepL prioritized if available
  4. Target languages filtered by selected service
  5. Ensures consistency within glossary

Active Status​

Active Glossaries​

Active (is_active: true):

  • Glossary enabled
  • Available for use

Inactive (is_active: false):

  • Glossary disabled
  • Preserved but not active
  • Can be reactivated

Managing Status​

Toggle Status:

  • Edit glossary
  • Check/uncheck active checkbox
  • Save changes

Use Cases for Inactive:

  • Temporary disable
  • Keep as backup
  • Archive old versions
  • Testing new versions

Access Control​

Who Can Access:

  • ORGADMIN role users
  • CONTRIBUTOR role users

Available Actions:

  • Create glossaries
  • View glossaries
  • Edit glossaries (name, description, status)
  • Download glossaries
  • Delete glossaries

Data Grid Features​

Glossaries List​

Sorting:

  • Manual sorting
  • Server-side

Filtering:

  • Manual filtering
  • Server-side

Pagination:

  • Manual pagination
  • Server-side
  • Default: 25 per page

Glossary Actions​

Edit (Pencil Icon):

  • Opens edit modal
  • Update name, description, status

Download (Download Icon):

  • Downloads CSV
  • All term pairs

Delete (Trash Icon):

  • Opens confirmation
  • Permanent deletion

Integration​

External Services​

DeepL Integration:

  • DeepL glossary ID stored
  • Uses DeepL translation API
  • Language pairs from DeepL

Google Integration:

  • Google glossary ID stored
  • Uses Google translation API
  • Language pairs from Google

API Endpoints​

Glossaries API:

  • GET /api/v3/glossaries - List glossaries
  • POST /api/v3/glossaries - Create glossary
  • GET /api/v3/glossaries/:id - Get glossary
  • PATCH /api/v3/glossaries/:id - Update glossary
  • DELETE /api/v3/glossaries/:id - Delete glossary
  • GET /api/v3/glossaries/:id/entries - Get entries CSV
  • GET /api/v3/glossaries/supported_languages - Supported pairs

Glossary Limitations​

What You Cannot Edit​

After creating glossary:

  • Source language (fixed)
  • Target language (fixed)
  • Term entries (must recreate)

Why:

  • Tied to external service IDs
  • DeepL/Google glossary integration
  • Prevents sync issues

Updating Terms​

To update term entries:

  1. Download current glossary
  2. Edit CSV externally
  3. Delete old glossary
  4. Create new glossary with updated CSV

Next Steps​

  • Create glossary with term pairs
  • Download glossaries for backup
  • Manage active status
  • View glossary details

Manage translation terms! Create glossaries with term pairs for translation services.

Note: Glossary features and availability may vary based on your subscription plan. Contact your organization administrator for details about glossary access and capabilities.

Next Steps​