[MGNLUI-5383] DOC: Transforming field values - 6 UI Created: 19/Sep/19  Updated: 21/Nov/19  Resolved: 21/Nov/19

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: Martin Drápela
Resolution: Fixed Votes: 0
Labels: content-app, new-UI-framework
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
is causing MGNLUI-5520 DOC: Explain ItemProviderStrategy on ... Closed
relation
is related to MGNLUI-5333 DOC: Valid Transformer implementation... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.2
Sprint: UI Framework 10, UI Framework 11
Story Points: 3

 Description   

Create a new page for transforming field values in Magnolia 6 UI.

  1. Create a page titled Transforming field values - 6 UI as a child of Magnolia 6 UI documentation.
  2. Copy https://documentation.magnolia-cms.com/display/DOCS62/Transforming+field+values in its entirety to the new page.
  3. Rewrite/update the newly created page in DOCS62 to reflect the Magnolia 6 UI framework.

NOTE:

  • YAML definitions, lists of properties, and fully qualified class names are probably the items most affected with the recent changes.
  • For UI definitions, we do not include both YAML files and JCR node trees anymore. This practice was done away with starting from DOCS61. The YAML definition now suffices.
  • The most basic UI definition pages have three main sections: a brief description at the beginning, an example YAML definition and a list of properties.
  • The focus should always be on getting the content out. Screenshots, elaborate descriptions, etc. can wait for a later iteration when the time allows.

For inspiration, see:

https://documentation.magnolia-cms.com/display/DOCS62/Dialog+definition+-+6+UI

https://documentation.magnolia-cms.com/display/DOCS62/Form+definition+-+6+UI

https://documentation.magnolia-cms.com/display/DOCS62/Field+definition+-+6+UI

https://documentation.magnolia-cms.com/display/DOCS62/Link+field+-+6+UI



 Comments   
Comment by Martin Drápela [ 06/Nov/19 ]

For tech review:

  1. No new DOCS62/Transforming+field+values page created.
  2. Added an infobox at the top of https://documentation.magnolia-cms.com/display/DOCS62/Transforming+field+values.
  3. Created a new page: https://documentation.magnolia-cms.com/display/DOCS62/Magnolia+6+UI+ports+of+5+UI+field+transformer+classes, where more content needs to be added, probably as part of https://jira.magnolia-cms.com/browse/MGNLUI-5333. For that see especially https://jira.magnolia-cms.com/browse/DEV-1302.

 

Comment by Milan Divilek [ 21/Nov/19 ]

Please create new page describing ItemProviderStrategy.

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