Terminology Definition Version 2.0.0.0Print this Page
Embedded Help Pattern Set
 
Description
Return to Top

Use a terminology definition to define the meaning of the prompt for the user interface (UI) component. Use this pattern only when a field label or table column heading needs further explanation. Use this pattern sparingly because numerous information icons on the interface can be distracting.

You can use terminology definitions with the UI components shown in the following table.

 
Pattern Set Decision Table
Return to Top
 

Static Instruction Text

In-field Help Note

Terminology Definition

Bubble Help

User Assistance Popup

Valid UI components that use this type of help
  • Page header
  • Subheader
  • Sub-subheader
  • Standalone check box
  • Multiselect check box group
  • Single-select choice list
  • Multiselect choice list
  • Single-select list box
  • Multiselect list box
  • Text box
  • Single-select radio groups
  • Items in true/false radio groups
  • Items in true/false check box groups
  • Color picker
  • Date/time picker
  • Flexfield
  • LOV
  • Spin box
  • Slider
  • File upload
  • Shuttle
  • Rich Text Editor
  • Check box prompt
  • Check box group prompt
  • Single-select choice list
  • Multiselect choice list
  • Single-select list box
  • Multiselect list box
  • Text box
  • Option group prompt
  • Color picker
  • Date/time picker
  • Flexfield
  • LOV
  • Column headers
  • Spin box
  • Slider
  • File upload
  • Shuttle
  • Rich Text Editor
  • Icon buttons
  • Button
  • Link
  • Tab
  • Page header
  • Subheader
  • Sub-subheader
  • Tab
  • Dashboard region
Does the user need help understanding the effects of entering a value or leaving the component blank?

N

Y

N

N

N

Does the user need a detailed description of what the UI component means or does?

N

N

Y

Y

N

Does the user need help understanding what to do on a page or within a header region?

Y

N

N

N

Y

Does the user require in-depth assistance or need to explore more information?

N

N

N

N

Y

How long is the help text, including spaces?

Less than or equal
to two lines
(of local area width) or 400 characters

Less than or equal to 160 characters

Less than or equal to 80 characters

Less than or equal to 80 characters

Less than or equal to 400 characters, including optional links to nonembedded help

 
Design Considerations
Return to Top
  • The icon button appears to the left of a component label (figure 1) before any required field symbol.
  • The icon button appears to the right of a column header in a table (figure 2).
  • To provide help using the appropriate help component, understand what type of check box or option button a developer is planning to use. See the Check Box Usage Guideline to understand the distinction between true/false check boxes and multiselect check boxes. See the Radio Group Usage Guideline to understand the distinction between true/false option groups and single-select option groups.
  • For check boxes and option buttons, use a terminology definition only for group prompts and not for option labels. Group prompts appear to the left of the check box or option button. Option labels appear to the right of the check box or option button.┬áDo not use terminology definitions for prompt values. For the value, you can use an in-field help note, depending on the type of check box or option button. When there is no prompt on these components, ensure that the value clearly indicates the function of the check box or option button.
 
Pattern Sample
Return to Top
Terminology Definition on a Required Field
Figure 1. Terminology definition on a required field
Terminology Definition on Table Column Header
Figure 2. Terminology definition on table column header
Required Screen Elements

Component Type

Required Components

Customizable or Extendable Components

Terminology Definition icon (Terminology Definition Icon) An 11 x 11 pixel icon indicates the presence of a terminology definition for a UI component. NA

Tooltip

Terminology definitions appear as tooltips when users move the cursor over the Terminology Definition icon for 400 ms.

Terminology definitions are dismissed when users move the cursor to other locations on the screen.

NA

 
Related Documentation
Return to Top
Help Usage Guideline Describes ways that help appear in the Rich Client User Experience-based UI
 
About Oracle | Legal Notices | Terms of Use | Your Privacy Rights