UI Element Nomenclature
‹product›-[-edition]-‹page|dialog›[-icon|-menu]-‹description›
where:
Only used when elements look different in different product editions (e.g., the JRS OLAP Settings page).
The name of the major dialog or process; this should be a single or compound word without dashes.
- Use -icon for icons and buttons.
- Use -menu for drop-down and context menus.
‹description› is the focus of the element, such as the tab name, wizard page name, or what is being illustrated.
- Use the same label (or tooltip) as found on the GUI object, but shorten it if too long.
- Use Caps and CamelCaps.
- Can contain sub-descriptions when necessary, separated by a dash.
- Use sub-descriptions where there are (or likely to be) other images with the same ‹description›. For example, we might refer to js-Login-SingleOrg-blank (where the product is js, the page is Login, the description is SingleOrg, and the sub-description is blank). It describes the Login page when mutli-tenancy isn't enabled and no user credentials entered. Description may not be useful across all Engineering groups.