Get to know how to organize your headless content and how AEM’s translation tools work.
In the previous document of the AEM headless translation journey, Learn about headless content and how to translate in AEM you learned the basic theory of what a headless CMS is and you should now:
This article builds on those fundamentals so you understand how AEM stores and manages headless content and how you can use AEM’s translation tools to translate that content.
This document helps you understand how to get started translating headless content in AEM. After reading you should:
There are a number of requirements before you begin translating your headless AEM content.
If you are not familiar with using a large-scale CMS like AEM, consider reviewing the Basic Handling documentation before proceeding. The Basic Handling documentation is not part of the journey, so please return to this page when complete.
project-administratorsgroup in AEM
AEM’s content, be it headless or traditional web pages, is driven by its structure. AEM imposes few requirements on the content structure, but careful consideration of your content hierarchy as part of the project planning can make translation much simpler.
Plan for translation at the very beginning of the headless project. Work closely with the project manager and content architects early.
An Internationalization Project Manager may be required as a separate persona whose responsibility it is to define what content should be translated and what not, and what translated content may be modified by regional or local content producers.
For the translation specialist, it is not important to understand in-depth how AEM manages headless content. However being familiar with the basic concepts and terminology will be helpful as you later use AEM’s translation tools. Most importantly you need to understand your own content and how it is structured in order to effectively translate it.
In order for headless content to be delivered consistently across channels, regions, and languages, content must be highly structured. AEM uses Content Models to enforce this structure. Think of Content Models as a kind of template or pattern for creating headless content. Because every project has its own needs, every project defines its own Content Fragment Models. AEM has no fixed requirements or structure for such models.
The content architect works early in the project to define this structure. As the translation specialist, you should work closely with the content architect to understand and organize the content.
It is the responsibility of the content architect to define the Content Models. The translation specialist should only be familiar with their structure as outlined in the following steps.
Because the Content Models define the structure of your content, you need to know which fields of your models must be translated. Generally you work with the content architect to define this. To browse the fields of your content models, follow the steps below.
Take note of the field Property Name for all fields that must be translated. You will need this information later in the journey. These Property Names are required to inform AEM which fields of your content must be translated.
Generally the content architect provides the translation specialist with the Property Names of all of the fields required for translation. These field names are needed for later in the journey. The prior steps are provided for the understanding of the translation specialist.
Content Models are used by the content authors to create the actual headless content. Content authors select which model to base their content on an then create Content Fragments. Content Fragments are instances of the models and represent actual content to be delivered headlessly.
If the Content Models are the patterns for the content, the Content Fragments are the actual content based on those patterns. The Content Fragments represent the content that must be translated.
Content Fragments are managed as assets in AEM as part of digital asset management (DAM). This is important since they are all located under the path
As previously recommended, work with your content architect to determine the appropriate content structure for your own project. However the following is a proven, simple, and intuitive structure which is quite effective.
Define a base folder for your project under
The language in which your content is authored is called the language root. In our example it is English and it should be below this path.
All project content that may need to be localized should be placed under the language root.
Translations should be created as sibling folders alongside the language root with their folder name representing the ISO-2 language code of the language. For example, German would have the following path.
The content architect generally is responsible for creating these language folders. If they are not created, AEM will not be able to later create translation jobs.
The final structure may look something like the following.
/content |- dam |- your-project |- en |- some |- exciting |- headless |- content |- de |- fr |- it |- ... |- another-project |- ...
You should take note of the specific path of your content as it will be required later to configure your translation.
It is generally the responsibility of the content architect to define the content structure, but can collaborate with the translation specialist.
It is detailed here for completeness.
Now that you understand what Content Fragments are and the importance of content structure, we can look at how to translate this content. The translation tools in AEM are quite powerful, but are simple to understand at a high level.
You generally only set up your connector once for your instance and rules per headless project. Then you use translation projects to translate your content and keep its translations up to date on a continual basis.
Now that you have completed this part of the headless translation journey you should:
Build on this knowledge and continue your AEM headless translation journey by next reviewing the document Configure the translation connector where you will learn how to connect AEM to a translation service.|
While it is recommended that you move on to the next part of the headless translation journey by reviewing the document Configure the translation connector the following are some additional, optional resources that do a deeper dive on some concepts mentioned in this document, but they are not required to continue on the headless journey.