Getting started
This guide covers how to include translation capabilities in your Brightspot build.
Dependencies
Include the following dependencies in your build configuration based on your needs:
Core translation (required)
The core translation dependency is required for all translation functionality:
Requirements
Requires Brightspot 5.0 or later.
- Maven
- Gradle
- Gradle (Kotlin DSL)
<dependency>
<groupId>com.brightspot.translation</groupId>
<artifactId>translation</artifactId>
<version>__HIDDEN__</version>
</dependency>
implementation 'com.brightspot.translation:translation:__HIDDEN__'
implementation("com.brightspot.translation:translation:__HIDDEN__")
Translation services (optional)
Include dependencies for the specific translation services you want to use:
| Artifact | Description |
|---|---|
com.brightspot.translation:aws | Amazon Translate integration |
com.brightspot.translation:google | Google Translate integration |
com.brightspot.translation:lingotek | Lingotek integration |
For example, to include Amazon Translate:
Requirements
Requires Brightspot 5.0 or later.
- Maven
- Gradle
- Gradle (Kotlin DSL)
<dependency>
<groupId>com.brightspot.translation</groupId>
<artifactId>aws</artifactId>
<version>__HIDDEN__</version>
</dependency>
implementation 'com.brightspot.translation:aws:__HIDDEN__'
implementation("com.brightspot.translation:aws:__HIDDEN__")
Legacy dependencies
Older versions of Brightspot use different dependency coordinates. If you're on an older version, use these dependencies instead:
| Artifact | Description |
|---|---|
com.psddev:translation | Core translation functionality |
com.psddev:translation-aws | Amazon Translate integration |
com.psddev:translation-google | Google Translate integration |
com.psddev:translation-lingotek | Lingotek integration |
For example, the core dependency:
- Maven
- Gradle
- Gradle (Kotlin DSL)
<dependency>
<groupId>com.psddev</groupId>
<artifactId>translation</artifactId>
<version>4.8.11</version>
</dependency>
implementation 'com.psddev:translation:4.8.11'
implementation("com.psddev:translation:4.8.11")
Replace the version with your project's Brightspot version.
What's included
Once you've added the dependencies, the following capabilities are available:
- Translation menu option in content edit pages for sending content to translation
- Translations tab on content for viewing translation history and status
- Site settings for configuring available locales and translation services
- Manual translation option for human-driven translation workflows
- Translation service integrations (if you included AWS, Google, or Lingotek dependencies)
Next steps
- Configure translation settings for your site
- Set up your chosen translation service integration (Amazon Translate, Google Translate, or Lingotek)
- Learn how to send content for translation