[MGNLUI-6349] DOC: Update field converters Created: 23/Oct/20  Updated: 04/Nov/20  Resolved: 04/Nov/20

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

Type: Task Priority: Neutral
Reporter: Ashraf Khamis Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: converter, fields, new-UI-framework, new-form
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: UI framework: forms, dialogs, content editing
Sprint: UI FW 14
Story Points: 2

 Description   

According to Roman, the point of having field converters is "that you can open old dialogs in new apps, not use old fields in a new app descriptor". In light of this, have another close look at https://documentation.magnolia-cms.com/display/DOCS62/Field+converters and check if that's already clear or if there's anything at odds with that statement.

More information

Roman: "Looking at https://documentation.magnolia-cms.com/display/DOCS62/Field+converters#Fieldconverters-Examplefieldconverter, it explains the use in dialogs already. We might want to emphasize the statement about the app descriptor though."

Ashraf: "I think what's confusing is that they are called "field converters", but they are used at the dialog level. We also need to make clear that converters are used for opening old dialogs/fields in new apps."

Roman: "Dialogs consist of fields, so to convert a dialog, we have to covert all fields inside the dialog."

Ashraf: "Yes, but the name could be misleading. It's about compatibility at the dialog level, not the field level. And of course that trickles down to the field level since dialogs contain fields."

Roman: "If most users don't use it programmatically, then "dialog converters" could be a better title."
 
 



 Comments   
Comment by Ashraf Khamis [ 04/Nov/20 ]

Updated https://documentation.magnolia-cms.com/display/DOCS62/Field+converters with more information about the purpose of field converters and edited some parts for clarity.

Reviewed by Roman.

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