Skip to content

About

Supertext AI translation for Payload CMS 3: a Translate button for localized collections and globals.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Payload Supertext Translation

AI translation for Payload CMS 3 by Supertext. Adds a Translate button to your localized collections and globals: pick target languages, and the plugin sends the document's localized fields to Supertext and saves the translations into those locales — as drafts for review when drafts are enabled.

import { supertextTranslation } from 'payload-supertext-translation'

plugins: [supertextTranslation({ collections: ['pages', 'posts'], globals: ['header'] })]

Translates localized text, textarea and Lexical richText fields, including inside groups, tabs, arrays and blocks. Formatting and links in rich text are preserved.

Translation files: Export for translation downloads a document as XLIFF 1.2 (for translation tools) or HTML; Import translation writes the translated file back, with a summary of what was imported.

Live demo: https://payload-production-cfd2.up.railway.app (admin at /admin, credentials from the Supertext team)

Requirements: a Supertext account (create one or log in) and an API key from supertext.com → Integrations → API (requires the Admin role), set as SUPERTEXT_API_KEY. Each Payload locale's Supertext language is chosen in the admin under Supertext → Supertext settings (one combo box per locale, preselected: de → de-DE, en → en-US, de-CH stays de-CH); the languageMap option can override it for automated setups.

The plugin checks the API key automatically and, unless you turn it off (versionReports: false or SUPERTEXT_VERSION_REPORTS=0), sends version information to Supertext: the site URL and the plugin, Payload, Node.js and SDK versions — no content, no API key, no personal data. See the Installation guide.

Export for translation and import (XLIFF and HTML)

Besides translating with Supertext AI, you can export a document as a file, have it translated elsewhere and import the result.

  • Where: the Export for translation and Import translation tabs of the Translate dialog in the document header.
  • Formats: XLIFF 1.2 for translation tools such as Trados, memoQ or Phrase (formatting travels as protected tags; several target languages in one file), or HTML (one language per file) for translators or Supertext's web app, which keeps the file's head and data-st-id attributes, so the translated file imports as it is.
  • Import: the file says what it was exported from and for which language. The translations are written with the same rules as a Supertext AI translation, and a summary shows what was imported and what was skipped: source changed since the export (import those anyway with Also import texts whose source changed since the export), not translated, formatting changed, not in the file.
  • Safe: files over 10 MB, files from another system and translations that add markup the source doesn't have are refused; uploaded files aren't stored.

Details: user guide.

Guides

  • Installation guide — requirements, install, API key, languages, all settings, troubleshooting
  • User guide — translating and reviewing in the admin panel
  • Developer guide — architecture, Supertext API protocol, tests, releasing, roadmap

Part of Supertext's translation plugins for open source CMSs. See also the WordPress plugin and the Drupal module.

Changelog · MIT licensed

Supertext plugins for other systems

Supertext offers AI and professional translation plugins for these systems:

Content management systems (CMS)

System Plugin Type of integration What it does
Adobe Experience Manager supertext-aem-connector Translation connector: two AEM content packages for AEM's Translation Integration Framework. Sends AEM translation projects to Supertext and imports the results
ApostropheCMS Apostrophe-Supertext-Translation Apostrophe module (npm): a translation provider for Apostrophe's own Localize… step. Translates pages and pieces as editors localize them, widgets and rich text included
Contao Contao-Supertext-Translation Contao bundle (Composer) that adds a back-end action. Translate with Supertext in the site structure: pages or whole websites into other languages
Craft CMS CraftCms-Supertext-Translation Craft plugin (Composer) with a panel on the entry page. Translates entries into your other sites, Matrix and rich text included
Directus Directus-Supertext-Translation Directus extension bundle (npm): interface, endpoint, Flow operation and module. Translate with Supertext box on the item form, fills the Translations field
django CMS djangoCMS-Supertext-Translation Django app (Python package) that adds a toolbar entry. Translates pages and their plugins from the toolbar
Drupal tmgmt_supertext_ai Drupal module: a translator provider for the Translation Management Tool (TMGMT), by MD Systems. Translates TMGMT jobs with Supertext AI
Ghost Ghost-Supertext-Translation Separate connector service (Ghost has no admin plugins): works through internal tags, webhooks and the Admin API. Tag a post #translate-… and a translated draft appears
Grav Grav-Supertext-Translation Grav 2 plugin with an Admin2 panel. Supertext panel in the page editor, Markdown kept intact
HubSpot HubSpot-Supertext-Translation Hosted app connected to HubSpot with OAuth, working through HubSpot's multi-language content. Translates website and landing pages, blog posts, marketing emails and knowledge base articles into draft language versions
Joomla Joomla-Supertext-Translation Joomla system plugin (installable package). Translates articles into linked, unpublished language versions
Magnolia Magnolia-Supertext-Translation Magnolia module with a Translate with Supertext action in the Pages app. Translates pages, areas and components into the site's other languages
Neos Neos-Supertext-Translation Neos package (Composer) that hooks into the content repository, with a Supertext backend module for translation files. Translates automatically when an editor creates a page in another language
Orchard Core OrchardCore-Supertext-Translation Orchard Core module (.NET) with an admin page and a localization hook. Translates content items into other cultures, on demand or on localization
Payload CMS Payload-Supertext-Translation Payload plugin (npm) added to payload.config. Translate button for localized collections and globals
Silverstripe Silverstripe-Supertext-Translation Silverstripe module (Composer) on top of Fluent. Supertext tab translates pages and Elemental blocks into Fluent locales
Strapi Strapi-Supertext-Translation Strapi 5 plugin (npm) with a Content Manager panel. Translates entries into other locales from the Content Manager
TYPO3 Typo3-Supertext-Translation TYPO3 extension (Composer) that hooks into TYPO3's own localization, with a Supertext backend module for translation files. Translates pages and content elements as editors localize them
Umbraco Umbraco-Supertext-Translation Umbraco package (NuGet) with a backoffice extension. Translate with Supertext for pages, block lists and grids included
Wagtail Wagtail-Supertext-Translation Python package: a machine translator for wagtail-localize. Translates pages and snippets inside wagtail-localize's editor
WordPress (Polylang) supertext-wordpress-polylang WordPress plugin: a machine-translation service for Polylang Pro, plus professional translation orders. AI translation next to DeepL in Polylang, and human translation orders

Product information management (PIM)

System Plugin Type of integration What it does
Akeneo PIM Akeneo-Supertext-Translation Akeneo PIM bundle with a Translate with Supertext action on the product page. Translates products and product models into your other locales
AtroPIM AtroPIM-Supertext-Translation AtroCore module with a button on the product and a mass action in the list. Translates products and other AtroCore records into your other languages
Pimcore Pimcore-Supertext-Translation Pimcore bundle (Composer) with a Translate with Supertext button in Pimcore Studio. Translates documents into linked language versions and data objects' localized fields

E-commerce

System Plugin Type of integration What it does
Magento Magento-Supertext-Translation Magento 2 module (also Mage-OS) with a mass action in the admin lists and a button on the edit pages. Translates products, categories, CMS pages and blocks into your store views' languages
PrestaShop PrestaShop-Supertext-Translation PrestaShop module with a bulk action in the back-office lists. Translates products, categories and CMS pages into your shop's other languages
Shopify Shopify-Supertext-Translation Shopify app in the Shopify admin. Translates products, collections, pages and blog posts into all your shop's languages
Wix Wix-Supertext-Translation Wix app with a dashboard page (hosted service), working through Wix Multilingual. In development: translates Wix Stores products and other Wix Multilingual content into your site's languages

Email marketing

System Plugin Type of integration What it does
Mailchimp Mailchimp-Supertext-Translation Hosted app connected to Mailchimp with OAuth: Supertext folders in Mailchimp and a translate page. In development: turns a campaign into one draft per language, each sent to the subscribers with that language

Design files (XLIFF round trip)

Application Plugin Type of integration What it does
Adobe InDesign Adobe-InDesign-Translation InDesign scripts (ExtendScript). Exports all text to XLIFF 1.2 for any CAT tool and imports the translations with formatting intact
Adobe Illustrator Adobe-Illustrator-Translation Illustrator scripts (ExtendScript). Exports all text to XLIFF 1.2 for any CAT tool and imports the translations with formatting intact
CorelDRAW CorelDRAW-Supertext-Translation CorelDRAW VBA macro. Exports all text to XLIFF 1.2 for any CAT tool and imports the translations with formatting intact

About

Supertext AI translation for Payload CMS 3: a Translate button for localized collections and globals.

Topics

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages