[MAGNOLIA-7391] System i18n: Template definition's 'title' should be i18n-ized comparable to 'labels' & 'description' of form-fields or apps. Created: 10/Oct/18  Updated: 06/Jun/23

Status: Open
Project: Magnolia
Component/s: i18n
Affects Version/s: 5.6.7, 5.7.1
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Christian Ringele Assignee: Unassigned
Resolution: Unresolved Votes: 1
Labels: headless-team-support
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Areas.png     PNG File Components1.png     PNG File Components2.png     PNG File Pages.png     PNG File Pages2.png    
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: AuthorX Support
Team: AuthorX

 Description   

The input came from Deutschebahn DB in my last training, they will need it in their project.

Our 'System i18n' implementation allows to translate everything seen by the author in admin central:

  • labels of Actions
  • labels & descriptions of form fields
  • etc

But there is one big missing piece:

The 'title' of a template definition (pages & components).

 

Here a screen overview of what is translate able (yellow) and what not (red):

  1. Page's browser app: looking at a website tree
  2. Page's browser app: creating a new page / choosing a page template
  3. Page's detail app: existing components on a page
  4. Page's detail app: adding a new components / choosing a component template
  5. Page's detail app: Area names on a page

Solution for pages & components

The same logic could be applied to the property 'title' of a template definition as its used for 'label' and 'description' in other places:
"If there is no title defined in a template definition, resolve the auto generated key in a message bundle file."

Solution for areas

This one is a bit harder as the default area definition does not have a title set usually -> suddenly everywhere a i18n key would appear on the area green bars.

Here I would reverse the logic:

  • if no 'title' defined then behave as now -> use the area name
  • if a title is defined one can add manually a i18n key which gets:
    • first resolved in a message bundle file and if not resolvable then used as static string


 Comments   
Comment by Mareike Schulz [ 15/Oct/18 ]

Hello @Christian Ringele,
thanks for opening a ticket for this missing i18n translation. This will be an important feature because at Deutsche Bahn we have a lot of editors that use different languages besides German.
We hope that this feature will be implemented soon.
Thanks and best regards,
Mareike Schulz

Comment by Robert Šiška [ 24/Nov/20 ]

The component and pages titles can now be i18nized.

The area title i18n keys are not prefixed with module name. See RenderableDefinitionKeyGenerator#keysFor().

Since each page template defines their own areas, consider incorporating page template name into the key too.

How it looks: templates.areas.areaName
How it should look: module-name.templates.areas.areaName or module-name.templates.pageName.areas.areaName

Generated at Mon Feb 12 04:23:21 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.