Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/orbinson/aem-dictionary-translator

Translate AEM dictionaries for i18n internationalisation
https://github.com/orbinson/aem-dictionary-translator

aem aemaacs dictionary i18n translator

Last synced: 10 days ago
JSON representation

Translate AEM dictionaries for i18n internationalisation

Host: GitHub
URL: https://github.com/orbinson/aem-dictionary-translator
Owner: orbinson
License: apache-2.0
Created: 2023-08-04T14:32:25.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-12-23T21:43:56.000Z (10 days ago)
Last Synced: 2024-12-23T22:27:15.357Z (10 days ago)
Topics: aem, aemaacs, dictionary, i18n, translator
Language: Java
Homepage:
Size: 1.72 MB
Stars: 10
Watchers: 3
Forks: 5
Open Issues: 7
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

[![Maven Central](https://img.shields.io/maven-central/v/be.orbinson.aem/aem-dictionary-translator)](https://search.maven.org/artifact/be.orbinson.aem/aem-dictionary-translator.all)
[![GitHub](https://img.shields.io/github/v/release/orbinson/aem-dictionary-translator)](https://github.com/orbinson/aem-dictionary-translator/releases)
[![Build and test for AEM 6.5](https://github.com/orbinson/aem-dictionary-translator/actions/workflows/build.yml/badge.svg)](https://github.com/orbinson/aem-dictionary-translator/actions/workflows/build.yml)
[![Build with AEM IDE](https://img.shields.io/badge/Built%20with-AEM%20IDE-orange)](https://plugins.jetbrains.com/plugin/9269-aem-ide)

# AEM Dictionary Translator

AEM TouchUI tool to translate dictionaries for i18n internationalisation in AEM as a Cloud Service. The AEM
Dictionary Translator is a replacement for the
ClassicUI [translator](http://localhost:4502/libs/cq/i18n/translator.html) which is not available on AEMaaCS.

The [AEM Dictionary Translator](http://localhost:4502/tools/translation/dictionaries.html) is available under `Tools` >
`Translation` > `Dictionary`.

![Dictionaries](docs/assets/dictionaries.png)

![Key](docs/assets/key.png)

## Installation

### Compatibility matrix

The minimal required AEM and AEM Dictionary Translator versions are:

| AEM Type | AEM version | AEM Dictionary Translator |
|----------|---------------------------------|----------------------|
| AEM 6.5 | `6.5.17` | `1.3.0` |
| AEMaaCS | `2023.1.10912.20230130T173736Z` | `1.0.0` |

The minimal required Java version is `11`.

### Package installation

To deploy the AEM Dictionary Translator as an embedded package you need to update your `pom.xml`

1. Add the `aem-dictionary-translator.all` to the `` section

```xml

be.orbinson.aem
aem-dictionary-translator.all

zip

```
2. Embed the package in with
the [filevault-package-maven-plugin](https://jackrabbit.apache.org/filevault-package-maven-plugin/) in
the `` section

```xml

be.orbinson.aem
aem-dictionary-translator.all
/apps/vendor-packages/content/install

```

3. Currently, AEMaaCS doesn't allow loading of i18n dictionaries outside `/apps`, `/libs`, `/content/forms/af` and
`/content/dam/formsanddocuments`.

To mitigate this, update the `org.apache.sling.i18n.impl.JcrResourceBundleProvider` OSGi config to allow dictionaries in
other folders, for example by using `/content/dictionaries` for all your editable dictionaries.

Example `org.apache.sling.i18n.impl.JcrResourceBundleProvider` OSGi config

```json
{
"included.paths": [
"/libs",
"/apps",
"/content/forms/af",
"/content/dam/formsanddocuments",
"/content/dictionaries"
]
}

```

## Development

If you want to contribute to the project make sure to check the contribution guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).

To build all the modules run in the project root directory the following command

```shell
mvn clean install
```

To build all the modules and deploy the `all` package to a local instance of AEM, run in the project root directory the
following command

```shell
mvn clean install -PautoInstallSinglePackage
```

This project follows the [AEM Archetype](https://github.com/adobe/aem-project-archetype) conventions so for further
guidelines consult the available documentation.

### UI Tests

The project contains a set of UI tests with basic coverage for the AEM Dictionary Translator UI.

To run the UI tests, first install the `it.content` module to your local AEM instance.
Do note that the `it.content` module is not part of the `all` package and that it always needs to be installed separately.

**Warning:** When installing the `it.content` module, some paths will be overwritten like `/apps/wcm/core/resources/languages` and `/etc/replication/agents.author`.

```shell
mvn clean install -pl it.content -PautoInstallPackage
```

Afterward run the UI tests with the following command

```shell
mvn clean test -pl ui.tests -DskipTests=false
```