[MGNLUI-3764] I18n: I can reuse the keys between modules Created: 02/Feb/16  Updated: 03/May/16  Resolved: 16/Mar/16

Status: Closed
Project: Magnolia UI
Component/s: dialogs
Affects Version/s: None
Fix Version/s: 5.4.6

Type: Improvement Priority: Neutral
Reporter: Roman Kovařík Assignee: Roman Kovařík
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 1d 5.5h
Original Estimate: Not Specified

Issue Links:
dependency
depends upon MAGNOLIA-6535 I18n Key generators should be consistent Closed
is depended upon by MGNLRES-259 Use i18n best practices Closed
is depended upon by MTE-74 Use i18n "best practices" in MTK Closed
is depended upon by MTE-76 Make sure that i18n keys may be reuse... Closed
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)
Documentation update required:
Yes
Date of First Response:
Epic Link: Introduction of new i18n
Sprint: Kromeriz 35
Story Points: 3

 Description   

We decided to implement only minimal changes: https://wiki.magnolia-cms.com/display/DEV/Minimal+required+changes

We currently generate these keys for templates:
templates.components.componentName.title
moduleName:templates.components.componentName.title
But that's not the case for dialogs:
moduleName:components.componentName.label
It should be consistent with templates (also to force more 'logical' keys)

Open Questions:
There is disagreement on what the consistant keys should be.

  • Should the keys reflect the full "definition path", therefore being predictable - yet verbose?
  • Should some keys support skipping parts of the definition - ie specify an app and a field, but not a subapp or view?

Next:
A list of all current keys will be created, which stakeholders from PD & PM can evaluate. Then another meeting to hopefully nail down the key generators we want to support, what patterns they should follow, and which ones we may want to deprecate.
https://jira.magnolia-cms.com/browse/DEV-137



 Comments   
Comment by Christopher Zimmermann [ 18/Feb/16 ]

I think there should be key generators that allow for skipping a level of specification, in the interest of reducing duplication.
Details here: https://wiki.magnolia-cms.com/display/PDNOTES/Decide+on+key+generators+to+support

Comment by Christopher Zimmermann [ 24/Feb/16 ]

how does <dialogPath> work? could you provide a few examples? Is it the full path separated with dots?

Comment by Roman Kovařík [ 24/Feb/16 ]

Exactly, full path in JCR:

moduleName/templates/components/someFolder/componentName:
moduleName.templates.components.someFolder.componentName.label
Generated at Mon Feb 12 09:09:51 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.