Static Instruction Text Version 2.0.0.0Print this Page
Embedded Help Pattern Set
 
Description
Return to Top

Use static instruction text only on pages where the typical user may fail to perform a task unassisted. Apply static instruction text to explain the primary way to use a page, section, or subsection of the page. If a page, section, or subsection does not need help, do not add static instruction text simply to make that page, section, or subsection consistent with other pages, sections, or subsections.

You can use static instruction text with the user interface (UI) components listed 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

 
Other Design Considerations
Return to Top
  • Static instruction text is normally associated with a header at different levels on the page (figure 1).
  • Static instruction text should be brief and to the point, taking up no more than two lines or 400 characters in the space below the page, section, or subsection header. The text is always visible; it does not appear dynamically.
  • Do not confuse static instruction text with information messages. Information messages are created dynamically when the application, business object, or page changes, and they use an icon qualifier and heading of their own.

  • Do not use static instruction text to explain graphs. The UI should make appropriate use of elements such as legends, footnotes, annotations, and key notations.
 
Pattern Sample
Return to Top
Static Instruction Text on Subheader
Figure 1. Static instruction text on a subheader
Static Instruction Text on Tab Without Header
Figure 2. Static instruction text on a tab without a header

Required Screen Elements

Component Type

Required Components

Customizable or Extendable Components

Text

Visible text associated with a region or page header instructing the user on the primary way to use that page or region

NA

 
Related Documentation
Return to Top
Help Usage Guideline Describes ways that help appear in the Rich Client User Experience-based UI

Oracle Fusion Help UI Guideline

Guidance on which type of help to use in Oracle Fusion Applications

 
About Oracle | Legal Notices | Terms of Use | Your Privacy Rights