Writing Help for fields

About this task

Field Help is optional, but it can help users fill out documents without assistance. A field label that appears next to the field describes the field's general purpose. Write field Help to tell users what to enter in an editable field or how to use the field. When a user selects a field that has Help, a one-line text prompt appears at the end of the window.

If you cannot fit all the information into a Help description or if the field isn't editable, but you want to explain its use, use pop-up text in the field label to place Help information directly on the form.You can also write a field hint, text that helps the user determine what to enter or select in the field. The text disappears when the user moves the cursor into the field.

Tips for writing Help for fields

About this task

Start the Help description with "Required:" if the user must fill in the field.

You can use 70 characters, including letters, numbers, spaces, and punctuation. If your application will be translated to another language, use no more than 55 characters to allow the translators a few extra characters.

To write field Help

Procedure

  1. Open the form in Domino® Designer.
  2. Double-click the field.
  3. In the Field Properties box, click the Advanced tab.
  4. Enter your help text in the Help Description setting.
  5. Save and close the form.

To write pop-up text for a field

Procedure

  1. Open the form or subform in Designer.
  2. Highlight the field label -- that is, static text that the user sees, not the rectangular field definition.
  3. Choose Create - Hotspot - Text Pop-up.
  4. In the Hotspot Properties box, write the pop-up text and click the green check mark.
  5. Save and close the form or subform.

To write a field hint

About this task

A field hint lets you enter descriptive text that initially helps the user know what to enter or select in the field. This text disappears when the user moves the cursor into the field.

Procedure

  1. Open the form in Designer.
  2. Double-click the field.
  3. Click the Advanced tab.
  4. In the Field Hint box, type the text you want to appear.

Examples

About this task

For a text field named Supervisor:

Enter the name of the person to whom you report.

For a keywords field that presents check boxes:

Select as many options as apply.

For a required Subject field:

Required: You must add a brief description.