[MGNLUI-5178] DOC: Form definition reference page Created: 06/May/19  Updated: 14/May/19  Resolved: 14/May/19

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

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

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: Foundation 10
Story Points: 2

 Description   

Create a reference documentation for the form definition of the Magnolia 6 UI. 
(The (old) Form definition of the Magnolia UI 5 can be used as inspiration.)

Page to update

https://documentation.magnolia-cms.com/display/DOCS61/Defining+forms

Possible content

  • Its fully qualified class name (fqcn) 
    => info.magnolia.ui.form.FormDefinition
  • Which other definition item are using the form definition ... or in other words: Where to use such forms?
    • Detail sub app of the M.-6 
    • Dialog defintion of the M.-6 
  • The list of the properties of the form definition
    • => This is the "main" content / the main purpose of this page. More details, see below ...
  • A YAML snippet of a form definition.
     no more JCR based definition data (as we have it in Magnolia 5 UI docs.
    Note the the app definition of the app contacts-v8 contains some form definitions.
  • A note that is a definition item of the (new) Magnolia 6 UI framework. 
    Maybe a link to the "old" ref. page.

Properties list

  • properties
    A list of items of the type info.magnolia.ui.field.EditorPropertyDefinition
  • fieldDefinitions
    A list of items of the type info.magnolia.ui.field.FieldDefinition
  • layout
    A subitem of the type info.magnolia.ui.framework.layout.LayoutDefinition
  • subFormDefinitions
    Returns a filtered subset of the properties list ... ask Roman Kovařík for more details 

 

Sources

  • Java source file of info.magnolia.ui.form.FormDefinition , see git or clone the ui-project and explore the classes with an IDE
  • Developers: Sasha, Mika, and many others. Check the "annotations" on the source files via IDE to see which developer was adding which property
  • The yaml file of the "reference app" contacts-v8 contains several form definitions. See git or clone the contacts-app repo

Open question(s)

  • How to name the page?
    Note that there is already a page named Form definition (with the M.5 UI version)


 Comments   
Comment by Ashraf Khamis [ 10/May/19 ]

Page created at https://documentation.magnolia-cms.com/display/DOCS61/Defining+forms. Fully reviewed by Roman.

Comment by Ashraf Khamis [ 14/May/19 ]

Reviewed again by Christoph. All comments integrated/addressed.

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