[MGNLUI-6805] DOC: Rework misleading note about multi field and i18n Created: 28/Jul/21  Updated: 29/Sep/22  Resolved: 12/Aug/21

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

Type: Improvement Priority: Neutral
Reporter: Mikaël Geljić Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: fields, i18n, multifield
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
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: I18n fields issues
Sprint: UI FW 34
Story Points: 3

 Description   

The following note, added together with 6.2.9 / MGNLREST-286 is misleading:

When configuring the property for a multi field, make sure it is defined at the level of the field itself (not its child entries).

It has the following effect, which may or may not be what a customer wants:

Setting i18n to true on a MultiField means that you want to store a different set of entries per locale.

—via SUPPORT-13105

  1. To translate a unique set of entries: set i18n to false on the multi-field, and set i18n to true on the inner field.
  2. To translate different sets of entries, set i18n to true on the multi-field, and set i18n to false on the inner field. In this case, there is no fallback between languages.
  3. Setting i18n to true on both levels should be discouraged (no benefit afaict, enquired on the SUPPORT ticket tho).

Both options work equally with REST Delivery.

And since this has been source of confusion forever (including in UI 5), that probably deserves a separate section, showing the different JCR structures?



 Comments   
Comment by Ashraf Khamis [ 12/Aug/21 ]

Updated the i18n property with all possible configurations for multi fields: https://docs.magnolia-cms.com/product-docs/6.2/Templating/Dialog-definition/Field-definition.html#_common_complex_field_properties.

Reviewed by Mika & Adam.

Generated at Mon Feb 12 09:40:10 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.