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 brief usage 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 - 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.
All three tabs require changes.
General suggestion valid for all three tabs is to add a link to official documentation, where users can find detailed information on using fields. The link could be by the line "Showcase apps......." (Same link for ALL tabs; it appears above tabs.)
Form fields tab changes
Suggest making a few alterations to the Showcase App: Form fields tab:
- Increase real estate for the fields (i.e make the grey area bigger - stretch it to the left and right).
- Left align all fields in each column.
- Add three columns:
- Field name
- Appearance
- Function (or Description)
- Consider adding visible lines as column indicators (i.e grey vertical lines)
- Add a short usage 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......."
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 tab changes
Suggest making a few alterations to the Showcase App: Vaadin fields tab:
- Increase real estate for the fields (i.e make the grey area bigger - stretch it to the left and right).
- Add three columns:
- Field name
- Appearance - show the field
- Function (or Description) - description
- Left align everything in each column.
- For the Field names:
- Use sentence case for headings (First word capitalized only.) At present there we 'Magnolia icons' but 'Progress Indicator'. 'Progress indicator' is good.
- Perhaps BOLD the highest level of heading (the category - for example Magnolia icons) not secondary headings.
- Label each item, field individuallly, either as independent things or as members of a category.
- Name each field individually and separately. Currently there is 'Magnolia table and tree table'. This should be:
- Magnolia table
- Tree table
- Consider adding visible lines (grey) as column indicators.
- Add a short description per field (see 6c,. 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.)
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 |