help (item)

Defines a help message that can be used to support various external items in the form.

Separate help items can be created for every item supported, or one help item can be used to support several items.

Available options

active, itemnext, itemprevious, value

Example

This is an example of a button item that links to a help item using the help option:

   <button sid="fullPicture_button">
      <value>View Full-Sized Picture</value>
      <help>button_help</help>
      <fontinfo>
         <fontname>Times</fontname>
         <size>14</size>
         <effect>plain</effect>
      </fontinfo>
      <type>link</type>
      <url>http://www.ibm.server.com/application/fullPic.frm</url>
   </button>

The following example shows the help item referred to in the button item definition. The contents of the value option are presented as the help message when the user asks for help with the button.

   <help sid="button_help">
      <value>
         Pressing this button will bring a full-sized image in a form
         down to your viewer.
      </value>
   </help>

Usage details

  1. Form authors are encouraged to use xforms:hint rather than this item.
  2. The help item's value option contains the help message text.
  3. The link between the help item and the supported item is created by the help option in the supported item's definition. The help option contains the help item's item reference.