Showcase App alterations
There is a requirement to add information about the fields etc. that are available in the showcase app:
- The information should be succinct, descriptive but not contain any coding information or any detail beyond a description for each item.
- For further information the user needs to look to official documentation. For this reason there needs to be a link to official documentation from within Magnolia CMS 5.
Currently there are three tabs in the showcase app:
- Form fields - Magnolia specific fields.
- Vaadin fields - Vaadin fields that can be used with Magnolia
- Unsupported fields by Maganolia - Not clear why we specify what Vaadin fields NOT to use. Suggest adding information on what is wrong with each field (i.e. - why it should not be used). That or simply removing this tab.
After discussions with Andreas and Philip, I would suggest making a few alterations to the Showcase App tabs:
- Left align all fields
- Add headings:
- Field name
- Appearance
- Function (or Description)
- Consider adding visible columns for headings
- Add a short description per field. Say, max 140 characters. (Use this for... Can also be used for... etc.) Where, why, how. (Use on x pages to describe. Try not to use more than x times per page.)
- Add link to official documentation, where users can find detailed information on using fields. The link could be by the line "Showcase apps......."
Mockups
Form fields and descriptions
Field | Description |
---|---|
Static text | |
Commit button in a form | |
Reset button in a form | |
Link | |
Text field | |
Text area | |
Password fields | |
Checkbox | |
Radio button group | |
Checkbox group | |
Select | |
Date field |
Vaadin fields and descriptions
Field | Description |
---|---|
Static text | |
Commit button in a form | |
Reset button in a form | |
Link | |
Text field | |
Text area | |
Password fields | |
Checkbox | |
Radio button group | |
Checkbox group | |
Select | |
Date field |
Overview
Content Tools