Home

Help, Hint

Posted August 29th, 2007 by Jim Sneeringer
|
Problem Summary: Additional information or an example is helpful. Approved: Brazos R1
Related Patterns:  ToolTip Help (for icon buttons), Popup Help (for help too large for a hint).  See "Use When." Coding: Use SmartControl.
Example:

Use When:
  1. Something could be a bit difficult to understand without further explanation or an example.
  2. There is room on the page for the information needed and it won't be too cluttered.  If not, consider Popup Help.
  3. Links or other functional HTML are not needed in the hint.  If they are needed, consider Popup Help.
  4. A hint is preferred if the information is important, because the customer is more likely to see it.
  5. Do not use a hint where it is not needed, e.g. to merely restate a field label or state the obvious.
Solution:  Use a hint, which is read-only text that follows the field, as shown above.
  1. Hints are displayed even when the field is read only, which could happen because of the state of the application or the permissions of the customer who is logged in.
  2. Hints should be brief.
    Rationale:  People prefer the fewest words that clearly convey the necessary information.
  3. Examples are preceded by Example:  or Ex: in italics.
  4. The font color of the hint is 50% gray, hex 808080.
Rationale: NA
Accessibility: See Accessibility
Internationalization: See Internationalization
Supporting Examples: None
Where Used: To be supplied

Items of Note: None

‹ Format Rulesup
login or register to post comments

Comment viewing options

Select your preferred way to display the comments and click "Save settings" to activate your changes.

More for use when

On January 22nd, 2008 Rob Wenger says:

The hint is really just read only, short text, that appears to the right of or below the data entry field.

It would not appear if the field was set to read only mode (I don't think), just data entry.

Pop-up help would also be used if there needed to be a link or some other functional html for example.

login or register to post comments

When is it shown?

On January 29th, 2008 Jim Sneeringer says:

As requested in the review meeting, I have spent a few minutes thinking about whether or not the hint should be displayed when the field is being shown read-only.

There will sometimes be situations where the hint is helpful in interpreting the value, even when the value cannot be changed. Perhaps more important, it's probably a bit better for customers to avoid unnecessary changes. For example, one person without edit rights may be discussing a page on the phone with someone who does have edit rights. It's easier if their pages are as similar as possible.

On the other hand, you can make a case for removing unnecessary information to reduce clutter.

In my judgement, it's better on balance to leave the hints all the time.

login or register to post comments